---
title: "List records"
method: GET
path: "/v1/records/{object}"
---

# List records

`GET /v1/records/{object}`

## Request

- Base URL: `https://api.pantheon.run`
- URL: `https://api.pantheon.run/v1/records/{object}`
- Auth: HTTP bearer

One keyset page. Soft-deleted records are excluded unless deleted=only.

## Path parameters

- `object` string, required

## Query parameters

- `limit` integer
- `cursor` string
- `sort` string
- `q` string
- `filter` string
- `deleted` 'exclude' | 'only'

## Response `200`

Default Response

- object
  - `data` union[]
    - union
      - object: People you are in contact with — one record per person (the golden record across their channels). Group chats, channels and other spaces are not contact records.
        - `channels` object[]
          - `handle` string, nullable
          - `id` string
          - `platform` string, nullable
        - `created_at` string, nullable, required
        - `deleted_at` string, nullable, required
        - `id` string, required
        - `object` 'contacts', required
        - `resolved_from` object: Present only when the requested id resolved to a different record (reason: merged | alias).
          - `id` string
          - `reason` string
        - `updated_at` string, nullable, required
        - `values` object, required
          - `blacklisted` unknown
          - `custom_fields` unknown
          - `email` unknown
          - `first_name` unknown
          - `last_contacted_at` unknown
          - `last_name` unknown
          - `location` unknown
          - `message_count` unknown
          - `organizations` unknown
          - `phone` unknown
          - `platforms` unknown
          - `tags` unknown
          - `username` unknown
          - `usernames` unknown
      - object: Companies in your CRM.
        - `created_at` string, nullable, required
        - `deleted_at` string, nullable, required
        - `id` string, required
        - `object` 'companies', required
        - `resolved_from` object: Present only when the requested id resolved to a different record (reason: merged | alias).
          - `id` string
          - `reason` string
        - `updated_at` string, nullable, required
        - `values` object, required
          - `canonical_company_id` unknown
          - `confirmed_at` unknown
          - `custom_fields` unknown
          - `domain` unknown
          - `name` unknown
          - `source` unknown
          - `source_ref` unknown
          - `status` unknown
          - `website_url` unknown
      - object: Deals in your workspace's pipelines.
        - `created_at` string, nullable, required
        - `deleted_at` string, nullable, required
        - `id` string, required
        - `object` 'deals', required
        - `resolved_from` object: Present only when the requested id resolved to a different record (reason: merged | alias).
          - `id` string
          - `reason` string
        - `updated_at` string, nullable, required
        - `values` object, required
          - `close_date` unknown
          - `closed_at` unknown
          - `company_id` unknown
          - `currency` unknown
          - `custom_fields` unknown
          - `deal_type` unknown
          - `lot_id` unknown
          - `notes` unknown
          - `pipeline_id` unknown
          - `probability` unknown
          - `product_id` unknown
          - `promoted_at` unknown
          - `stage` unknown
          - `status` unknown
          - `title` unknown
          - `value_cents` unknown
          - `variant_id` unknown
      - object: A record of a custom table.
        - `created_at` string, nullable
        - `deleted_at` string, nullable
        - `id` string, required
        - `resolved_from` object: Present only when the requested id resolved to a different record (reason: merged | alias).
          - `id` string
          - `reason` string
        - `updated_at` string, nullable
        - `values` object, required
  - `has_more` boolean
  - `next_cursor` string, nullable

---

[API](https://skmtc.dev/pantheon-run/apis/pantheon-developer-api.md) · [All operations](https://skmtc.dev/pantheon-run/apis/pantheon-developer-api/llms.txt) · [OpenAPI document](https://skmtc.dev/pantheon-run/apis/pantheon-developer-api/revisions/e51924bd212a?raw)