Skip to main content

list()

Gets the list of domains for the instance. By default, the list is returned in descending order by creation date (newest first).

Returns a PaginatedResourceResponse object with a data property containing an array of Domain objects and a totalCount property containing the total number of domains for the instance.

function list(): Promise<PaginatedResourceResponse<Domain[]>>

Usage

Note

Using clerkClient varies based on the SDK you're using. Refer to the overview for usage details, including guidance on how to access the userId and other properties.

const response = await clerkClient.domains.list()

Backend API (BAPI) endpoint

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

Feedback

What did you think of this content?

Last updated on

GitHubEdit on GitHub