getRedirectUrlList()
Retrieves a list of white-listed redirect URLs.
function getRedirectUrlList(): () => Promise<PaginatedResourceResponse<RedirectUrl[]>>;
getRedirectUrlList()
example
In this example, you can see that the returned PaginatedResourceResponse
includes data
, which is an array of RedirectUrl
objects, and totalCount
, which indicates the total number of redirect URLs in the system.
const response = await clerkClient.redirectUrls.getRedirectUrlList(); console.log(response); /* { data: [ _RedirectUrl { id: 'ru_2bxLHVfYsA13r8iKHWoY8SAr9az', url: 'https://example.com', createdAt: 1707151695693, updatedAt: 1707151695693 } ], totalCount: 1 } */
Backend API (BAPI) endpoint
This method in the SDK is a wrapper around the BAPI endpoint GET/redirect_urls/{id}
. See the BAPI reference(opens in a new tab) for more details.