GET
/
v1
/
reports
/
{id}
Retrieve a Report
curl --request GET \
  --url https://smart-templates.sandbox.midaz.io/v1/reports/{id}
{
  "id": "0196b268-620d-7d09-afa3-85e4d5369eg3",
  "templateId": "0196b264-24d4-7e0b-ad5c-9028cc05138d",
  "filters": null,
  "status": "processing",
  "completedAt": "2025-05-09T00:18:27.507Z",
  "createdAt": "2025-05-09T00:18:27.469Z",
  "updatedAt": "2025-05-09T00:18:27.469Z",
  "deletedAt": null
}

Headers

​
Authorization
string

The authorization token. Important: This header is required if your environment has the Acces Manager plugin enabled.

​
X-Organization-id
string

The unique identifier of the Organization associated with the request.

Path Parameters

​
id
string
required

Unique identifier for the report that you want to check.

Response

Indicates that the resource was successfully created and the operation was completed as expected.

Information about the report. Details of reports that are processing or finished.

​
id
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.

​
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.

​
updateAt
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'.