GET
/
reports
curl --request GET \
  --url https://api.{id}.gr4vy.app/reports \
  --header 'Authorization: Bearer <token>'
{
  "items": [
    {
      "type": "report",
      "id": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
      "merchant_account_id": "merchant-account-12345",
      "name": "Monthly Transaction Report",
      "creator_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
      "creator_display_name": "Jane Doe",
      "creator_type": "user",
      "created_at": "2024-05-30T12:34:56.000Z",
      "updated_at": "2024-05-30T13:00:00.000Z",
      "next_execution_at": "2024-06-01T00:00:00.000Z",
      "description": "Monthly transaction summary for May 2024.",
      "schedule": "daily",
      "schedule_enabled": true,
      "schedule_timezone": "UTC",
      "spec": {
        "model": "transactions",
        "params": {
          "fields": [
            "id",
            "status"
          ],
          "filters": {
            "status": [
              "succeeded"
            ]
          }
        }
      },
      "latest_execution": {
        "type": "report-execution",
        "id": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
        "created_at": "2024-05-30T12:34:56.000Z",
        "updated_at": "2024-05-30T13:00:00.000Z",
        "status": "completed",
        "context": {
          "reference_timestamp": "2024-05-30T12:34:56.000Z",
          "reference_timezone": "UTC"
        }
      }
    }
  ],
  "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

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

​
schedule
enum<string>[] | null

Filters the reports by the type of schedule at which they run.

Examples:
["daily", "monthly"]
​
schedule_enabled
boolean | null

Filters the reports by wether their schedule is enabled.

Examples:

true

​
name
string | null

Filters the reports by searching their name for (partial) matches.

Examples:

"My report"

Response

200
application/json

Successful Response

The response is of type object.