getAllowlistIdentifierList()
Retrieves the list of all allowlist identifiers.
function getAllowlistIdentifierList(): Promise<PaginatedResourceResponse<AllowlistIdentifier[]>>
Example
In this example, you can see that the returned PaginatedResourceResponse
includes data
, which is an array of all AllowlistIdentifier
objects, and totalCount
, which indicates the total number of allowlist identifiers in the system.
const response = await clerkClient.allowlistIdentifiers.getAllowlistIdentifierList()
console.log(response)
/*
{
data: [
_AllowlistIdentifier {
id: 'alid_123',
identifier: 'test@example.com',
createdAt: 1705443883820,
updatedAt: 1705443883820,
invitationId: undefined
}
],
totalCount: 1
}
*/
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
Last updated on