Skip to main content
GET
/
crm
/
{objectSlug}
/
{recordId}
Get a CRM record
curl --request GET \
  --url https://api.zeeg.me/v2/crm/{objectSlug}/{recordId} \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "status": 200,
  "record": {
    "id": "c1d2e3f4-a5b6-7890-cdef-123456789012",
    "objectSlug": "products",
    "attributes": {
      "sku": "DRESS-001",
      "price": 29,
      "inventory_count": 150
    },
    "createdAt": "2025-06-01T10:00:00+00:00",
    "updatedAt": "2025-06-01T12:00:00+00:00"
  }
}

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.

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

Path parameters

ParameterTypeDescription
objectSlugstringThe slug of the custom CRM object the record belongs to.
recordIdstring (UUID)The unique ID of the record. Obtained from a previous List or Create response.

Response shape

FieldTypeDescription
idstring (UUID)Unique identifier for the record.
objectSlugstringThe object this record belongs to (e.g. products).
attributesobjectAll attribute values for this record, keyed by attribute slug. Attributes that have not been set are returned as null.
createdAtstring (ISO 8601)Timestamp when the record was created.
updatedAtstring (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:
{
  "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}.

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:
{
  "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.

Authorizations

Authorization
string
header
required

Path Parameters

objectSlug
string
required

Slug of the custom CRM object.

recordId
string<uuid>
required

UUID of the record.

Response

OK

success
boolean
Example:

true

status
integer
Example:

200

record
object

A record for a custom CRM object.

Last modified on May 7, 2026