GET/allowlist_identifiers

List all identifiers on the allow-list

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

3 parameters
paginatedbooleanoptional
Whether to paginate the results. If true, the results will be paginated. If false, the results will not be paginated.
limitintegeroptional
Applies a limit to the number of results returned. Can be used for paginating the results together with `offset`.
Default:10
offsetintegeroptional
Skip the first `offset` results when paginating. Needs to be an integer greater or equal to zero. To be used in conjunction with `limit`.
Default:0

3 status codes
200Success
objectstringoptional
String representing the object's type. Objects of the same type share the same value.
Allowed:allowlist_identifier
idstringoptional
invitation_idstringoptional
identifierstringoptional
An email address or a phone number.
identifier_typestringoptional
Allowed:email_addressphone_numberweb3_wallet
instance_idstringoptional
created_atintegeroptional
Unix timestamp of creation
updated_atintegeroptional
Unix timestamp of last update.
401Authentication invalid
errorsarray<object>required
metaobjectoptional
clerk_trace_idstringoptional
402Payment required
errorsarray<object>required
metaobjectoptional
clerk_trace_idstringoptional

Error handling

A 401 is returned: Authentication invalid. A 402 is returned: Payment required.