Skip to main content
GET
/
crm
/
objects
/
{slug}
Get a CRM object
curl --request GET \
  --url https://api.zeeg.me/v2/crm/objects/{slug} \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://api.zeeg.me/v2/crm/objects/{slug}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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

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

}
HttpResponse<String> response = Unirest.get("https://api.zeeg.me/v2/crm/objects/{slug}")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

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

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,
  "object": {
    "slug": "people",
    "singularName": "Person",
    "pluralName": "People",
    "isStandard": true,
    "isActive": true,
    "attributes": [
      {
        "key": "first_name",
        "label": "First Name",
        "type": "text",
        "isRequired": false,
        "isStandard": true
      },
      {
        "key": "last_name",
        "label": "Last Name",
        "type": "text",
        "isRequired": false,
        "isStandard": true
      },
      {
        "key": "email",
        "label": "Email",
        "type": "text",
        "isRequired": false,
        "isStandard": true
      },
      {
        "key": "phone_number",
        "label": "Phone Number",
        "type": "phone",
        "isRequired": false,
        "isStandard": true
      },
      {
        "key": "job_title",
        "label": "Job Title",
        "type": "text",
        "isRequired": false,
        "isStandard": true
      },
      {
        "key": "customer_status",
        "label": "Customer Status",
        "type": "select",
        "isRequired": false,
        "isStandard": false,
        "isUnique": false,
        "isArchived": false,
        "options": [
          {
            "id": 1,
            "value": "Lead",
            "color": "warning"
          },
          {
            "id": 2,
            "value": "Active",
            "color": "success"
          },
          {
            "id": 3,
            "value": "Churned",
            "color": "red"
          }
        ]
      }
    ],
    "createdAt": "2025-01-15T09:00:00+00:00",
    "updatedAt": "2025-06-01T12:00:00+00:00"
  }
}
Returns the full schema for a single object identified by its slug, including every attribute definition with its type, label, options, and relation metadata. Standard object slugs are always people and companies. Custom object slugs are set at creation time and are immutable.

Authorizations

Authorization
string
header
required

Path Parameters

slug
string
required

The object slug. Standard objects use people and companies. Custom objects use the slug you assigned when creating them.

Example:

"people"

Response

OK

success
boolean
Example:

true

status
integer
Example:

200

object
object

A CRM object definition including its full attribute schema.

Last modified on June 11, 2026