## List

`v1.audit_logs.list(**kwargs) -> 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

- **ending\_before:** `Time`

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

- **limit:** `Integer`

  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:** `Time`

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

### Returns

- `class AuditLogListResponse`

  - **id:** `String`

  - **request:** `{ id, ip, user_agent}`

    - **id:** `String`

    - **ip:** `String`

    - **user\_agent:** `String`

  - **timestamp:** `Time`

  - **action:** `String`

  - **actor:** `{ id, name, email}`

    - **id:** `String`

    - **name:** `String`

    - **email:** `String`

  - **description:** `String`

  - **resource\_id:** `String`

  - **resource\_type:** `String`

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

    - `:success`

    - `:failure`

    - `:pending`

### Example

```ruby
require "metronome_sdk"

metronome = MetronomeSDK::Client.new(bearer_token: "My Bearer Token")

page = metronome.v1.audit_logs.list

puts(page)
```