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

# List object records

> List records of a given object type. Records may include personRefId, the Person spine join key for human attribution.



## OpenAPI

````yaml https://api.sapt.ai/openapi.json get /projects/{projectId}/object-records
openapi: 3.1.0
info:
  title: Sapt Platform API
  version: 1.0.0
  description: >-
    API for Sapt platform - project management, authentication, and email
    services
servers:
  - url: https://api.sapt.ai
    description: Production
  - url: http://localhost:8787
    description: Local development
security: []
tags:
  - name: Accounts
    description: >-
      The social accounts connected to a project. Start here — the `id` of an
      account is the `socialAccountId` that every posting, scheduling and
      analytics call takes.
  - name: Actions
  - name: Ads
  - name: Agents
  - name: Analytics
    description: >-
      Account- and post-level organic performance for connected Instagram and
      Facebook accounts.
  - name: Assets
  - name: Auth
  - name: CMS
  - name: CRM
  - name: Calendar
  - name: Comments
    description: >-
      Read, reply to, hide and delete comments on published Instagram and
      Facebook posts.
  - name: Content Calendar
    description: >-
      Create, schedule, update and publish organic posts, and stage the media
      they carry. Publishing a post whose status is `failed` retries it.
  - name: Contracts
  - name: Conversions
    description: >-
      Meta server-side Conversions API (CAPI): discover pixels, connect a pixel
      + CAPI token, and send deduped server-side conversions.
  - name: Dashboard Sidebar
  - name: Emails
  - name: Engagement
    description: >-
      Act as the Page or account on published posts: comment, like, unlike, and
      delete a published post.
  - name: Geo
  - name: Google Ads
  - name: Google Analytics
  - name: Google Business
  - name: Integrations
    description: >-
      Connect third-party providers (Meta, Gmail, Google Business Profile, …).
      List providers, mint OAuth connect links, and poll connection status.
  - name: Invitations
  - name: Memory
  - name: OAuth Clients
  - name: Project Roles
  - name: Project Templates
  - name: Projects
  - name: Schedules
  - name: Service Accounts
  - name: Socials
    description: >-
      Organic social: the connected accounts, the content calendar, media
      staging, publishing, comments and engagement across Instagram, Facebook,
      TikTok, YouTube and Google Business Profile.
  - name: Team
  - name: Users
  - name: Web Analytics
  - name: Workflows
paths:
  /projects/{projectId}/object-records:
    get:
      tags:
        - CRM
      summary: List object records
      description: >-
        List records of a given object type. Records may include personRefId,
        the Person spine join key for human attribution.
      operationId: listObjectRecords
      parameters:
        - schema:
            type: string
            format: uuid
          required: true
          name: projectId
          in: path
        - schema:
            type: string
          required: true
          name: typeSlug
          in: query
        - schema:
            type: string
          required: false
          name: search
          in: query
        - schema:
            type: string
          required: false
          name: status
          in: query
        - schema:
            type: string
            enum:
              - createdAt
              - updatedAt
              - displayName
          required: false
          name: orderBy
          in: query
        - schema:
            type: string
            enum:
              - asc
              - desc
          required: false
          name: orderDirection
          in: query
        - schema:
            type: string
            enum:
              - 'true'
              - 'false'
          required: false
          name: includeTotal
          in: query
        - schema:
            type: integer
            minimum: 1
            maximum: 500
          required: false
          name: limit
          in: query
        - schema:
            type:
              - integer
              - 'null'
            minimum: 0
          required: false
          name: offset
          in: query
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  records:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        typeSlug:
                          type: string
                        displayName:
                          type:
                            - string
                            - 'null'
                        externalId:
                          type:
                            - string
                            - 'null'
                        data:
                          type: object
                          additionalProperties: {}
                        personRefId:
                          type:
                            - string
                            - 'null'
                          description: >-
                            Person spine record id attached during create/update
                            when this type links to Person and the payload
                            carries matching identity. Use this as the durable
                            join key for all data about one human.
                        companyRefId:
                          type:
                            - string
                            - 'null'
                          description: >-
                            Reserved promoted company attribution id. Company
                            spine support is not the primary public contract;
                            model company relationships through CRM relations
                            unless documented otherwise.
                        amountCents:
                          type:
                            - string
                            - 'null'
                          pattern: ^-?\d+$
                          description: >-
                            Money in minor units, decimal-string-encoded to
                            preserve precision beyond Number.MAX_SAFE_INTEGER.
                        currency:
                          type:
                            - string
                            - 'null'
                        status:
                          type:
                            - string
                            - 'null'
                        occurredAt:
                          type:
                            - string
                            - 'null'
                          format: date-time
                        providerExternalId:
                          type:
                            - string
                            - 'null'
                        createdAt:
                          type: string
                          format: date-time
                        updatedAt:
                          type: string
                          format: date-time
                        createdBy:
                          type:
                            - string
                            - 'null'
                        updatedBy:
                          type:
                            - string
                            - 'null'
                      required:
                        - id
                        - typeSlug
                        - displayName
                        - externalId
                        - data
                        - personRefId
                        - companyRefId
                        - amountCents
                        - currency
                        - status
                        - occurredAt
                        - providerExternalId
                        - createdAt
                        - updatedAt
                        - createdBy
                        - updatedBy
                  pagination:
                    type: object
                    properties:
                      limit:
                        type: integer
                      offset:
                        type: integer
                    required:
                      - limit
                      - offset
                  total:
                    type:
                      - integer
                      - 'null'
                required:
                  - records
                  - pagination
                  - total
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    description: Error message
                  code:
                    type: string
                    description: Error code for programmatic handling
                required:
                  - message
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    description: Error message
                  code:
                    type: string
                    description: Error code for programmatic handling
                required:
                  - message
        '404':
          description: Not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    description: Error message
                  code:
                    type: string
                    description: Error code for programmatic handling
                required:
                  - message
      security:
        - bearerAuth: []
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        JWT token obtained from /api/auth/token endpoint. Token is verified
        using JWKS and must include a valid user identifier.

````