anon_email
API referenceRecipients

List recipients

GET
/recipients

Every recipient inbox owned by the caller. The response is a bare JSON array, empty when the account has none.

Authorization

CognitoUserPool
headerAuthorizationBearer <token>

Cognito user pool ID token. API Gateway validates the token (identity token: no OAuth scopes are configured on the authorizer) and forwards its claims; the sub claim is the tenant key.

Response Body

The caller's recipients.

application/json
  1. response
[index: integer]?
curl -X GET "https://example.com/recipients"
[  {    "recipient_id": "string",    "email": "user@example.com",    "name": "string",    "active": true,    "verified": true,    "pgp_public_key": "string",    "pgp_fingerprint": "string",    "pgp_expires_at": 0,    "require_encryption": true,    "datetime_created": 0,    "datetime_deleted": 0  }]