## List

`client.v1.auditLogs.list(AuditLogListParamsquery?, RequestOptionsoptions?): CursorPage<AuditLogListResponse>`

**get** `/v1/auditLogs`

Retrieves a range of audit logs. If no further audit logs are currently available, the data array will be empty. As new audit logs are created, subsequent requests using the same next_page value will be in the returned data array, ensuring a continuous and uninterrupted reading of audit logs.

### Parameters

- **query:** `AuditLogListParams`

  - **ending\_before:** `string`

    RFC 3339 timestamp (exclusive). Cannot be used with 'next_page'.

  - **limit:** `number`

    Max number of results that should be returned

  - **next\_page:** `string`

    Cursor that indicates where the next page of results should start.

  - **resource\_id:** `string`

    Optional parameter that can be used to filter which audit logs are returned. If you specify resource_id, you must also specify resource_type.

  - **resource\_type:** `string`

    Optional parameter that can be used to filter which audit logs are returned. If you specify resource_type, you must also specify resource_id.

  - **sort:** `"date_asc" | "date_desc"`

    Sort order by timestamp, e.g. date_asc or date_desc. Defaults to date_asc.

    - `"date_asc"`

    - `"date_desc"`

  - **starting\_on:** `string`

    RFC 3339 timestamp of the earliest audit log to return. Cannot be used with 'next_page'.

### Returns

- `AuditLogListResponse`
  - **id:** `string`

  - **request:** `Request`

    - **id:** `string`

    - **ip:** `string`

    - **user\_agent:** `string`

  - **timestamp:** `string`

  - **action:** `string`

  - **actor:** `Actor`

    - **id:** `string`

    - **name:** `string`

    - **email:** `string`

  - **description:** `string`

  - **resource\_id:** `string`

  - **resource\_type:** `string`

  - **status:** `"success" | "failure" | "pending"`

    - `"success"`

    - `"failure"`

    - `"pending"`

### Example

```node
import Metronome from '@metronome/sdk';

const client = new Metronome({
  bearerToken: 'My Bearer Token',
});

// Automatically fetches more pages as needed.
for await (const auditLogListResponse of client.v1.auditLogs.list()) {
  console.log(auditLogListResponse.id);
}
```