Skip to Content
GET
/api/v1/identities/{identityId}/credentials

Returns every credential of a mailbox, revoked and expired ones included (secrets are never returned). Self-service: the mailbox's own bearer may read its own list.

Authorization

bearerAuth
headerAuthorizationBearer <token>

Two credential kinds share this scheme; GET /api/v1/auth/whoami answers which one you hold and what it reaches.

oek_… API key (minted by POST /api/v1/api-keys; shown once at mint). role: account reaches the full account surface: the directory (domains, routes, patterns, api-keys, accounts, address lists) plus every mailbox the account owns. role: system additionally reaches the operator surface, which is documented separately.

oemp_… mailbox app password (minted by POST /api/v1/identities/{identityId}/credentials). Reaches ONE mailbox: its messages, labels, threads, search, sync, send, filters and PIM collections. Directory routes refuse it with 403 insufficient_scope.

Refusal vocabulary: a missing, malformed, expired, or revoked credential answers 401 unauthorized with a WWW-Authenticate: Bearer challenge; a VALID credential outside its scope answers 403 (insufficient_scope for an app password on a directory route, system_credentials_required where only the operator may call). The public routes (health, branding, token-in-path capabilities) declare security: [].

Path Parameters

identityId*string

Mailbox identity ULID

Response Body

List of credentials

application/json
  1. response
credentials*array<>
Example Request
curl -X GET 'https://api.open.email/api/v1/identities/string/credentials'
Example Response
{
  "credentials": [
    {
      "createdAt": 0,
      "expiresAt": 0,
      "id": "string",
      "kind": "password",
      "lastUsedAt": 0,
      "name": "string",
      "permittedRecipients": [
        "string"
      ],
      "revokedAt": 0,
      "scope": "read",
      "username": "string"
    }
  ]
}