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

# Get a CRM Record

> Retrieve a single custom CRM object record by UUID with the Zeeg CRM API, returning all its attribute values keyed by attribute slug

Returns a single record for a custom CRM object by its UUID.

## Path parameters

| Parameter    | Type          | Description                                                                                                                                 |
| ------------ | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
| `objectSlug` | string        | The slug of the custom CRM object the record belongs to.                                                                                    |
| `recordId`   | string (UUID) | The unique ID of the record. Obtained from a previous [List](/api/crm/list-crm-records) or [Create](/api/crm/create-a-crm-record) response. |

## Response shape

| Field        | Type              | Description                                                                                                              |
| ------------ | ----------------- | ------------------------------------------------------------------------------------------------------------------------ |
| `id`         | string (UUID)     | Unique identifier for the record.                                                                                        |
| `objectSlug` | string            | The object this record belongs to (e.g. `products`).                                                                     |
| `attributes` | object            | All attribute values for this record, keyed by attribute slug. Attributes that have not been set are returned as `null`. |
| `createdAt`  | string (ISO 8601) | Timestamp when the record was created.                                                                                   |
| `updatedAt`  | string (ISO 8601) | Timestamp when the record was last modified.                                                                             |

## Understanding the `attributes` object

Attribute keys inside `attributes` match the slugs defined on the object schema. The shape of the object depends entirely on which attributes exist on that CRM object.

For example, a `products` object with attributes `sku`, `price`, and `in_stock` returns:

```json theme={null}
{
  "record": {
    "id": "c1d2e3f4-a5b6-7890-cdef-123456789012",
    "objectSlug": "products",
    "attributes": {
      "sku": "DRESS-001",
      "price": 29,
      "in_stock": true
    },
    "createdAt": "2025-06-01T10:00:00+00:00",
    "updatedAt": "2025-06-01T10:00:00+00:00"
  }
}
```

To know which keys to expect and their types, call [`GET /v2/crm/objects/{slug}`](/api/crm/get-a-crm-object).

## 404 Not Found

If either the object slug does not exist in your workspace, or the record ID does not belong to that object, the API returns `404`:

```json theme={null}
{
  "success": false,
  "message": "Record not found.",
  "status": 404
}
```

## When to use this endpoint

* **Detail view** — display a single record's full data after the user clicks a row.
* **Verification** — confirm a record still exists and fetch its latest values before displaying or editing.
* **Webhook handlers** — look up a record by the ID received in a webhook payload.


## OpenAPI

````yaml GET /crm/{objectSlug}/{recordId}
openapi: 3.0.0
info:
  title: Zeeg Public API
  description: >-
    Zeeg public API documentation.


    ## Authentication

    All endpoints require a Bearer token. You can generate an API token from
    [your Zeeg dashboard](https://app.zeeg.me/account/settings/api-access).


    Each token is scoped to specific permissions (e.g. `events:read`,
    `webhooks:write`). Make sure your token has the required scopes for the
    endpoints you want to use.


    ## Recommended Headers

    We recommend including the `Accept: application/json` header in all API
    requests to ensure you receive JSON responses.
  version: 2.0.0
  x-logo:
    url: https://app.zeeg.me/img/logo-dark.2ca83593.svg
    backgroundColor: '#f7f7f9'
    altText: zeeg
  contact:
    name: Zeeg Support
    email: support@zeeg.me
    url: https://zeeg.me/en/contact
  license:
    name: Proprietary
    url: https://zeeg.me/en/legal/terms
  termsOfService: https://zeeg.me/en/legal/terms
servers:
  - url: https://api.zeeg.me/v2
    description: Production
security:
  - bearer: []
tags:
  - name: Scheduled Events
    description: Management of events scheduled via Zeeg
  - name: Scheduling Pages
    description: Scheduling pages information and management
  - name: Availability Schedule
    description: Read and change availability for users
  - name: Webhooks
    description: Webhooks management
  - name: Notes
    description: Notes for scheduled events
  - name: Workspaces & Teams
    description: Workspace users and team member management
  - name: AI Agent
    description: AI Agent integration endpoints
  - name: Payloads
    description: Webhook payload schemas
  - name: CRM - Objects
    description: >-
      Discover the schema of CRM objects (standard and custom) including all
      attribute definitions
  - name: CRM - Companies
    description: Create, read, update, and delete CRM company records
  - name: CRM - People
    description: Create, read, update, and delete CRM person records
paths:
  /crm/{objectSlug}/{recordId}:
    get:
      tags:
        - CRM - Records
      summary: Get a CRM record
      description: |-
        Returns a single record for a custom CRM object by its ID.

        **Required scope:** `crm:read` or `crm:write`
      operationId: get-crm-record
      parameters:
        - name: objectSlug
          in: path
          required: true
          schema:
            type: string
          description: Slug of the custom CRM object.
          example: products
        - name: recordId
          in: path
          required: true
          schema:
            type: string
            format: uuid
          description: UUID of the record.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                  status:
                    type: integer
                    example: 200
                  record:
                    $ref: '#/components/schemas/CrmRecord'
        '401':
          $ref: '#/components/responses/401'
        '403':
          description: Forbidden — missing scope or CRM not enabled
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  message:
                    type: string
                  status:
                    type: integer
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  message:
                    type: string
                  status:
                    type: integer
              examples:
                Not found:
                  value:
                    success: false
                    message: Record not found.
                    status: 404
      security:
        - bearer: []
components:
  schemas:
    CrmRecord:
      type: object
      description: A record for a custom CRM object.
      required:
        - id
        - objectSlug
        - attributes
        - createdAt
        - updatedAt
      properties:
        id:
          type: string
          format: uuid
          description: Unique identifier for the record.
          example: c1d2e3f4-a5b6-7890-cdef-123456789012
        objectSlug:
          type: string
          description: Slug of the CRM object this record belongs to.
          example: products
        attributes:
          type: object
          description: >-
            Key/value pairs for the custom attributes defined on the object.
            Keys are attribute slugs.
          additionalProperties: true
          example:
            sku: DRESS-001
            price: 29
            inventory_count: 150
        createdAt:
          type: string
          format: date-time
          description: ISO 8601 timestamp when the record was created.
          example: '2025-06-01T10:00:00+00:00'
        updatedAt:
          type: string
          format: date-time
          description: ISO 8601 timestamp when the record was last updated.
          example: '2025-06-01T12:00:00+00:00'
  responses:
    '401':
      description: Unauthorized
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
                example: Unauthenticated.
          examples:
            Unauthenticated:
              value:
                message: Unauthenticated.
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
      description: ''

````