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

# List contracts

> Returns a cursor-paginated list of contracts uploaded by your organization.



## OpenAPI

````yaml GET /v1/contracts
openapi: 3.1.0
info:
  title: Opereit Invoice Auditing API
  description: >-
    Public API for the Opereit Invoice Auditing product. Upload carrier
    contracts, run audits against incoming carrier invoices, and retrieve line
    items and findings.
  version: 1.0.0
servers:
  - url: https://api.opereit.com
    description: Production
security:
  - apiKey: []
paths:
  /v1/contracts:
    get:
      summary: List contracts
      description: >-
        Returns a cursor-paginated list of contracts uploaded by your
        organization.
      operationId: listContracts
      parameters:
        - $ref: '#/components/parameters/Limit'
        - $ref: '#/components/parameters/Cursor'
        - name: status
          in: query
          description: Filter by contract status.
          schema:
            type: string
            enum:
              - PROCESSING
              - ACTIVE
              - EXPIRED
              - FAILED
        - name: carrier_name
          in: query
          description: Filter by carrier name (case-insensitive exact match).
          schema:
            type: string
      responses:
        '200':
          description: Cursor-paginated list of contracts.
          content:
            application/json:
              schema:
                type: object
                required:
                  - data
                  - pagination
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Contract'
                  pagination:
                    $ref: '#/components/schemas/CursorPagination'
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  parameters:
    Limit:
      name: limit
      in: query
      description: Number of items to return per request.
      schema:
        type: integer
        minimum: 1
        maximum: 100
        default: 50
    Cursor:
      name: cursor
      in: query
      description: Opaque cursor from a previous response. Omit on the first request.
      schema:
        type: string
  schemas:
    Contract:
      type: object
      description: >-
        A carrier contract uploaded to Opereit. Rates and surcharges are
        extracted asynchronously.
      required:
        - id
        - carrier_name
        - signing_date
        - status
        - rate_count
        - surcharge_count
        - created_at
      properties:
        id:
          type: string
          description: Unique identifier for the contract.
        carrier_name:
          type: string
          description: Carrier the contract belongs to.
          example: DHL Express
        contract_number:
          type:
            - string
            - 'null'
          description: Carrier-issued contract number, if any.
        account_number:
          type:
            - string
            - 'null'
          description: Carrier account number this contract applies to, if any.
        signing_date:
          type: string
          format: date
          description: Date the contract was signed.
        effective_date:
          type:
            - string
            - 'null'
          format: date
          description: Date the contracted rates take effect, if specified.
        expiration_date:
          type:
            - string
            - 'null'
          format: date
          description: Date the contract expires, if specified.
        status:
          type: string
          enum:
            - PROCESSING
            - ACTIVE
            - EXPIRED
            - FAILED
          description: |-
            Contract lifecycle state.

            - `PROCESSING`: extraction in progress.
            - `ACTIVE`: extraction complete; rates and surcharges are available.
            - `EXPIRED`: contract expiration date has passed.
            - `FAILED`: extraction failed; see `status_reason`.
        status_reason:
          type:
            - string
            - 'null'
          description: Explanation when `status=FAILED`.
        file_url:
          type: string
          format: uri
          description: Time-limited URL to download the original contract file.
        rate_count:
          type: integer
          description: Number of rate-card entries extracted from the contract.
        surcharge_count:
          type: integer
          description: Number of surcharges extracted from the contract.
        created_at:
          type: string
          format: date-time
          description: When the contract was uploaded.
    CursorPagination:
      type: object
      required:
        - cursor
        - has_more
      properties:
        cursor:
          type:
            - string
            - 'null'
          description: >-
            Opaque cursor to use in the next request to fetch the next page.
            `null` if there are no more items.
        has_more:
          type: boolean
          description: Whether there are more items to fetch beyond the current page.
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: string
          description: Human-readable error message.
  responses:
    Unauthorized:
      description: Authentication is missing or invalid.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    apiKey:
      type: http
      scheme: basic
      description: >-
        HTTP Basic Auth using your API key. Send `Authorization: Basic
        base64(key_id:key_secret)`.

````