> ## Documentation Index
> Fetch the complete documentation index at: https://docs.nxos.io/llms.txt
> Use this file to discover all available pages before exploring further.

# List reports

> List your organization's reports, newest first: the ones requested through
the API, on the dashboard, and the monthly statements. Cursor-paginated.

Supports `Nxos-On-Behalf-Of` to list a client's reports. Any letter of
authorization the client has not revoked is enough.



## OpenAPI

````yaml GET /v1/reports
openapi: 3.0.0
info:
  title: nxos API
  version: 1.0.0
  contact:
    name: nxos
    url: https://nxos.io
  description: |-
    The nxos platform API provides programmatic access to accounts, balances,
    quotes, and trades. All endpoints require API key authentication.
servers:
  - url: https://api.nxos.io
    description: Production
    variables: {}
  - url: https://api.sandbox.nxos.io
    description: Sandbox
    variables: {}
security: []
tags:
  - name: Accounts
  - name: Quotes
  - name: Beneficiaries
  - name: Fiat Payouts
  - name: Crypto Payouts
  - name: Sandbox Faucet
  - name: Nxosnet
  - name: Fees
  - name: Sub-Org Tiers
  - name: Assets
  - name: Funding Methods
  - name: Transactions
  - name: Organizations
  - name: Authorizations
  - name: Referral invites
  - name: Referral links
  - name: Reports
  - name: Webhooks
    description: >-
      Register an HTTPS endpoint to receive events (organization verification,

      transaction status changes, and finished reports) instead of polling.
      Deliveries are signed; verify

      the `svix-signature` header before acting on an event.


      See the [Webhooks guide](https://docs.nxos.io/core-concepts/webhooks) for
      the

      delivery format, signature verification, retries, and broker behavior.
      Payload

      shapes are documented in the `…Event` models below.
paths:
  /v1/reports:
    get:
      tags:
        - Reports
      description: >-
        List your organization's reports, newest first: the ones requested
        through

        the API, on the dashboard, and the monthly statements. Cursor-paginated.


        Supports `Nxos-On-Behalf-Of` to list a client's reports. Any letter of

        authorization the client has not revoked is enough.
      operationId: Reports_list
      parameters:
        - $ref: '#/components/parameters/ApiKeyAuth'
        - $ref: '#/components/parameters/PaginationQuery.limit'
        - $ref: '#/components/parameters/PaginationQuery.cursor'
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                type: object
                required:
                  - object
                  - data
                  - hasMore
                  - nextCursor
                properties:
                  object:
                    type: string
                    enum:
                      - list
                    description: Object type. Always `list` for paginated responses.
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Report'
                    description: Array of results.
                  hasMore:
                    type: boolean
                    description: Whether more results are available beyond this page.
                  nextCursor:
                    type: string
                    nullable: true
                    description: >-
                      Cursor to pass as `cursor` query parameter for the next
                      page. Null when there are no more results.
                description: Paginated list envelope. All list endpoints return this shape.
        '400':
          description: The server could not understand the request due to invalid syntax.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error400'
              examples:
                invalid_request:
                  summary: invalid_request
                  value:
                    error:
                      code: invalid_request
                      message: Invalid cursor.
                      requestId: req_a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4
        '401':
          description: Access is unauthorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: Access is forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
              examples:
                verification_required:
                  summary: verification_required
                  value:
                    error:
                      code: verification_required
                      message: Complete identity verification before using the API.
                      requestId: req_a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4
                acting_org_not_found:
                  summary: acting_org_not_found
                  value:
                    error:
                      code: acting_org_not_found
                      message: >-
                        Nxos-On-Behalf-Of points to an organization that does
                        not exist.
                      requestId: req_a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4
                authorization_required:
                  summary: authorization_required
                  value:
                    error:
                      code: authorization_required
                      message: No authorization for the requested organization.
                      requestId: req_a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4
        '429':
          description: Client error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error429'
        '500':
          description: Server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error500'
components:
  parameters:
    ApiKeyAuth:
      name: Authorization
      in: header
      required: true
      description: 'Bearer token. Format: `Bearer <api_key>`'
      schema:
        type: string
    PaginationQuery.limit:
      name: limit
      in: query
      required: false
      description: Maximum number of items to return. Defaults to 25, max 100.
      schema:
        type: integer
        format: int32
        default: 25
      explode: false
    PaginationQuery.cursor:
      name: cursor
      in: query
      required: false
      description: Cursor for the next page of results, returned in previous responses.
      schema:
        type: string
      explode: false
  schemas:
    Report:
      type: object
      required:
        - object
        - reportId
        - type
        - format
        - status
        - from
        - to
        - asOf
        - currency
        - fileName
        - sizeBytes
        - createdAt
        - readyAt
      properties:
        object:
          type: string
          enum:
            - report
          description: Object type. Always `report`.
        reportId:
          type: string
          description: Report identifier.
        type:
          allOf:
            - $ref: '#/components/schemas/ReportType'
          description: The kind of document.
        format:
          allOf:
            - $ref: '#/components/schemas/ReportFormat'
          description: File format.
        status:
          allOf:
            - $ref: '#/components/schemas/ReportStatus'
          description: Where the report stands. Download it once `READY`.
        from:
          type: string
          nullable: true
          description: >-
            First day covered (`YYYY-MM-DD`, UTC) for a statement; `null`
            otherwise.
        to:
          type: string
          nullable: true
          description: >-
            Last day covered, inclusive (`YYYY-MM-DD`, UTC) for a statement;
            `null` otherwise.
        asOf:
          type: string
          nullable: true
          description: >-
            The day whose closing balances a certificate states (`YYYY-MM-DD`,
            UTC); `null` for other reports.
        currency:
          type: string
          nullable: true
          description: >-
            The one currency covered, or `null` when the report covers every
            currency.
        fileName:
          type: string
          nullable: true
          description: File name, once `READY`.
        sizeBytes:
          type: integer
          format: int32
          nullable: true
          description: File size in bytes, once `READY`.
        createdAt:
          allOf:
            - $ref: '#/components/schemas/dateTimeString'
          description: When the report was requested.
        readyAt:
          type: string
          allOf:
            - $ref: '#/components/schemas/dateTimeString'
          nullable: true
          description: When the file became available. `null` until `READY`.
      description: >-
        A report of your organization: a statement, a balance certificate or a
        bank confirmation letter.
      example:
        object: report
        reportId: rpt_a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4
        type: ACCOUNT_STATEMENT
        format: PDF
        status: READY
        from: '2026-09-01'
        to: '2026-09-30'
        asOf: null
        currency: USD
        fileName: NXOS - Account statement - 2026-09 - Acme Ltd.pdf
        sizeBytes: 48211
        createdAt: '2026-10-01T09:12:44.000Z'
        readyAt: '2026-10-01T09:12:51.000Z'
    Error400:
      type: object
      required:
        - error
      properties:
        error:
          $ref: '#/components/schemas/ErrorBody'
      description: Standard error response returned by all endpoints on failure.
    Error401:
      type: object
      required:
        - error
      properties:
        error:
          $ref: '#/components/schemas/ErrorBody'
      description: Standard error response returned by all endpoints on failure.
      example:
        error:
          code: missing_api_key
          message: 'Missing or invalid Authorization header. Expected: Bearer <api_key>'
          requestId: req_a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4
    Error403:
      type: object
      required:
        - error
      properties:
        error:
          $ref: '#/components/schemas/ErrorBody'
      description: Standard error response returned by all endpoints on failure.
    Error429:
      type: object
      required:
        - error
      properties:
        error:
          $ref: '#/components/schemas/ErrorBody'
      description: Standard error response returned by all endpoints on failure.
      example:
        error:
          code: rate_limited
          message: 'Rate limit exceeded: 1000 requests per minute. Retry in 23 seconds.'
          requestId: req_a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4
    Error500:
      type: object
      required:
        - error
      properties:
        error:
          $ref: '#/components/schemas/ErrorBody'
      description: Standard error response returned by all endpoints on failure.
      example:
        error:
          code: internal_error
          message: An unexpected error occurred.
          requestId: req_a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4
    ReportType:
      type: string
      enum:
        - ACCOUNT_STATEMENT
        - TRANSACTION_STATEMENT
        - BALANCE_CERTIFICATE
        - BANK_CONFIRMATION_LETTER
      description: The kind of document a report is.
    ReportFormat:
      type: string
      enum:
        - PDF
        - CSV
      description: File format of a report.
    ReportStatus:
      type: string
      enum:
        - PENDING
        - PROCESSING
        - READY
        - FAILED
      description: |-
        Where a report stands.

        - `PENDING` / `PROCESSING` — being generated, usually within seconds.
        - `READY` — the file can be downloaded.
        - `FAILED` — the report could not be generated. Request it again.
    dateTimeString:
      type: string
      description: ISO 8601 timestamp string.
    ErrorBody:
      type: object
      required:
        - code
        - message
        - requestId
      properties:
        code:
          allOf:
            - $ref: '#/components/schemas/ErrorCode'
          description: Machine-readable error code.
        message:
          type: string
          description: Human-readable error message.
        requestId:
          type: string
          description: Unique identifier for this request, useful for debugging.
    ErrorCode:
      type: string
      enum:
        - missing_api_key
        - authentication_failed
        - invalid_api_key
        - forbidden
        - acting_org_not_found
        - authorization_required
        - swap_direction_not_allowed
        - sub_org_tier_not_available
        - service_not_enabled
        - not_found
        - organization_not_found
        - account_not_found
        - quote_not_found
        - beneficiary_not_found
        - transaction_not_found
        - funding_method_not_found
        - authorization_not_found
        - nxosnet_handle_not_found
        - sub_org_tier_not_found
        - report_not_found
        - quote_expired
        - quote_already_used
        - beneficiary_already_archived
        - beneficiary_not_archived
        - beneficiary_blocked
        - transaction_blocked
        - transaction_not_held
        - fee_schedule_drifted
        - nxosnet_not_enabled
        - nxosnet_handle_taken
        - chain_send_failed
        - swift_copy_not_found
        - swift_copy_not_ready
        - bank_unavailable
        - idempotency_key_in_use
        - idempotency_request_in_flight
        - referral_invite_already_accepted
        - report_not_ready
        - too_many_pending_reports
        - invalid_request
        - insufficient_funds
        - trade_size_out_of_bounds
        - validation_error
        - invalid_document
        - too_many_documents
        - document_too_large
        - document_not_found
        - document_not_uploaded
        - share_token_invalid
        - verification_import_unsupported
        - verification_required
        - rate_limited
        - webhooks_unavailable
        - internal_error
      description: All possible error codes returned by the API.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.