Skip to main content
Docs

getAllowlistIdentifierList()

Retrieves the list of all allowlist identifiers. Returns a PaginatedResourceResponseClerk Icon object with a data property that contains an array of AllowlistIdentifierClerk Icon objects, and a totalCount property that indicates the total number of allowlist identifiers in the system.

function getAllowlistIdentifierList(): Promise<PaginatedResourceResponse<AllowlistIdentifier[]>>

Example

Note

Importing clerkClient varies based on your framework. Refer to the Backend SDK overviewClerk Icon for usage details, including guidance on how to access the userId and other propertiesClerk Icon.

const response = await clerkClient.allowlistIdentifiers.getAllowlistIdentifierList()

Backend API (BAPI) endpoint

This method in the SDK is a wrapper around the BAPI endpoint GET/allowlist-identifiers. See the BAPI reference for more information.

Feedback

What did you think of this content?
GitHubEdit on GitHub

Last updated on