Skip to main content
Docs

getRedirectUrlList()

Retrieves a list of all white-listed redirect URLs. Returns a PaginatedResourceResponseClerk Icon object with a data property that contains an array of RedirectUrlClerk Icon objects, and a totalCount property that indicates the total number of redirect URLs for the application.

function getRedirectUrlList(): () => Promise<PaginatedResourceResponse<RedirectUrl[]>>

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.redirectUrls.getRedirectUrlList()

Backend API (BAPI) endpoint

This method in the SDK is a wrapper around the BAPI endpoint GET/redirect_urls/{id}. See the BAPI reference for more information.

Feedback

What did you think of this content?
GitHubEdit on GitHub

Last updated on