`list()`

Retrieves a list of machines for your application. Returns a PaginatedResourceResponse object with a data property that contains an array of Machine objects, and a totalCount property that indicates the total number of machines for the application. Results are sorted by descending creation date by default.

function list(params: GetMachineListParams = {}): Promise<PaginatedResourceResponse<Machine[]>>

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 machines in a particular order. Prefix with a - to reverse the order. Prefix with a + to list in ascending order. Defaults to '+created_at'.
Name
query?
Type
string
Description
Filters machines with ID or name that match the given query.

Examples

Note

Importing clerkClient varies based on your framework. Refer to the Backend SDK overview for usage details, including guidance on how to access the userId and other properties.

Basic

const response = await clerkClient.machines.list()

Limit the number of results

Retrieves list of machines that is filtered by the number of results.

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

Skip results

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

const { data, totalCount } = await clerkClient.machines.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/machines. See the BAPI reference for more information.

Edit this page on GitHub

Last updated on Sep 16, 2025

list()