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

# List exports

> Lists the organization's exports, newest first, with each one's file, state, format, size and who started it. The search reads the file's name; the filter reads file, entity (any of the entities it holds), fields (its columns), filters (its conditions), format, state (active, succeeded, failed or canceled) and rows (none until its file is written).



## OpenAPI

````yaml /openapi/en.json get /api/v1/orgs/{orgId}/core/exports
openapi: 3.1.0
info:
  title: Ready for Commerce API
  version: 1.0.0
  description: >-
    The reference of every operation of the Ready for Commerce API. Every
    operation is in beta until launch.
servers:
  - url: https://app.readyforcommerce.com
security:
  - apiKey: []
tags:
  - name: Credentials
    description: >-
      The credential that calls: its organization, its permissions, its limits
      and the calls it may still make.
  - name: Organization
    description: 'The organization''s settings: its name, slug and currency.'
  - name: Billing
    description: >-
      The organization's subscription and each module's bill and cap, and this
      month's usage against its free allowance.
  - name: Record types
    description: >-
      The kinds of record the credential may import or export, with each one's
      fields and options.
  - name: Imports
    description: >-
      Bring CSV or Excel files in: upload or fetch a file, inspect and check it,
      then start the import and read its results.
  - name: Files
    description: An uploaded file's status, until it is ready or rejected.
  - name: Exports
    description: Export the records a filter matches to CSV or Excel files, kept 14 days.
  - name: Export templates
    description: Saved export setups, by name, to run the same export again.
  - name: Jobs
    description: >-
      Long work runs as a job: follow its state and progress, read its messages,
      download its files or cancel it.
  - name: Search
    description: >-
      Find the organization's records by words, a typo included, grouped by
      kind.
  - name: Version history
    description: >-
      A record's versions, newest first: compare one with another and restore
      the record to it.
  - name: Incidents
    description: >-
      The organization's problems you may see: mark them read or unread, and
      resolve them.
  - name: Notifications
    description: >-
      Your notifications, newest first: mark one read or unread, or all of them
      read.
  - name: Saved views
    description: >-
      A table's search, filters, order and columns saved under a name, yours or
      shared with the organization, and the view each table opens with for you.
  - name: Store connections
    description: >-
      The organization's stores, connected with their pasted keys: list them,
      connect one, reconnect it with new keys or disconnect it.
  - name: Products
    description: >-
      The organization's products with their options, variants and prices: list
      them, read one, create one, change one's content, its prices or its
      status, duplicate one as a draft, or delete one.
paths:
  /api/v1/orgs/{orgId}/core/exports:
    get:
      tags:
        - Exports
      summary: List exports
      description: >-
        Lists the organization's exports, newest first, with each one's file,
        state, format, size and who started it. The search reads the file's
        name; the filter reads file, entity (any of the entities it holds),
        fields (its columns), filters (its conditions), format, state (active,
        succeeded, failed or canceled) and rows (none until its file is
        written).
      operationId: coreListExports
      parameters:
        - schema:
            type: string
          in: query
          name: q
          required: false
        - schema:
            type: string
          in: query
          name: cursor
          required: false
        - schema:
            default: 200
            type: integer
            minimum: 1
            maximum: 200
          in: query
          name: limit
          required: false
        - schema:
            type: string
            enum:
              - 'true'
          in: query
          name: withTotal
          required: false
        - schema:
            type: string
            format: uuid
          in: path
          name: orgId
          required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExportPage'
        default:
          description: >-
            An error, as `application/problem+json`: its `code` says what went
            wrong and `params` holds its values
          content:
            application/problem+json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/Problem'
                  - properties:
                      code:
                        enum:
                          - core.bad_request
                          - core.invalid_credential
                          - core.forbidden
                          - core.module_not_enabled
                          - core.module_read_only
                          - core.not_found
                          - core.conflict
                          - core.org_deletion_scheduled
                          - core.payload_too_large
                          - core.unsupported_media_type
                          - core.validation_failed
                          - core.rate_limited
                          - core.surface_disabled
                          - core.internal
                          - core.unavailable
