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

# List records in a list

> Returns a page of the records in a list, with their cell values. Values are keyed by property (column) id, not by column name. Page with `offset` and `limit`.




## OpenAPI

````yaml /openapi/records.yaml get /lists/{id}/items
openapi: 3.1.0
info:
  title: Connie Records API
  version: 1.0.0
  description: >
    Endpoints the Connie web app uses for records. They authenticate with your
    signed-in browser session — see
    https://docs.connie.ai/api-reference/authentication. These are the app's own
    endpoints and can change when the app changes.
servers:
  - url: https://connie.ai/api
security:
  - sessionCookie: []
tags:
  - name: Lists
    description: Lists of records on an object, and the records in them.
  - name: People
    description: Find, match and create records on the People object.
  - name: Companies
    description: Find and create records on the Companies object.
  - name: Notes
    description: Notes on a person.
  - name: Tasks
    description: Tasks linked to a person or a company, and their comments.
paths:
  /lists/{id}/items:
    get:
      tags:
        - Lists
      summary: List records in a list
      description: >
        Returns a page of the records in a list, with their cell values. Values
        are keyed by property (column) id, not by column name. Page with
        `offset` and `limit`.
      operationId: listListRecords
      parameters:
        - $ref: '#/components/parameters/ListId'
        - name: search
          in: query
          description: Only records whose values contain this text.
          schema:
            type: string
        - name: limit
          in: query
          description: Page size, 1 to 1,000.
          schema:
            type: integer
            default: 50
            minimum: 1
            maximum: 1000
        - name: offset
          in: query
          schema:
            type: integer
            default: 0
      responses:
        '200':
          description: A page of records.
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/ListRecord'
                  totalCount:
                    type:
                      - integer
                      - 'null'
                    description: Records in the list that match.
                  entityTableId:
                    type: string
                    format: uuid
                    description: The object the list is built on.
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  parameters:
    ListId:
      name: id
      in: path
      required: true
      description: The list id.
      schema:
        type: string
        format: uuid
  schemas:
    ListRecord:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: The record id.
        table_id:
          type: string
          format: uuid
          description: The object the record is on.
        properties:
          type: object
          description: Cell values keyed by property (column) id.
          additionalProperties: true
        created_at:
          type: string
          format: date-time
        created_by:
          type:
            - string
            - 'null'
          format: uuid
        updated_at:
          type: string
          format: date-time
    Error:
      type: object
      properties:
        error:
          type: string
          description: Human-readable message.
        code:
          type: string
          description: Machine-readable code, when there is one.
      required:
        - error
  responses:
    BadRequest:
      description: A required field is missing or invalid.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Unauthorized:
      description: >-
        No valid session (`UNAUTHORIZED`), or the session has expired
        (`SESSION_EXPIRED`).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Forbidden:
      description: You aren't a member of the workspace or don't have access to this item.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    NotFound:
      description: Not found.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    sessionCookie:
      type: apiKey
      in: header
      name: Cookie
      description: >-
        The full Cookie header copied from a signed-in connie.ai browser
        request. See the Authentication page.

````

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