List CRM Objects - Zeeg Developer Hub

GET

crm

objects

List CRM objects

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

{
  "success": true,
  "status": 200,
  "collection": [
    {
      "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_number",
          "isRequired": false,
          "isStandard": true
        }
      ],
      "createdAt": "2025-01-15T09:00:00+00:00",
      "updatedAt": "2025-01-15T09:00:00+00:00"
    },
    {
      "slug": "companies",
      "singularName": "Company",
      "pluralName": "Companies",
      "isStandard": true,
      "isActive": true,
      "attributes": [
        {
          "key": "name",
          "label": "Name",
          "type": "text",
          "isRequired": true,
          "isStandard": true
        },
        {
          "key": "domain",
          "label": "Domain",
          "type": "text",
          "isRequired": false,
          "isStandard": true
        }
      ],
      "createdAt": "2025-01-15T09:00:00+00:00",
      "updatedAt": "2025-01-15T09:00:00+00:00"
    }
  ]
}

Returns all CRM objects in your workspace along with their complete attribute schemas. Standard objects (people, companies) are always present. Custom objects appear once created. Use this endpoint first to map your existing schema before importing records — every attribute key returned here is the identifier you use when writing record values.

This endpoint returns all objects in a single response. There is no pagination.

Authorizations

Authorization

string

header

required

Response

success

boolean

Example:

true

status

integer

Example:

200

collection

object[]

Hide child attributes

collection.slug

string

required

Unique identifier for the object. Used in all record API calls.

Example:

"people"

collection.singularName

string

required

Singular display name.

Example:

"Person"

collection.pluralName

string

required

Plural display name.

Example:

"People"

collection.isStandard

boolean

required

true for built-in objects (people, companies). false for custom objects.

Example:

true

collection.isActive

boolean

required

Whether the object is enabled in the workspace.

Example:

true

collection.attributes

object[]

required

Full list of attribute definitions for this object.

Hide child attributes

collection.attributes.key

string

required

Attribute key used when reading or writing record values.

Example:

"job_title"

collection.attributes.label

string

required

Human-readable label shown in the UI.

Example:

"Job Title"

collection.attributes.type

enum<string>

required

Attribute data type. Cannot be changed after creation.

Available options:

text,

number,

phone_number,

date,

datetime,

checkbox,

select,

multiselect,

rating,

relation,

status,

user,

currency

Example:

"text"

collection.attributes.isRequired

boolean

required

Whether a value is required when creating a record.

Example:

false

collection.attributes.isStandard

boolean

required

true for built-in attributes, false for custom attributes added by your workspace.

Example:

false

collection.attributes.isUnique

boolean

required

Whether values must be unique across all records. Applies to text, phone, and number types.

Example:

false

collection.attributes.isArchived

boolean

required

Whether the attribute is archived. Archived attributes are hidden from the UI but their data is preserved.

Example:

false

collection.attributes.createdAt

string<date-time>

required

ISO 8601 timestamp when the attribute was created.

Example:

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

collection.attributes.updatedAt

string<date-time>

required

ISO 8601 timestamp when the attribute was last updated.

Example:

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

collection.attributes.options

object[]

Available options. Present only for select, multiselect, and status attributes.

Hide child attributes

collection.attributes.options.value

string

required

The option label shown in the UI and stored as the attribute value.

Maximum string length: 512

Example:

"Active"

collection.attributes.options.color

string

required

Color name for the option. Allowed values: gray, primary, warning, success, cyan, sky, violet, fuchsia, rose, blue, green, red, pink, black, yellow, orange.

Example:

"success"

collection.attributes.options.id

integer | null

Server-assigned option ID. Omit when adding a new option; include when updating an existing one to preserve it.

Example:

1

Slug of the related object. Present only for relation attributes. Immutable after creation.

Example:

"companies"

Display label for the relation. Present only for relation attributes. Can be updated via PATCH.

Example:

"Company"

collection.attributes.relationType

enum<string> | null

Cardinality of the relation. Present only for relation attributes.

Available options:

one_to_one,

many_to_one,

one_to_many,

many_to_many

Example:

"many_to_one"

collection.attributes.isMultipleSelection

boolean

true when relationType is one_to_many or many_to_many. Present only for relation attributes.

Example:

false

collection.attributes.currency

string | null

ISO 4217 currency code. Present only for currency attributes. Immutable after creation.

Example:

"EUR"

collection.attributes.currencyDisplay

enum<string> | null

How the currency value is displayed. Present only for currency attributes.

Available options:

code,

name,

symbol

Example:

"symbol"

collection.attributes.currencyDecimal

boolean | null

Whether decimal places are shown. Present only for currency attributes.

Example:

true

collection.attributes.currencyGrouping

boolean | null

Whether a thousands separator is used. Present only for currency attributes.

Example:

true

collection.createdAt

string<date-time>

required

Example:

"2025-01-15T09:00:00+00:00"

collection.updatedAt

string<date-time>

required

Example:

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

Last modified on May 7, 2026

CRM Overview

Get a CRM Object

List CRM objects

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

{
  "success": true,
  "status": 200,
  "collection": [
    {
      "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_number",
          "isRequired": false,
          "isStandard": true
        }
      ],
      "createdAt": "2025-01-15T09:00:00+00:00",
      "updatedAt": "2025-01-15T09:00:00+00:00"
    },
    {
      "slug": "companies",
      "singularName": "Company",
      "pluralName": "Companies",
      "isStandard": true,
      "isActive": true,
      "attributes": [
        {
          "key": "name",
          "label": "Name",
          "type": "text",
          "isRequired": true,
          "isStandard": true
        },
        {
          "key": "domain",
          "label": "Domain",
          "type": "text",
          "isRequired": false,
          "isStandard": true
        }
      ],
      "createdAt": "2025-01-15T09:00:00+00:00",
      "updatedAt": "2025-01-15T09:00:00+00:00"
    }
  ]
}

Documentation Index

Authorizations

Response