components:
  schemas:
    ExportPage:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/ExportItem'
        nextCursor:
          type:
            - string
            - 'null'
        total:
          type: integer
      required:
        - items
        - nextCursor
      additionalProperties: false
    Problem:
      type: object
      properties:
        type:
          type: string
          pattern: ^urn:rfc:problem:[\s\S]{0,}\.[\s\S]{0,}$
        status:
          type: integer
        title:
          type: string
        code:
          type: string
          pattern: ^[\s\S]{0,}\.[\s\S]{0,}$
        params:
          type: object
          propertyNames:
            type: string
          additionalProperties: {}
        requestId:
          type: string
        errors:
          type: array
          items:
            type: object
            properties:
              location:
                type: string
              pointer:
                type: string
              code:
                type: string
              params:
                type: object
                propertyNames:
                  type: string
                additionalProperties: {}
            required:
              - location
              - pointer
              - code
            additionalProperties: false
      required:
        - type
        - status
        - code
        - requestId
      additionalProperties: false
    ExportItem:
      oneOf:
        - type: object
          properties:
            id:
              type: string
              format: uuid
            waitingReason:
              anyOf:
                - type: string
                  enum:
                    - paused
                - type: 'null'
            progress:
              type: object
              properties:
                done:
                  type: integer
                total:
                  anyOf:
                    - type: integer
                    - type: 'null'
              required:
                - done
                - total
              additionalProperties: false
            apiKey:
              anyOf:
                - type: object
                  properties:
                    name:
                      type: string
                  required:
                    - name
                  additionalProperties: false
                - type: 'null'
            createdAt:
              type: string
              format: date-time
            finishedAt:
              anyOf:
                - type: string
                  format: date-time
                - type: 'null'
            canCancel:
              type: boolean
            file:
              type: object
              properties:
                name:
                  type:
                    - string
                    - 'null'
                expired:
                  type: boolean
              required:
                - name
                - expired
              additionalProperties: false
            permission:
              type: string
            module:
              type: string
              enum:
                - core
                - integrations
                - catalog
                - pricing
            createdBy:
              anyOf:
                - type: object
                  properties:
                    id:
                      type: string
                      format: uuid
                    name:
                      type:
                        - string
                        - 'null'
                  required:
                    - id
                    - name
                  additionalProperties: false
                - type: 'null'
            entities:
              type: array
              items:
                type: object
                properties:
                  entity:
                    type: string
                  format:
                    type: string
                    enum:
                      - csv
                      - xlsx
                  ceiling:
                    type: string
                    enum:
                      - rows
                      - cell
                  filter:
                    type: object
                    properties:
                      items:
                        maxItems: 100
                        type: array
                        items:
                          type: object
                          properties:
                            field:
                              type: string
                            op:
                              type: string
                            value: {}
                          required:
                            - field
                            - op
                          additionalProperties: false
                      logic:
                        type: string
                        enum:
                          - and
                          - or
                    required:
                      - items
                      - logic
                    additionalProperties: false
                required:
                  - entity
                  - format
                additionalProperties: false
            fields:
              type: integer
            filters:
              type: integer
            format:
              type: string
              enum:
                - csv
                - xlsx
            rows:
              anyOf:
                - type: integer
                - type: 'null'
            size:
              anyOf:
                - type: integer
                - type: 'null'
            state:
              type: string
              const: failed
            error:
              type: object
              properties:
                code:
                  type: string
                params:
                  type: object
                  propertyNames:
                    type: string
                  additionalProperties:
                    type:
                      - string
                      - number
              required:
                - code
                - params
              additionalProperties: false
          required:
            - id
            - waitingReason
            - progress
            - apiKey
            - createdAt
            - finishedAt
            - canCancel
            - file
            - permission
            - module
            - createdBy
            - entities
            - fields
            - filters
            - format
            - rows
            - size
            - state
            - error
          additionalProperties: false
        - type: object
          properties:
            id:
              type: string
              format: uuid
            waitingReason:
              anyOf:
                - type: string
                  enum:
                    - paused
                - type: 'null'
            progress:
              type: object
              properties:
                done:
                  type: integer
                total:
                  anyOf:
                    - type: integer
                    - type: 'null'
              required:
                - done
                - total
              additionalProperties: false
            apiKey:
              anyOf:
                - type: object
                  properties:
                    name:
                      type: string
                  required:
                    - name
                  additionalProperties: false
                - type: 'null'
            createdAt:
              type: string
              format: date-time
            finishedAt:
              anyOf:
                - type: string
                  format: date-time
                - type: 'null'
            canCancel:
              type: boolean
            file:
              type: object
              properties:
                name:
                  type:
                    - string
                    - 'null'
                expired:
                  type: boolean
              required:
                - name
                - expired
              additionalProperties: false
            permission:
              type: string
            module:
              type: string
              enum:
                - core
                - integrations
                - catalog
                - pricing
            createdBy:
              anyOf:
                - type: object
                  properties:
                    id:
                      type: string
                      format: uuid
                    name:
                      type:
                        - string
                        - 'null'
                  required:
                    - id
                    - name
                  additionalProperties: false
                - type: 'null'
            entities:
              type: array
              items:
                type: object
                properties:
                  entity:
                    type: string
                  format:
                    type: string
                    enum:
                      - csv
                      - xlsx
                  ceiling:
                    type: string
                    enum:
                      - rows
                      - cell
                  filter:
                    type: object
                    properties:
                      items:
                        maxItems: 100
                        type: array
                        items:
                          type: object
                          properties:
                            field:
                              type: string
                            op:
                              type: string
                            value: {}
                          required:
                            - field
                            - op
                          additionalProperties: false
                      logic:
                        type: string
                        enum:
                          - and
                          - or
                    required:
                      - items
                      - logic
                    additionalProperties: false
                required:
                  - entity
                  - format
                additionalProperties: false
            fields:
              type: integer
            filters:
              type: integer
            format:
              type: string
              enum:
                - csv
                - xlsx
            rows:
              anyOf:
                - type: integer
                - type: 'null'
            size:
              anyOf:
                - type: integer
                - type: 'null'
            state:
              type: string
              enum:
                - waiting
                - running
                - succeeded
                - canceled
            error:
              type: 'null'
          required:
            - id
            - waitingReason
            - progress
            - apiKey
            - createdAt
            - finishedAt
            - canCancel
            - file
            - permission
            - module
            - createdBy
            - entities
            - fields
            - filters
            - format
            - rows
            - size
            - state
            - error
          additionalProperties: false
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: >-
        An organization's API key, sent on every call as `Authorization: Bearer
        <key>`. A person of the organization creates it in the app, in
        **Settings › API and connections › API keys**.

````

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