List CRM Records - Zeeg Developer Hub

GET

crm

{objectSlug}

List CRM records

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

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

fetch('https://api.zeeg.me/v2/crm/{objectSlug}', 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}",
  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}"

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

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,
  "data": {
    "pagination": {
      "totalItems": 1,
      "perPage": 10,
      "currentPage": 1,
      "lastPage": 1,
      "hasPreviousPage": false,
      "hasNextPage": false
    },
    "records": [
      {
        "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-01T10: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": "c15cef8e-008a-4637-b866-5de870eeb5dd",
    "required_scopes": [
      "crm:read",
      "crm:write"
    ]
  }
}

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

Returns a paginated list of records for a custom CRM object. Use this endpoint to browse all records for any object you’ve created — products, deals, subscriptions, or any other custom object in your workspace.

Path parameter

Parameter	Type	Description
`objectSlug`	string	The slug of the custom CRM object. Must already exist. Discover available slugs via List CRM Objects.

Query parameters

Parameter	Type	Default	Description
`page`	integer	`1`	Page number. Starts at 1.
`perPage`	integer	`10`	Number of records returned per page. Maximum is `100`.
`sortBy`	string	`created_at`	Attribute slug to sort by. Pass the exact attribute key (e.g. `price`, `sku`). Use `created_at` or `updated_at` for system timestamps.
`sortOrder`	string	`asc`	Sort direction. Either `asc` (oldest/lowest first) or `desc` (newest/highest first).

Response shape

Each record in the records array contains:

Field	Type	Description
`id`	string (UUID)	Unique identifier for the record. Store this on your side to avoid re-fetching.
`objectSlug`	string	The object this record belongs to.
`attributes`	object	All attribute values keyed by their attribute slug. Unset attributes are `null`.
`createdAt`	string (ISO 8601)	When the record was created.
`updatedAt`	string (ISO 8601)	When the record was last modified.

The pagination wrapper contains:

Field	Type	Description
`totalItems`	integer	Total number of records across all pages.
`perPage`	integer	Records per page as requested.
`currentPage`	integer	The page returned in this response.
`lastPage`	integer	Total number of pages.
`hasPreviousPage`	boolean	`true` when a previous page exists.
`hasNextPage`	boolean	`true` when a next page exists.

Discovering attribute keys

Attribute keys (the keys inside attributes) are defined on the object schema. To see all available attribute slugs and their types, call GET /v2/crm/objects/{slug} before building a UI or processing the response.

Pagination example

To iterate through all records in pages of 50, ordered newest first:

GET /v2/crm/products?perPage=50&sortBy=created_at&sortOrder=desc&page=1
GET /v2/crm/products?perPage=50&sortBy=created_at&sortOrder=desc&page=2

Keep requesting until hasNextPage is false.

When to use this endpoint

Browsing — display a table of records in your UI.
Export — page through all records to write them to another system.
Sync jobs — poll for recently updated records with sortBy=updated_at&sortOrder=desc.

Authorizations

Authorization

string

header

required

Path Parameters

objectSlug

string

required

Slug of the custom CRM object.

Query Parameters

page

integer

default:1

Page number.

Required range: x >= 1

perPage

integer

default:10

Number of records per page.

Required range: 1 <= x <= 100

sortBy

string

default:created_at

Attribute slug to sort by.

sortOrder

enum<string>

default:asc

Sort direction.

Available options:

asc,

desc

Response

success

boolean

Example:

true

status

integer

Example:

200

data

object

Hide child attributes

data.pagination

object

Hide child attributes

data.pagination.totalItems

integer

data.pagination.perPage

integer

data.pagination.currentPage

integer

data.pagination.lastPage

integer

data.pagination.hasPreviousPage

boolean

data.pagination.hasNextPage

boolean

data.records

object[]

Hide child attributes

data.records.id

string<uuid>

required

Unique identifier for the record.

Example:

"c1d2e3f4-a5b6-7890-cdef-123456789012"

data.records.objectSlug

string

required

Slug of the CRM object this record belongs to.

Example:

"products"

data.records.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
}

data.records.createdAt

string<date-time>

required

ISO 8601 timestamp when the record was created.

Example:

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

data.records.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

List CRM records

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

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

fetch('https://api.zeeg.me/v2/crm/{objectSlug}', 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}",
  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}"

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

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,
  "data": {
    "pagination": {
      "totalItems": 1,
      "perPage": 10,
      "currentPage": 1,
      "lastPage": 1,
      "hasPreviousPage": false,
      "hasNextPage": false
    },
    "records": [
      {
        "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-01T10: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": "c15cef8e-008a-4637-b866-5de870eeb5dd",
    "required_scopes": [
      "crm:read",
      "crm:write"
    ]
  }
}

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

​Path parameter

​Query parameters

​Response shape

​Discovering attribute keys

​Pagination example

​When to use this endpoint

Authorizations

Path Parameters

Query Parameters

Response

Path parameter

Query parameters

Response shape

Discovering attribute keys

Pagination example

When to use this endpoint