GET
/
audit-logs
curl --request GET \
  --url https://api.{id}.gr4vy.app/audit-logs \
  --header 'Authorization: Bearer <token>'
{
  "items": [
    {
      "type": "audit-log",
      "id": "8d3fe99b-1422-42e6-bbb3-932d95ae5f79",
      "merchant_account_id": "default",
      "resource": {
        "type": "user",
        "id": "d0f98bc9-8915-413c-a1de-d853eb658c1b",
        "name": "Jane Zoe"
      },
      "action": "created",
      "user": {
        "type": "user",
        "id": "14b7b8c5-a6ba-4fb6-bbab-52d43c7f37ef",
        "name": "John Doe",
        "email_address": "john@example.com",
        "is_staff": false,
        "status": "active"
      },
      "timestamp": "2022-01-01T00:00:00+00:00"
    }
  ],
  "limit": 20,
  "next_cursor": "ZXhhbXBsZTE",
  "previous_cursor": "Xkjss7asS"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
x-gr4vy-merchant-account-id
string | null

The ID of the merchant account to use for this request.

Examples:

"default"

Query Parameters

​
cursor
string | null

A pointer to the page of results to return.

Examples:

"ZXhhbXBsZTE"

​
limit
integer
default:20

The maximum number of items that are at returned.

Required range: 1 <= x <= 100
Examples:

20

​
action
enum<string> | null

Filters the results to only the items for which the audit-log has an action that matches this value.

Available options:
created,
updated,
deleted,
voided,
captured
Examples:

"created"

​
user_id
string | null

Filters the results to only the items for which the user has an id that matches this value.

Examples:

"14b7b8c5-a6ba-4fb6-bbab-52d43c7f37ef"

​
resource_type
string | null

Filters the results to only the items for which the audit-log has a resource that matches this type value.

Examples:

"user"

Response

200
application/json
Successful Response

The response is of type object.