# Get report

Returns the report for the provided identifier in its current status. The response includes a report only if the API key has access to it. Poll this endpoint after creating a report to track processing.

Endpoint: POST /reports/get
Version: 2.0.0
Security: bearerAuth

## Security:

  - `bearerAuth` (unknown)
    http bearer SECRET

## Request fields (application/json):

  - `id` (string, required)
    Unique report identifier.
    Example: rprt_01K8F3ZQ8X9YBCDEFGHJKMNPQR

## Response 200:

  - `200` (unknown)
    OK

## Response 200 fields (application/json):

  - `id` (string, required)
    Unique report identifier.
    Example: rprt_01K8F3ZQ8X9YBCDEFGHJKMNPQR

  - `report_type` (string, required)
    Report type.
    Enum: "INVOICES", "SUBSCRIPTIONS", "TAX_TRANSACTIONAL", "INVOICE_PAYMENTS", "TAX_SUMMARY"

  - `status` (string, required)
    Current report status.
    Enum: "PROCESSING", "SUCCEEDED", "FAILED", "EXPIRED"

  - `created_at` (string, required)
    Date and time when the report was created.
    Example: 2024-01-01T00:00:00.000000Z

  - `updated_at` (string, required)
    Date and time when the report was last updated.
    Example: 2024-01-01T00:10:00.000000Z

  - `parameters` (object, required)
    Parameters the report was created with.
    Example: {"channel_ids":["chn_01JYWX6Z5A8P32B6NVH1G9876A"],"date_from":"2024-01-01T00:00:00.000000Z","date_to":"2024-02-01T00:00:00.000000Z"}

  - `parameters.channel_ids` (array)
    Channels the report is limited to. Absent when the report covers the entire account.
    Example: ["chn_01JYWX6Z5A8P32B6NVH1G9876A"]

  - `parameters.date_from` (string, required)
    Start date and time for the report data range.
    Example: 2024-01-01T00:00:00.000000Z

  - `parameters.date_to` (string, required)
    End date and time for the report data range.
    Example: 2024-02-01T00:00:00.000000Z

## Response 400:

  - `400` (unknown)
    Bad request

## Response 400 fields (application/json):

  - `code` (string, required)
    Code identifying the error type.
    Enum: "VALIDATION"

  - `message` (string, required)
    Message describing the error.
    Example: One or more fields failed validation due to constraints

  - `context` (object, required)
    Additional context about the validation error, including specific constraints.
    Example: {"constraints":{"email":{"type":"TYPE","message":"The 'email' field must be a valid email address"},"age":{"type":"MIN","message":"The 'age' field must be a number greater than or equal to 18"}}}

  - `context.constraints` (object, required)
    Failed constraints keyed by the field name.

## Response 401:

  - `401` (unknown)
    Unauthenticated

## Response 401 fields (application/json):

  - `code` (string, required)
    Code identifying the error type.
    Enum: "UNAUTHENTICATED"

  - `message` (string, required)
    Message describing the error.
    Example: Credentials are invalid or missing

## Response 403:

  - `403` (unknown)
    Unauthorized

## Response 403 fields (application/json):

  - `code` (string, required)
    Code identifying the error type.
    Enum: "PERMISSION_DENIED"

  - `message` (string, required)
    Message describing the error.
    Example: Permission denied

## Response 404:

  - `404` (unknown)
    Not found

## Response 404 fields (application/json):

  - `code` (string, required)
    Code identifying the error type.
    Enum: "NOT_FOUND"

  - `message` (string, required)
    Message describing the error. The entity varies by endpoint.
    Example: The requested resource could not be found

## Response 429:

  - `429` (unknown)
    Too many requests

## Response 429 fields (application/json):

  - `code` (string, required)
    Code identifying the error type.
    Enum: "RATE_LIMIT"

  - `message` (string, required)
    Message describing the error.
    Example: Rate limit exhausted

  - `context` (object)
    Additional context about the error.

  - `context.next_try_at` (string)
    Timestamp indicating when to retry the request.
    Example: 2024-12-31T23:59:59.000000Z

## Response 404 examples:

  - `notFound` (unknown)