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

# List a custom object's records

> Pages through one custom object's records in a stable order. Filter with `filter[<key>][<op>]=<value>` (conditions are ANDed; `in` repeats the parameter). Keys are `account_id`, `contact_id` and `external_id` (eq, in, exists, not_exists, compared exactly), and the object's fields: text fields take eq, in, contains, starts_with and exists; number fields eq, gt, gte, lt, lte, in and exists; dates eq, gt, gte, lt, lte and exists, as YYYY-MM-DD compared as whole days. Anything else is a 422 naming what the field supports. `object` is the custom object's key (GET /v1/objects lists them, and GET /v1/objects/{object} its fields). A record carries the account or contact it belongs to, its `external_id` in the system that fills the object, and its values under `fields`, keyed as GET /v1/fields?object=<object> lists them.



## OpenAPI

````yaml /api/statisfy-api.openapi.json get /v1/objects/{object}/records
openapi: 3.1.0
info:
  description: >-
    The agent-first Statisfy API. Authenticate with an API key (`Authorization:
    Bearer stfy_live_…`), then call `GET /v1/meta/capabilities` to discover
    every operation and its schemas.
  title: Statisfy API
  version: 1.0.0
servers:
  - url: https://api.statisfy.com
    description: Production
security: []
paths:
  /v1/objects/{object}/records:
    get:
      tags:
        - custom_objects
      summary: List a custom object's records
      description: >-
        Pages through one custom object's records in a stable order. Filter with
        `filter[<key>][<op>]=<value>` (conditions are ANDed; `in` repeats the
        parameter). Keys are `account_id`, `contact_id` and `external_id` (eq,
        in, exists, not_exists, compared exactly), and the object's fields: text
        fields take eq, in, contains, starts_with and exists; number fields eq,
        gt, gte, lt, lte, in and exists; dates eq, gt, gte, lt, lte and exists,
        as YYYY-MM-DD compared as whole days. Anything else is a 422 naming what
        the field supports. `object` is the custom object's key (GET /v1/objects
        lists them, and GET /v1/objects/{object} its fields). A record carries
        the account or contact it belongs to, its `external_id` in the system
        that fills the object, and its values under `fields`, keyed as GET
        /v1/fields?object=<object> lists them.
      operationId: custom_objects_list
      parameters:
        - description: The custom object's key, as GET /v1/objects lists it
          in: path
          name: object
          required: true
          schema:
            maxLength: 200
            minLength: 1
            type: string
        - description: >-
            Custom field keys to return (comma-separated); all of them when
            omitted
          explode: false
          in: query
          name: fields
          required: false
          schema:
            anyOf:
              - items:
                  type: string
                type: array
              - type: 'null'
            default: null
          style: form
        - in: query
          name: limit
          required: false
          schema:
            default: 25
            maximum: 100
            minimum: 1
            type: integer
        - description: '`next_cursor` from the previous page'
          in: query
          name: cursor
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            default: null
        - description: >-
            Filter with query parameters ``filter[<key>][<op>]=<value>``, all
            ANDed; ``in``

            and ``nin`` take the parameter repeated.


            Operators: `eq`, `neq`, `gt`, `gte`, `lt`, `lte`, `in`, `nin`,
            `contains`, `not_contains`, `starts_with`, `ends_with`, `exists`,
            `not_exists`.
          explode: true
          in: query
          name: filter
          required: false
          schema:
            additionalProperties:
              additionalProperties: true
              type: object
            type: object
          style: deepObject
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomObjectRecordPage'
          description: Successful Response
      security:
        - HTTPBearer: []
components:
  schemas:
    CustomObjectRecordPage:
      properties:
        data:
          items:
            $ref: '#/components/schemas/CustomObjectRecord'
          title: Data
          type: array
        has_more:
          default: false
          title: Has More
          type: boolean
        next_cursor:
          anyOf:
            - type: string
            - type: 'null'
          title: Next Cursor
      required:
        - data
      title: CustomObjectRecordPage
      type: object
    CustomObjectRecord:
      properties:
        account_id:
          anyOf:
            - type: string
            - type: 'null'
          description: The account it belongs to; null when it belongs to a contact
          title: Account Id
        contact_id:
          anyOf:
            - type: string
            - type: 'null'
          description: The contact it belongs to; null when it belongs to an account
          title: Contact Id
        created_at:
          anyOf:
            - format: date-time
              type: string
            - type: 'null'
          title: Created At
        external_id:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            Its id in the system that fills the object, such as a Salesforce
            record id
          title: External Id
        fields:
          additionalProperties: true
          description: Its values, keyed as GET /v1/fields?object=<object> lists them
          title: Fields
          type: object
        id:
          title: Id
          type: string
        object:
          description: The custom object's key
          title: Object
          type: string
        updated_at:
          anyOf:
            - format: date-time
              type: string
            - type: 'null'
          title: Updated At
      required:
        - id
        - object
      title: CustomObjectRecord
      type: object
  securitySchemes:
    HTTPBearer:
      scheme: bearer
      type: http
      description: >-
        An API key, sent as `Authorization: Bearer stfy_live_…`. See
        [Authentication](/rest-api/authentication) for how to get one and which
        scopes it needs.

````

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