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

# List contract records

> Returns the records attached to a contract for a given custom object.

A `relation` field stores the identifier of a record living in another custom object, so its `rawValue` and `resolvedValue` are both that identifier. The linked record and its readable field values are returned inline under `relatedRecords`, so no extra call is needed to display a label.



## OpenAPI

````yaml /openapi-2025-01-15.init.json get /custom-objects/{customObjectId}/contract/{contractId}/records
openapi: 3.0.0
info:
  title: Tomorro API
  description: >
    The Tomorro Public API enables you to programmatically manage contracts,
    members, and counterparties. Build powerful integrations that automate your
    contract management workflows.


    ## API Version: 2025-01-15.init


    This documentation is for API version `2025-01-15.init`.


    > **Warning:** This version is deprecated. This version is deprecated.
    Please upgrade to 2025-01-29.alpha.


    ### Using this version

    ```

    curl -X GET https://api.tomorro.com/members \
      -H "x-api-key: YOUR_API_KEY" \
      -H "tomorro-version: 2025-01-15.init"
    ```
  version: 2025-01-15.init
  contact: {}
servers:
  - url: https://api.tomorro.com/v2
    description: Production
  - url: https://api.demo.tomorro.com/v2
    description: Demo
  - url: http://localhost:3015
    description: Local Development
security: []
tags: []
paths:
  /custom-objects/{customObjectId}/contract/{contractId}/records:
    get:
      tags:
        - Custom Objects
      summary: List contract records
      description: >-
        Returns the records attached to a contract for a given custom object.


        A `relation` field stores the identifier of a record living in another
        custom object, so its `rawValue` and `resolvedValue` are both that
        identifier. The linked record and its readable field values are returned
        inline under `relatedRecords`, so no extra call is needed to display a
        label.
      operationId: CustomObjectController_listContractRecords
      parameters:
        - name: customObjectId
          required: true
          in: path
          description: The unique identifier (UUID) of the custom object
          schema:
            example: 550e8400-e29b-41d4-a716-446655440000
            type: string
        - name: contractId
          required: true
          in: path
          description: The unique identifier (UUID) of the contract
          schema:
            example: 550e8400-e29b-41d4-a716-446655440001
            type: string
      responses:
        '200':
          description: Contract records with their field values and linked catalog records
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContractRecordsListResponseDto'
        '401':
          description: Unauthorized - Invalid or missing API key
        '403':
          description: Forbidden - Insufficient permissions
        '429':
          description: Too Many Requests - Rate limit exceeded
      security:
        - X-API-KEY: []
