`list()`

Retrieves a list of OAuth applications for an instance. Returns a object with a data property that contains an array of objects, and a totalCount property that indicates the total number of OAuth applications for the instance.

function list(params: ClerkPaginationRequest = {}): Promise<PaginatedResourceResponse<OAuthApplication[]>>

Parameters

Name
limit?
Type
number
Description
The number of results to return. Must be an integer greater than zero and less than 501. Can be used for paginating the results together with offset. Defaults to 10.
Name
offset?
Type
number
Description
Skip the first offset results when paginating. Needs to be an integer greater or equal to zero. To be used in conjunction with limit. Defaults to 0.
Name
orderBy?
Type
'name' | 'created_at'
Description
Return OAuth applications in a particular order. Prefix with a - to reverse the order. Prefix with a + to list in ascending order. Defaults to '+created_at'.
Name
nameQuery?
Type
string
Description
Filters OAuth applications with names that match the given query, via case-insensitive partial match.

Examples

Note

Importing clerkClient varies based on your framework. Refer to the for usage details, including guidance on .

Basic

const response = await clerkClient.oauthApplications.list();

Limit the number of results

Retrieves list of OAuth applications that is filtered by the number of results.

const { data, totalCount } = await clerkClient.oauthApplications.list({
  // returns the first 10 results
  limit: 10,
})

Skip results

Retrieves list of OAuth applications that is filtered by the number of results to skip.

const { data, totalCount } = await clerkClient.oauthApplications.list({
  // skips the first 10 results
  offset: 10,
})

Backend API (BAPI) endpoint

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

Edit this page on GitHub

Last updated on Jul 24, 2025

list()