Allow-list / Block-list

List all identifiers on the allow-list

Get a list of all identifiers allowed to sign up to an instance

get/allowlist_identifiers

Request

  • Base URL: https://api.clerk.com/v1
  • URL: https://api.clerk.com/v1/allowlist_identifiers
  • Auth: HTTP bearer

Query parameters

paginatedboolean

Whether to paginate the results. If true, the results will be paginated. If false, the results will not be paginated.

limitinteger

Applies a limit to the number of results returned. Can be used for paginating the results together with offset.

offsetinteger

Skip the first offset results when paginating. Needs to be an integer greater or equal to zero. To be used in conjunction with limit.

Response

Success

object'allowlist_identifier'

String representing the object's type. Objects of the same type share the same value.

idstring
invitation_idstring
identifierstring

An email address or a phone number.

identifier_type'email_address' | 'phone_number' | 'web3_wallet'
instance_idstring
created_atinteger

Unix timestamp of creation

updated_atinteger

Unix timestamp of last update.

Changes

No recorded changes to this operation across all 49 revisions of this API.