components:
  schemas:
    ContractRecordsListResponseDto:
      type: object
      properties:
        customObjectId:
          type: string
          description: The unique identifier of the custom object.
          example: 550e8400-e29b-41d4-a716-446655440000
        contractId:
          type: string
          description: The unique identifier of the contract.
          example: 550e8400-e29b-41d4-a716-446655440005
        records:
          description: The records attached to this contract for this custom object.
          example:
            - id: 550e8400-e29b-41d4-a716-446655440001
              fromCatalogRecordId: null
              fields:
                - smartFieldId: 550e8400-e29b-41d4-a716-446655440002
                  type: relation
                  rawValue: 550e8400-e29b-41d4-a716-446655440003
                  resolvedValue: 550e8400-e29b-41d4-a716-446655440003
                  relatedRecords:
                    - id: 550e8400-e29b-41d4-a716-446655440003
                      fields:
                        - smartFieldId: 550e8400-e29b-41d4-a716-446655440004
                          type: string
                          rawValue: Alimentaire
                          resolvedValue: Alimentaire
          type: array
          items:
            $ref: '#/components/schemas/ContractRecordResponseDto'
      required:
        - customObjectId
        - contractId
        - records
    ContractRecordResponseDto:
      type: object
      properties:
        id:
          type: string
          description: The unique identifier of the record.
          example: 550e8400-e29b-41d4-a716-446655440001
        fromCatalogRecordId:
          type: string
          description: The catalog record this record was created from.
          format: uuid
          example: 550e8400-e29b-41d4-a716-446655440003
          nullable: true
        fields:
          description: The field values of this record.
          example:
            - smartFieldId: 550e8400-e29b-41d4-a716-446655440002
              type: relation
              rawValue: 550e8400-e29b-41d4-a716-446655440003
              resolvedValue: 550e8400-e29b-41d4-a716-446655440003
              relatedRecords:
                - id: 550e8400-e29b-41d4-a716-446655440003
                  fields:
                    - smartFieldId: 550e8400-e29b-41d4-a716-446655440004
                      type: string
                      rawValue: Alimentaire
                      resolvedValue: Alimentaire
          type: array
          items:
            $ref: '#/components/schemas/CustomObjectRecordFieldDto'
      required:
        - id
        - fields
    CustomObjectRecordFieldDto:
      type: object
      properties:
        smartFieldId:
          type: string
          description: The unique identifier of the smart field this value belongs to.
          example: 550e8400-e29b-41d4-a716-446655440002
        type:
          type: string
          description: The data type of the smart field.
          enum:
            - string
            - number
            - date
            - select
            - multiselect
            - relation
            - relation_multiple
          example: string
        rawValue:
          type: string
          description: >-
            The stored value of the field. For `relation` and
            `relation_multiple` fields this is the identifier of the linked
            catalog record, or several identifiers separated by `;`.
          example: Alimentaire
          nullable: true
        resolvedValue:
          type: string
          description: >-
            The human-readable value of the field.


            - `select` / `multiselect`: the option labels, separated by `;`.

            - `relation` / `relation_multiple`: **identical to `rawValue`** — a
            relation stores an identifier, not text. Read `relatedRecords` to
            get the textual details of the linked catalog record.

            - all other types: the stored value.
          example: Alimentaire
          nullable: true
        relatedRecords:
          description: >-
            The catalog records linked by this field, with their textual
            details. Only `relation` and `relation_multiple` fields can link
            records — the array is empty for every other type, and for a
            relation field holding no value.
          example:
            - id: 550e8400-e29b-41d4-a716-446655440003
              fields:
                - smartFieldId: 550e8400-e29b-41d4-a716-446655440004
                  type: string
                  rawValue: Alimentaire
                  resolvedValue: Alimentaire
          type: array
          items:
            $ref: '#/components/schemas/CustomObjectRelatedRecordDto'
      required:
        - smartFieldId
        - type
        - relatedRecords
    CustomObjectRelatedRecordDto:
      type: object
      properties:
        id:
          type: string
          description: The unique identifier of the linked catalog record.
          example: 550e8400-e29b-41d4-a716-446655440003
        fields:
          description: >-
            The field values of the linked catalog record — this is where the
            readable label lives. Call `GET /custom-objects/{relatedObjectId}`
            to map each `smartFieldId` to its name.
          example:
            - smartFieldId: 550e8400-e29b-41d4-a716-446655440004
              type: string
              rawValue: Alimentaire
              resolvedValue: Alimentaire
          type: array
          items:
            $ref: '#/components/schemas/CustomObjectRecordFieldValueDto'
      required:
        - id
        - fields
    CustomObjectRecordFieldValueDto:
      type: object
      properties:
        smartFieldId:
          type: string
          description: The unique identifier of the smart field this value belongs to.
          example: 550e8400-e29b-41d4-a716-446655440002
        type:
          type: string
          description: The data type of the smart field.
          enum:
            - string
            - number
            - date
            - select
            - multiselect
            - relation
            - relation_multiple
          example: string
        rawValue:
          type: string
          description: >-
            The stored value of the field. For `relation` and
            `relation_multiple` fields this is the identifier of the linked
            catalog record, or several identifiers separated by `;`.
          example: Alimentaire
          nullable: true
        resolvedValue:
          type: string
          description: >-
            The human-readable value of the field.


            - `select` / `multiselect`: the option labels, separated by `;`.

            - `relation` / `relation_multiple`: **identical to `rawValue`** — a
            relation stores an identifier, not text. Read `relatedRecords` to
            get the textual details of the linked catalog record.

            - all other types: the stored value.
          example: Alimentaire
          nullable: true
      required:
        - smartFieldId
        - type
  securitySchemes:
    X-API-KEY:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        API key for authentication. Get your key at
        https://app.tomorro.com/settings/integrations?integration=api-key

````