Get a CRM Record - Zeeg Developer Hub

GET

crm

{objectSlug}

{recordId}

Get a CRM record

curl --request GET \
  --url https://api.zeeg.me/v2/crm/{objectSlug}/{recordId} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.zeeg.me/v2/crm/{objectSlug}/{recordId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.zeeg.me/v2/crm/{objectSlug}/{recordId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.zeeg.me/v2/crm/{objectSlug}/{recordId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.zeeg.me/v2/crm/{objectSlug}/{recordId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "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"
  }
}

{
  "message": "Unauthenticated."
}

{
  "error": {
    "type": "insufficient_scope",
    "message": "Your token is missing the required scope(s). Include at least one of: crm:read, crm:write.",
    "error_id": "97bc8f3f-5a33-467a-83de-e7ada9e31305",
    "required_scopes": [
      "crm:read",
      "crm:write"
    ]
  }
}

{
  "success": false,
  "message": "Record not found.",
  "status": 404
}

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 or Create 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:

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

success

boolean

Example:

true

status

integer

Example:

200

record

object

A record for a custom CRM object.

Hide child attributes

record.id

string<uuid>

required

Unique identifier for the record.

Example:

"c1d2e3f4-a5b6-7890-cdef-123456789012"

record.objectSlug

string

required

Slug of the CRM object this record belongs to.

Example:

"products"

record.attributes

object

required

Key/value pairs for the custom attributes defined on the object. Keys are attribute slugs.

Example:

{
  "sku": "DRESS-001",
  "price": 29,
  "inventory_count": 150
}

record.createdAt

string<date-time>

required

ISO 8601 timestamp when the record was created.

Example:

"2025-06-01T10:00:00+00:00"

record.updatedAt

string<date-time>

required

ISO 8601 timestamp when the record was last updated.

Example:

"2025-06-01T12:00:00+00:00"

Last modified on June 11, 2026

Get a CRM record

curl --request GET \
  --url https://api.zeeg.me/v2/crm/{objectSlug}/{recordId} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.zeeg.me/v2/crm/{objectSlug}/{recordId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.zeeg.me/v2/crm/{objectSlug}/{recordId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.zeeg.me/v2/crm/{objectSlug}/{recordId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.zeeg.me/v2/crm/{objectSlug}/{recordId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "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"
  }
}

{
  "message": "Unauthenticated."
}

{
  "error": {
    "type": "insufficient_scope",
    "message": "Your token is missing the required scope(s). Include at least one of: crm:read, crm:write.",
    "error_id": "97bc8f3f-5a33-467a-83de-e7ada9e31305",
    "required_scopes": [
      "crm:read",
      "crm:write"
    ]
  }
}

{
  "success": false,
  "message": "Record not found.",
  "status": 404
}

​Path parameters

​Response shape

​Understanding the attributes object

​404 Not Found

​When to use this endpoint

Authorizations

Path Parameters

Response

Path parameters

Response shape

Understanding the `attributes` object

404 Not Found

When to use this endpoint