Get a CRM Object - Zeeg Developer Hub

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

success

boolean

Example:

true

status

integer

Example:

200

object

A CRM object definition including its full attribute schema.

Hide child attributes

object.slug

string

required

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

Example:

"people"

object.singularName

string

required

Singular display name.

Example:

"Person"

object.pluralName

string

required

Plural display name.

Example:

"People"

object.isStandard

boolean

required

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

Example:

true

object.isActive

boolean

required

Whether the object is enabled in the workspace.

Example:

true

object.attributes

object[]

required

Full list of attribute definitions for this object.

Hide child attributes

object.attributes.key

string

required

Attribute key used when reading or writing record values.

Example:

"job_title"

object.attributes.label

string

required

Human-readable label shown in the UI.

Example:

"Job Title"

object.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"

object.attributes.isRequired

boolean

required

Whether a value is required when creating a record.

Example:

false

object.attributes.isStandard

boolean

required

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

Example:

false

object.attributes.isUnique

boolean

required

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

Example:

false

object.attributes.isArchived

boolean

required

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

Example:

false

object.attributes.createdAt

string<date-time>

required

ISO 8601 timestamp when the attribute was created.

Example:

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

object.attributes.updatedAt

string<date-time>

required

ISO 8601 timestamp when the attribute was last updated.

Example:

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

object.attributes.options

object[]

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

Hide child attributes

object.attributes.options.value

string

required

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

Maximum string length: 512

Example:

"Active"

object.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"

object.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"

object.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"

object.attributes.isMultipleSelection

boolean

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

Example:

false

object.attributes.currency

string | null

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

Example:

"EUR"

object.attributes.currencyDisplay

enum<string> | null

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

Available options:

code,

name,

symbol

Example:

"symbol"

object.attributes.currencyDecimal

boolean | null

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

Example:

true

object.attributes.currencyGrouping

boolean | null

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

Example:

true

object.createdAt

string<date-time>

required

Example:

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

object.updatedAt

string<date-time>

required

Example:

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

API Reference

Documentation Index

Authorizations

Path Parameters

Response