GET/api/admin/api-keys/{api_key_id}/recipientsAdmin

List an API key's audience recipient allowlist entries

Individual-recipient entries and mailing-list entries form ONE combined audience allowlist for the key (unless the key's allow_any_audience flag is set).

operationId listApiKeyRecipientsAdmin: API Keys

Authentication & permissionsAdmin

Platform administrators only

Accepted credentials: Access token (Bearer)Authorization: Bearer <JWT>
Access token (cookie)cookie "access_token_schemavaults-mail"
Who may call: Platform administrators only

Path parameters

Name	Type	Description
api_key_id*	string (uuid)	ID of the API key.

Responses

application/json

Property	Type	Description
success*	true
data*	string (email)[]

JSONExample

"success"true

"data"

"user@example.com"

Example request

bashcurl

curl -X GET 'https://mail.schemavaults.com/api/admin/api-keys/<api_key_id>/recipients' \
  -H 'Authorization: Bearer <access_token>'

Other methods on this path

POSTAdd a recipient to an API key's audience recipient allowlist
DELETERemove a recipient from an API key's audience recipient allowlist

SchemaVaults

API Reference

List an API key's audience recipient allowlist entries

Authentication & permissionsAdmin

Path parameters

Responses

Example request

Other methods on this path

SchemaVaults

API Reference

List an API key's audience recipient allowlist entries

Authentication & permissionsAdmin

Path parameters

Responses

Example request

Other methods on this path

Authentication & permissionsAdmin

Path parameters

Responses

200The key's audience recipient allowlist entries.

400The path parameters, query string, headers or body failed validation.

401No credential was presented, or the presented credential is invalid, expired or revoked.

403The caller is authenticated but is not a platform administrator.

500Failed to list the key's audience recipient allowlist entries.

Example request

Other methods on this path

Authentication & permissionsAdmin

Path parameters

Responses

200The key's audience recipient allowlist entries.

400The path parameters, query string, headers or body failed validation.

401No credential was presented, or the presented credential is invalid, expired or revoked.

403The caller is authenticated but is not a platform administrator.

500Failed to list the key's audience recipient allowlist entries.

Example request

Other methods on this path