Retrieve a Report

Headers

Authorization

string

The authorization token in the 'Bearer ' format.
Important: This header is required if your environment has Access Manager enabled. For more information, refer to the Access Manager documentation.

X-Organization-id

string

required

The unique identifier of the Organization associated with the request.

Path Parameters

string

required

Unique identifier for the report that you want to check.

Response

The details of the report.

Option 1
Option 2

Information about the report.

string

Unique identifier of the report.

templateId

string

Unique identifier of the template used to generate the report.

filters

object

Object that defines the filtering criteria applied to the data used in the report. Now supports advanced filtering operators including equality, comparison, range and list-based conditions.

Show child attributes

filters.{key}

object

Object where the key is the exact identifier of the data source to be filtered. Use the specific source ID configured in your organization — for example, use 'midaz_onboarding' for Onboarding data or 'plugin_crm' for CRM data, rather than generic labels like 'database_name'.
This identifier must match the name of a connected and accessible data source within your environment.
Important: This object is optional, but if provided, it must contain all necessary nested structures (table, field and conditionals) to ensure valid filtering. Partial or incomplete filter definitions will result in an error."

Show child attributes

filters.{key}.{key}

object

Mandatory object where the key is the exact table name to be filtered within the selected data source. Use the precise name as defined in the database schema — for example, 'organization', 'account', 'transaction', or 'fee', rather than a generic placeholder like 'table_name'. This name must exactly match a table registered in the selected data source.

Show child attributes

filters.{key}.{key}.{key}

object

Mandatory object whose key corresponds to the exact column name where the filtering conditions are applied. Use the field name exactly as defined in the table schema — e.g., 'accountId', 'status', 'createdAt', or 'amount' — rather than a generic placeholder like 'field_name'. This key must match the column name precisely to ensure proper query resolution.

Show child attributes

filters.{key}.{key}.{key}.{key}

string[]

A mandatory array that specifies which logical operator(s) should be applied to the selected field. These operators enable advanced filtering and support both simple and compound expressions. Supported operators: eq: Equal to; gt: Greater than; gte: Greater than or equal to; lt: Less than; lte: Less than or equal to; between: Value falls within a range; in: Value is within a list; nin: Value is not within a list.

Example:

{
  "id": { "eq": ["abc-123"] },
  "createdAt": { "between": ["2024-01-01", "2024-12-31"] }
}

Example:

{
  "account": {
    "id": { "eq": ["abc-123"] },
    "createdAt": { "between": ["2024-01-01", "2024-12-31"] }
  }
}

Example:

{
  "midaz_onboarding": {
    "account": {
      "created_at": { "between": ["2025-08-02", "2025-08-03"] }
    }
  }
}

status

enum<string>

The status of the report.

Available options:

Processing,

Finished

createdAt

string

Timestamp marking when this report request was created.

completedAt

string

Timestamp marking when the report processing was completed.

updatedAt

string

Timestamp marking the last update to this report request.

deletedAt

string

Timestamp marking when this report request was soft deleted, if applicable.

metadata

object

An object containing key-value pairs to add as metadata, where the field name is the key and the field value is the value. For example, to add a Cost Center, use 'costCenter': 'BR_11101997'.

Show child attributes

metadata.{key}

string

Templates API

Reports API

Database Mapping API

Error handling

Retrieve a Report

Headers

Path Parameters

Response