# list()

Retrieves a list of machines for your application. Returns a [`PaginatedResourceResponse`](https://clerk.com/docs/reference/backend/types/paginated-resource-response.md) 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.

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

## Parameters

| Name     | Type                    | Description                                                                                                                                                           |
| -------- | ----------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| limit?   | number                  | 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?  | number                  | 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.                  |
| 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?   | string                  | Filters machines with ID or name that match the given query.                                                                                                          |

## Examples

> Using `clerkClient` varies based on the SDK you're using. Refer to the [overview](https://clerk.com/docs/reference/backend/overview.md) for usage details, including guidance on [how to access the `userId` and other properties](https://clerk.com/docs/reference/backend/overview.md#example-get-the-user-id-and-other-properties).

### Basic

```tsx
const response = await clerkClient.machines.list()
```

### Limit the number of results

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

```tsx
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.

```tsx
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](https://clerk.com/docs/reference/backend-api/tag/machines/GET/machines){{ target: '_blank' }} for more information.

---

## Sitemap

[Overview of all docs pages](https://clerk.com/docs/llms.txt)