āāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāā ā š shadcn/directory/clerk/clerk-docs/reference/backend/machines/list ā āāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāā
āāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāā
ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā
list()'
description: Use Clerk's Backend SDK to get a list of machines for your application.
sdk: js-backendRetrieves 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[]>>
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.
offset?numberSkip 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.
orderBy?'name' | 'created_at'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'.
query?stringFilters machines with ID or name that match the given query. </Properties>
const response = await clerkClient.machines.list()
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,
})
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,
})
This method in the SDK is a wrapper around the BAPI endpoint GET/machines. See the BAPI reference{{ target: '_blank' }} for more information.
ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā
āāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāā