Retrieve the full schema of a single Zeeg CRM object by slug, including every attribute definition with its type, label, options, and relation metadata
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.
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
object.attributes.relatedObjectSlug
string | null
Slug of the related object. Present only for relation attributes. Immutable after creation.
Example:
"companies"
object.attributes.relatedObjectLabel
string | null
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"
object.titleAttribute
string
Key of the attribute a record is named by, and that search matches on the records list. id until you set another one.
{"docsConfig":{"theme":"luma","$schema":"https://mintlify.com/docs.json","name":"Zeeg Developer Hub","description":"Zeeg Developer Hub: REST API reference, guides, and webhooks for building scheduling, booking, and AI-agent integrations on the Zeeg platform.","colors":{"primary":"#6C63FF","light":"#8B83FF","dark":"#4F46E5"},"logo":"https://mintcdn.com/zeeg/9voKLLkajreclhp4/images/Zeeglogo(Original).svg?fit=max\u0026auto=format\u0026n=9voKLLkajreclhp4\u0026q=85\u0026s=321632804eda4b3cff044941f9ccadda","favicon":"https://mintcdn.com/zeeg/9voKLLkajreclhp4/images/favicon.ico?fit=max\u0026auto=format\u0026n=9voKLLkajreclhp4\u0026q=85\u0026s=ee885974552f141091cdd615c5c15345","api":{"openapi":"openapi.yaml","params":{"expanded":"all"},"playground":{"display":"interactive","proxy":false},"examples":{"defaults":"required"},"mdx":{"auth":{"method":"bearer"},"server":"https://api.zeeg.me/v2"}},"appearance":{"default":"system"},"background":{"decoration":"gradient","color":{"dark":"#0f1117"}},"navbar":{"links":[{"href":"https://app.zeeg.me","label":"Dashboard"}],"primary":{"type":"button","label":"Get API Key","href":"https://app.zeeg.me/account/settings/api-access"}},"footer":{"socials":{"linkedin":"https://www.linkedin.com/company/zeeg","x":"https://www.twitter.com/zeeg_me","youtube":"https://www.youtube.com/@zeeg_me","instagram":"https://www.instagram.com/zeeg.me"},"links":[{"header":"Product","items":[{"label":"Pricing","href":"https://zeeg.me/en/pricing"},{"label":"Help Center","href":"https://zeeg.me/en/help"},{"label":"System Status","href":"https://status.zeeg.me"}]},{"header":"Legal","items":[{"label":"Terms of Service","href":"https://zeeg.me/en/legal/terms"},{"label":"Privacy Policy","href":"https://zeeg.me/en/legal/privacy"},{"label":"Imprint","href":"https://zeeg.me/en/legal/imprint"}]}]},"search":{"prompt":"Search endpoints, guides, and more..."},"seo":{"metatags":{"og:site_name":"Zeeg Developer Hub","og:type":"website","og:locale":"en_US","og:url":"https://developer.zeeg.me","twitter:card":"summary_large_image","twitter:site":"@zeeg_me","author":"Zeeg","robots":"index, follow","googlebot":"index, follow"},"indexing":"all"},"fonts":{"family":"Inter"},"icons":{"library":"fontawesome"},"styling":{"eyebrows":"section","latex":false},"integrations":{"gtm":{"tagId":"GTM-5XJGGJP"}},"errors":{"404":{"redirect":false,"title":"Page not found","description":"The page you're looking for doesn't exist. Try the [API Reference](/api/workspaces-teams/check-logged-in-user) or [Quickstart](/quickstart)."}},"contextual":{"options":["copy","view","chatgpt","claude"],"display":"header"},"interaction":{"drilldown":true},"metadata":{"timestamp":true},"markdown":{"schema":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"zeeg","hasAudioNarration":false,"actualSubdomain":"zeeg","customDomains":["developer.zeeg.me"],"gitSource":{"type":"github","owner":"zeeg","repo":"api-docs","deployBranch":"master","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{},"buildId":"6b01a0ee0abeee4b6ea228b5","clientVersion":"0.0.4270","searchFilterCounts":[{"language":"default","tag":"API Reference","count":216},{"language":"default","tag":"CRM","count":27},{"language":"default","tag":"Scheduling Pages","count":19},{"language":"default","tag":"Availability Schedule","count":15},{"language":"default","tag":"Guides","count":14},{"language":"default","tag":"Routing Forms","count":12},{"language":"default","tag":"Workspaces \u0026 Teams","count":12},{"language":"default","tag":"Forms","count":8},{"language":"default","tag":"Documentation","count":8},{"language":"default","tag":"Objects","count":7}],"searchSettings":{"maxResults":10}},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"site-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"control","enabled":true,"payload":{"type":"string","value":"control"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[]}
{"page":{"pagePath":"api/crm/get-a-crm-object","slug":"/api/crm/get-a-crm-object","pageMetadata":{"title":"Get a CRM Object","description":"Retrieve the full schema of a single Zeeg CRM object by slug, including every attribute definition with its type, label, options, and relation metadata","openapi":"GET /crm/objects/{slug}","href":"/api/crm/get-a-crm-object"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Retrieve the full schema of a single Zeeg CRM object by slug, including every attribute definition with its type, label, options, and relation metadata\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={code:`code`,p:`p`,..._provideComponents(),...props.components};return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`Returns the full schema for a single object identified by its slug, including every attribute definition with its type, label, options, and relation metadata.`}),`\n`,_jsxs(_components.p,{children:[`Standard object slugs are always `,_jsx(_components.code,{children:`people`}),` and `,_jsx(_components.code,{children:`companies`}),`. Custom object slugs are set at creation time and are immutable.`]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Get a CRM Object","description":"Retrieve the full schema of a single Zeeg CRM object by slug, including every attribute definition with its type, label, options, and relation metadata","openapi":"GET /crm/objects/{slug}","href":"/api/crm/get-a-crm-object"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"Get a CRM object","tags":["CRM - Objects"],"operationId":"get-crm-object-by-slug","description":"Retrieve the full schema of a single Zeeg CRM object by slug, including every attribute definition with its type, label, options, and relation metadata","security":["9c840f74-e2f4-4c3d-a103-c251d4afb0e8"],"parameters":["2a01bfbc-f148-4ecb-914b-571ef727b07b"],"responses":{"200":"62e5751d-53ca-41e4-a5fa-ff53dd7a1172","401":"7d8d3829-5035-448f-a1f9-599a8eee7543","403":"5ec092e1-3537-4fbc-9ac0-eff793aee271","404":"51f343e6-1701-4b58-a3ac-14b33167d716"},"method":"get","type":"path","servers":["dcff1800-0618-4dfd-b78a-57d290938438"],"path":"/crm/objects/{slug}","baseUrlOptions":["https://api.zeeg.me/v2"],"title":"Get a CRM object","codeSamples":[],"requiredOnlyExamples":true,"requestExampleType":"generated","responseExampleType":"generated","disableProxy":true},"dependencies":{"parameters":{"2a01bfbc-f148-4ecb-914b-571ef727b07b":{"name":"slug","in":"path","required":true,"schema":{"type":"string","example":"people","isRequired":true,"description":"The object slug. Standard objects use `people` and `companies`. Custom objects use the slug you assigned when creating them.","uniqueKey":"","typeLabel":"string"},"description":"The object slug. Standard objects use `people` and `companies`. Custom objects use the slug you assigned when creating them."}},"responses":{"62e5751d-53ca-41e4-a5fa-ff53dd7a1172":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"uniqueKey":"success","typeLabel":"boolean"},"status":{"type":"integer","example":200,"uniqueKey":"status","typeLabel":"integer"},"object":{"type":"object","description":"A CRM object definition including its full attribute schema.","required":["slug","singularName","pluralName","isStandard","isActive","attributes","createdAt","updatedAt"],"properties":{"slug":{"type":"string","description":"Unique identifier for the object. Used in all record API calls.","example":"people","isRequired":true,"uniqueKey":"object.slug","typeLabel":"string"},"singularName":{"type":"string","description":"Singular display name.","example":"Person","isRequired":true,"uniqueKey":"object.singularName","typeLabel":"string"},"pluralName":{"type":"string","description":"Plural display name.","example":"People","isRequired":true,"uniqueKey":"object.pluralName","typeLabel":"string"},"isStandard":{"type":"boolean","description":"`true` for built-in objects (`people`, `companies`). `false` for custom objects.","example":true,"isRequired":true,"uniqueKey":"object.isStandard","typeLabel":"boolean"},"isActive":{"type":"boolean","description":"Whether the object is enabled in the workspace.","example":true,"isRequired":true,"uniqueKey":"object.isActive","typeLabel":"boolean"},"attributes":{"type":"array","description":"Full list of attribute definitions for this object.","items":{"type":"object","description":"Definition of a single attribute on a CRM object.","required":["key","label","type","isRequired","isStandard","isUnique","isArchived","createdAt","updatedAt"],"properties":{"key":{"type":"string","description":"Attribute key used when reading or writing record values.","example":"job_title","isRequired":true,"uniqueKey":"object.attributes.items.[INDEX].key","typeLabel":"string"},"label":{"type":"string","description":"Human-readable label shown in the UI.","example":"Job Title","isRequired":true,"uniqueKey":"object.attributes.items.[INDEX].label","typeLabel":"string"},"type":{"type":"string","description":"Attribute data type. Cannot be changed after creation.","enum":["text","number","phone_number","date","datetime","checkbox","select","multiselect","rating","relation","status","user","currency"],"example":"text","isRequired":true,"uniqueKey":"object.attributes.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"isRequired":{"type":"boolean","description":"Whether a value is required when creating a record.","example":false,"isRequired":true,"uniqueKey":"object.attributes.items.[INDEX].isRequired","typeLabel":"boolean"},"isStandard":{"type":"boolean","description":"`true` for built-in attributes, `false` for custom attributes added by your workspace.","example":false,"isRequired":true,"uniqueKey":"object.attributes.items.[INDEX].isStandard","typeLabel":"boolean"},"isUnique":{"type":"boolean","description":"Whether values must be unique across all records. Applies to `text`, `phone`, and `number` types.","example":false,"isRequired":true,"uniqueKey":"object.attributes.items.[INDEX].isUnique","typeLabel":"boolean"},"isArchived":{"type":"boolean","description":"Whether the attribute is archived. Archived attributes are hidden from the UI but their data is preserved.","example":false,"isRequired":true,"uniqueKey":"object.attributes.items.[INDEX].isArchived","typeLabel":"boolean"},"createdAt":{"type":"string","format":"date-time","description":"ISO 8601 timestamp when the attribute was created.","example":"2025-06-01T10:00:00+00:00","isRequired":true,"uniqueKey":"object.attributes.items.[INDEX].createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"type":"string","format":"date-time","description":"ISO 8601 timestamp when the attribute was last updated.","example":"2025-06-01T10:00:00+00:00","isRequired":true,"uniqueKey":"object.attributes.items.[INDEX].updatedAt","typeLabel":"string\u003cdate-time>"},"options":{"type":"array","description":"Available options. Present only for `select`, `multiselect`, and `status` attributes.","items":{"type":"object","description":"A selectable option for a `select`, `multiselect`, or `status` attribute.","required":["value","color"],"properties":{"value":{"type":"string","description":"The option label shown in the UI and stored as the attribute value.","example":"Active","maxLength":512,"isRequired":true,"uniqueKey":"object.attributes.items.[INDEX].options.items.[INDEX].value","typeLabel":"string"},"color":{"type":"string","description":"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","isRequired":true,"uniqueKey":"object.attributes.items.[INDEX].options.items.[INDEX].color","typeLabel":"string"},"id":{"oneOf":[{"type":"integer","description":"Server-assigned option ID. Omit when adding a new option; include when updating an existing one to preserve it.","example":1,"uniqueKey":"object.attributes.items.[INDEX].options.items.[INDEX].id.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Server-assigned option ID. Omit when adding a new option; include when updating an existing one to preserve it.","example":1,"uniqueKey":"object.attributes.items.[INDEX].options.items.[INDEX].id.oneOf.1","typeLabel":"null"}],"uniqueKey":"object.attributes.items.[INDEX].options.items.[INDEX].id","typeLabel":"integer | null"}},"uniqueKey":"object.attributes.items.[INDEX].options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"object.attributes.items.[INDEX].options","typeLabel":"object[]"},"relatedObjectSlug":{"oneOf":[{"type":"string","description":"Slug of the related object. Present only for `relation` attributes. Immutable after creation.","example":"companies","uniqueKey":"object.attributes.items.[INDEX].relatedObjectSlug.oneOf.0","typeLabel":"string"},{"type":"null","description":"Slug of the related object. Present only for `relation` attributes. Immutable after creation.","example":"companies","uniqueKey":"object.attributes.items.[INDEX].relatedObjectSlug.oneOf.1","typeLabel":"null"}],"uniqueKey":"object.attributes.items.[INDEX].relatedObjectSlug","typeLabel":"string | null"},"relatedObjectLabel":{"oneOf":[{"type":"string","description":"Display label for the relation. Present only for `relation` attributes. Can be updated via PATCH.","example":"Company","uniqueKey":"object.attributes.items.[INDEX].relatedObjectLabel.oneOf.0","typeLabel":"string"},{"type":"null","description":"Display label for the relation. Present only for `relation` attributes. Can be updated via PATCH.","example":"Company","uniqueKey":"object.attributes.items.[INDEX].relatedObjectLabel.oneOf.1","typeLabel":"null"}],"uniqueKey":"object.attributes.items.[INDEX].relatedObjectLabel","typeLabel":"string | null"},"relationType":{"oneOf":[{"type":"string","description":"Cardinality of the relation. Present only for `relation` attributes.","enum":["one_to_one","many_to_one","one_to_many","many_to_many"],"example":"many_to_one","uniqueKey":"object.attributes.items.[INDEX].relationType.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"Cardinality of the relation. Present only for `relation` attributes.","enum":["one_to_one","many_to_one","one_to_many","many_to_many"],"example":"many_to_one","uniqueKey":"object.attributes.items.[INDEX].relationType.oneOf.1","typeLabel":"null"}],"uniqueKey":"object.attributes.items.[INDEX].relationType","typeLabel":"enum\u003cstring> | null"},"isMultipleSelection":{"type":"boolean","description":"`true` when `relationType` is `one_to_many` or `many_to_many`. Present only for `relation` attributes.","example":false,"uniqueKey":"object.attributes.items.[INDEX].isMultipleSelection","typeLabel":"boolean"},"currency":{"oneOf":[{"type":"string","description":"ISO 4217 currency code. Present only for `currency` attributes. Immutable after creation.","example":"EUR","uniqueKey":"object.attributes.items.[INDEX].currency.oneOf.0","typeLabel":"string"},{"type":"null","description":"ISO 4217 currency code. Present only for `currency` attributes. Immutable after creation.","example":"EUR","uniqueKey":"object.attributes.items.[INDEX].currency.oneOf.1","typeLabel":"null"}],"uniqueKey":"object.attributes.items.[INDEX].currency","typeLabel":"string | null"},"currencyDisplay":{"oneOf":[{"type":"string","description":"How the currency value is displayed. Present only for `currency` attributes.","enum":["code","name","symbol"],"example":"symbol","uniqueKey":"object.attributes.items.[INDEX].currencyDisplay.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"How the currency value is displayed. Present only for `currency` attributes.","enum":["code","name","symbol"],"example":"symbol","uniqueKey":"object.attributes.items.[INDEX].currencyDisplay.oneOf.1","typeLabel":"null"}],"uniqueKey":"object.attributes.items.[INDEX].currencyDisplay","typeLabel":"enum\u003cstring> | null"},"currencyDecimal":{"oneOf":[{"type":"boolean","description":"Whether decimal places are shown. Present only for `currency` attributes.","example":true,"uniqueKey":"object.attributes.items.[INDEX].currencyDecimal.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Whether decimal places are shown. Present only for `currency` attributes.","example":true,"uniqueKey":"object.attributes.items.[INDEX].currencyDecimal.oneOf.1","typeLabel":"null"}],"uniqueKey":"object.attributes.items.[INDEX].currencyDecimal","typeLabel":"boolean | null"},"currencyGrouping":{"oneOf":[{"type":"boolean","description":"Whether a thousands separator is used. Present only for `currency` attributes.","example":true,"uniqueKey":"object.attributes.items.[INDEX].currencyGrouping.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Whether a thousands separator is used. Present only for `currency` attributes.","example":true,"uniqueKey":"object.attributes.items.[INDEX].currencyGrouping.oneOf.1","typeLabel":"null"}],"uniqueKey":"object.attributes.items.[INDEX].currencyGrouping","typeLabel":"boolean | null"}},"uniqueKey":"object.attributes.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"object.attributes","typeLabel":"object[]"},"createdAt":{"type":"string","format":"date-time","example":"2025-01-15T09:00:00+00:00","isRequired":true,"uniqueKey":"object.createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"type":"string","format":"date-time","example":"2025-06-01T12:00:00+00:00","isRequired":true,"uniqueKey":"object.updatedAt","typeLabel":"string\u003cdate-time>"},"titleAttribute":{"type":"string","description":"Key of the attribute a record is named by, and that `search` matches on the records list. `id` until you set another one.","example":"name","uniqueKey":"object.titleAttribute","typeLabel":"string"}},"uniqueKey":"object","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Standard object (people)":{"title":"Standard object (people)","value":{"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,"isUnique":false,"isArchived":false},{"key":"last_name","label":"Last Name","type":"text","isRequired":false,"isStandard":true,"isUnique":false,"isArchived":false},{"key":"emails","label":"Emails","type":"text","isRequired":false,"isStandard":true,"isUnique":true,"isArchived":false},{"key":"phone_number","label":"Phone Number","type":"phone_number","isRequired":false,"isStandard":true,"isUnique":false,"isArchived":false},{"key":"job_title","label":"Job Title","type":"text","isRequired":false,"isStandard":true,"isUnique":false,"isArchived":false},{"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"}}},"Custom object":{"title":"Custom object","value":{"success":true,"status":200,"object":{"slug":"products","singularName":"Product","pluralName":"Products","isStandard":false,"isActive":true,"attributes":[{"key":"title","label":"Title","type":"text","isRequired":true,"isStandard":false},{"key":"price","label":"Price","type":"currency","isRequired":false,"isStandard":false},{"key":"inventory_count","label":"Inventory Count","type":"number","isRequired":false,"isStandard":false},{"key":"assigned_person","label":"Assigned Person","type":"relation","isRequired":false,"isStandard":false,"relatedObjectSlug":"people","isMultipleSelection":false}],"createdAt":"2025-03-10T08:00:00+00:00","updatedAt":"2025-03-10T08:00:00+00:00"}}}},"exampleType":"examples"}},"exampleType":"examples"},"7d8d3829-5035-448f-a1f9-599a8eee7543":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Unauthenticated.","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Unauthenticated":{"title":"Unauthenticated","value":{"message":"Unauthenticated."}}},"exampleType":"examples"}},"exampleType":"examples"},"5ec092e1-3537-4fbc-9ac0-eff793aee271":{"description":"Forbidden — CRM not enabled or missing scope","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","uniqueKey":"error.type","typeLabel":"string"},"message":{"type":"string","uniqueKey":"error.message","typeLabel":"string"},"error_id":{"type":"string","uniqueKey":"error.error_id","typeLabel":"string"},"required_scopes":{"type":"array","items":{"type":"string","uniqueKey":"error.required_scopes.items.[INDEX]","typeLabel":"string"},"uniqueKey":"error.required_scopes","typeLabel":"string[]"}},"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Missing scope":{"title":"Missing scope","value":{"error":{"type":"insufficient_scope","message":"Your token is missing the required scope(s). Include at least one of: crm:read, crm:write.","error_id":"04cb3705-1db2-4836-80b4-93e6b7354bc6","required_scopes":["crm:read","crm:write"]}}}},"exampleType":"examples"}},"exampleType":"examples"},"51f343e6-1701-4b58-a3ac-14b33167d716":{"description":"Object not found","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","uniqueKey":"success","typeLabel":"boolean"},"message":{"type":"string","uniqueKey":"message","typeLabel":"string"},"status":{"type":"integer","uniqueKey":"status","typeLabel":"integer"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Not found":{"title":"Not found","value":{"success":false,"message":"Object not found.","status":404}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"9c840f74-e2f4-4c3d-a103-c251d4afb0e8":{"bearer":{"type":"http","scheme":"bearer","description":"","scopes":[],"schemeName":"bearer"}}},"servers":{"dcff1800-0618-4dfd-b78a-57d290938438":{"url":"https://api.zeeg.me/v2","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"","scopes":[],"schemeName":"bearer"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearer","name":"Authorization"}],"title":"bearer"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"zeeg","siteName":"Zeeg Developer Hub","title":"Get a CRM Object - Zeeg Developer Hub","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-06-11T13:33:54.818Z","gitLastModified":"2026-06-11T13:33:37.000Z","originalFileLocation":"api/crm/get-a-crm-object.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Retrieve the full schema of a single Zeeg CRM object by slug, including every attribute definition with its type, label, options, and relation metadata\">\u003cmeta data-mint-head name=\"application-name\" content=\"Zeeg Developer Hub\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003cmeta data-mint-head name=\"robots\" content=\"index, follow\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/zeeg/ghjkS0QJHhQPDpab/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/zeeg/ghjkS0QJHhQPDpab/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/zeeg/ghjkS0QJHhQPDpab/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/zeeg/ghjkS0QJHhQPDpab/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/zeeg/ghjkS0QJHhQPDpab/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/zeeg/ghjkS0QJHhQPDpab/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/zeeg/ghjkS0QJHhQPDpab/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/zeeg/ghjkS0QJHhQPDpab/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/zeeg/ghjkS0QJHhQPDpab/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get a CRM Object - Zeeg Developer Hub\">\u003cmeta data-mint-head property=\"og:description\" content=\"Retrieve the full schema of a single Zeeg CRM object by slug, including every attribute definition with its type, label, options, and relation metadata\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Zeeg Developer Hub\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://developer.zeeg.me/api/crm/get-a-crm-object\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://zeeg.mintlify.site/_mintlify/api/og/v2?division=Objects\u0026amp;title=Get+a+CRM+Object\u0026amp;description=Retrieve+the+full+schema+of+a+single+Zeeg+CRM+object+by+slug%2C+including+every+attribute+definition+with+its+type%2C+label%2C+options%2C+and+relation+metadata\u0026amp;theme=902e11371c50c4af37ea8b4f\u0026amp;signature=7f00d367fd91e6c655a7ccbf0f0a6c4e6f638de55905e7c26e0f0d765c36ee26\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Get a CRM Object - Zeeg Developer Hub\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Retrieve the full schema of a single Zeeg CRM object by slug, including every attribute definition with its type, label, options, and relation metadata\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://zeeg.mintlify.site/_mintlify/api/og/v2?division=Objects\u0026amp;title=Get+a+CRM+Object\u0026amp;description=Retrieve+the+full+schema+of+a+single+Zeeg+CRM+object+by+slug%2C+including+every+attribute+definition+with+its+type%2C+label%2C+options%2C+and+relation+metadata\u0026amp;theme=902e11371c50c4af37ea8b4f\u0026amp;signature=7f00d367fd91e6c655a7ccbf0f0a6c4e6f638de55905e7c26e0f0d765c36ee26\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/zeeg/ghjkS0QJHhQPDpab/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Zeeg Developer Hub\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#6C63FF\">\u003cmeta data-mint-head name=\"og:locale\" content=\"en_US\">\u003cmeta data-mint-head name=\"author\" content=\"Zeeg\">\u003cmeta data-mint-head name=\"googlebot\" content=\"index, follow\">\u003clink data-mint-head rel=\"canonical\" href=\"https://developer.zeeg.me/api/crm/get-a-crm-object\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api/crm/get-a-crm-object.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://developer.zeeg.me/#organization\",\"name\":\"Zeeg Developer Hub\",\"url\":\"https://developer.zeeg.me\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/zeeg/9voKLLkajreclhp4/images/Zeeglogo(Original).svg?fit=max\u0026auto=format\u0026n=9voKLLkajreclhp4\u0026q=85\u0026s=321632804eda4b3cff044941f9ccadda\"}},{\"@type\":\"WebSite\",\"@id\":\"https://developer.zeeg.me#website\",\"name\":\"Zeeg Developer Hub\",\"url\":\"https://developer.zeeg.me\",\"publisher\":{\"@id\":\"https://developer.zeeg.me/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://developer.zeeg.me/api/crm/get-a-crm-object#webpage\",\"url\":\"https://developer.zeeg.me/api/crm/get-a-crm-object\",\"name\":\"Get a CRM Object\",\"description\":\"Retrieve the full schema of a single Zeeg CRM object by slug, including every attribute definition with its type, label, options, and relation metadata\",\"dateModified\":\"2026-06-11T13:33:37.000Z\",\"isPartOf\":{\"@id\":\"https://developer.zeeg.me#website\"},\"breadcrumb\":{\"@id\":\"https://developer.zeeg.me/api/crm/get-a-crm-object#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://developer.zeeg.me/api/crm/get-a-crm-object#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API Reference\",\"item\":\"https://developer.zeeg.me/api/scheduled-events/list-scheduled-events\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"CRM\",\"item\":\"https://developer.zeeg.me/api/crm/overview\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Objects\",\"item\":\"https://developer.zeeg.me/api/crm/list-crm-objects\"},{\"@type\":\"ListItem\",\"position\":4,\"name\":\"Get a CRM Object\",\"item\":\"https://developer.zeeg.me/api/crm/get-a-crm-object\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://developer.zeeg.me/api/crm/get-a-crm-object#apireference\",\"headline\":\"Get a CRM Object\",\"name\":\"Get a CRM Object\",\"description\":\"Retrieve the full schema of a single Zeeg CRM object by slug, including every attribute definition with its type, label, options, and relation metadata\",\"url\":\"https://developer.zeeg.me/api/crm/get-a-crm-object\",\"mainEntityOfPage\":{\"@id\":\"https://developer.zeeg.me/api/crm/get-a-crm-object#webpage\"},\"dateModified\":\"2026-06-11T13:33:37.000Z\",\"publisher\":{\"@id\":\"https://developer.zeeg.me/#organization\"},\"isPartOf\":{\"@id\":\"https://developer.zeeg.me#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Zeeg Developer Hub\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Zeeg Developer Hub\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api/crm/get-a-crm-object.md","siteName":"Zeeg Developer Hub","nav":{"global":null,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/introduction"}]},{"tab":"Guides","pages":[{"title":"Guides","href":"/guides/booking-flow"}]},{"tab":"API Reference","groups":[{"group":"API Reference","pages":[{"group":"Scheduled Events","expanded":false,"pages":[{"title":"List Scheduled Events","openapi":"GET /scheduled-events","href":"/api/scheduled-events/list-scheduled-events"},{"title":"Get a Scheduled Event","openapi":"GET /scheduled-events/{uuid}","href":"/api/scheduled-events/get-a-scheduled-event"},{"title":"Get Reschedule Availability","openapi":"GET /scheduled-events/{uuid}/reschedule-availability","href":"/api/scheduled-events/get-reschedule-availability"},{"title":"Reschedule a Scheduled Event","openapi":"PUT /scheduled-events/{uuid}/reschedule","href":"/api/scheduled-events/reschedule-a-scheduled-event"},{"title":"Cancel a Scheduled Event","openapi":"PUT /scheduled-events/{uuid}/cancel","href":"/api/scheduled-events/cancel-a-scheduled-event"},{"title":"Cancel a Scheduled Invitee","openapi":"PUT /scheduled-invitees/{uuid}/cancel","href":"/api/scheduled-events/cancel-a-scheduled-invitee"},{"title":"Handover a Scheduled Event","openapi":"PUT /scheduled-events/{uuid}/handover","href":"/api/scheduled-events/handover-a-scheduled-event"}]},{"group":"Scheduling Pages","expanded":false,"pages":[{"title":"List Scheduling Pages","openapi":"GET /event-types","href":"/api/scheduling-pages/list-scheduling-pages"},{"title":"Get a Scheduling Page","openapi":"GET /event-types/{uuid}","href":"/api/scheduling-pages/get-a-scheduling-page"},{"title":"Create a Scheduling Page","openapi":"POST /event-types","href":"/api/scheduling-pages/create-a-scheduling-page"},{"title":"Update a Scheduling Page","openapi":"PATCH /event-types/{uuid}","href":"/api/scheduling-pages/update-a-scheduling-page"},{"title":"Duplicate a Scheduling Page","openapi":"POST /event-types/{uuid}/duplicate","href":"/api/scheduling-pages/duplicate-a-scheduling-page"},{"title":"Delete a Scheduling Page","openapi":"DELETE /event-types/{uuid}","href":"/api/scheduling-pages/delete-a-scheduling-page"},{"title":"Get Scheduling Page Questions","openapi":"GET /event-types/{uuid}/questions","href":"/api/scheduling-pages/get-scheduling-page-questions"},{"title":"Replace Scheduling Page Questions","openapi":"PUT /event-types/{uuid}/questions","href":"/api/scheduling-pages/replace-scheduling-page-questions"},{"title":"Get Scheduling Page Notifications","openapi":"GET /event-types/{uuid}/notifications","href":"/api/scheduling-pages/get-scheduling-page-notifications"},{"title":"Update Scheduling Page Notifications","openapi":"PATCH /event-types/{uuid}/notifications","href":"/api/scheduling-pages/update-scheduling-page-notifications"},{"title":"Toggle Scheduling Page Status","openapi":"PUT /event-types/{uuid}/status","href":"/api/scheduling-pages/toggle-scheduling-page-status"},{"title":"List Event Page Dates","openapi":"GET /event-types/{uuid}/sessions","href":"/api/scheduling-pages/list-event-page-dates"},{"title":"Add Event Page Dates","openapi":"POST /event-types/{uuid}/sessions","href":"/api/scheduling-pages/add-event-page-dates"},{"title":"Change an Event Page Date","openapi":"PUT /event-types/{uuid}/sessions/{sessionUuid}","href":"/api/scheduling-pages/update-an-event-page-date"},{"title":"Remove an Event Page Date","openapi":"DELETE /event-types/{uuid}/sessions/{sessionUuid}","href":"/api/scheduling-pages/delete-an-event-page-date"},{"title":"Get a Single-Use Scheduling Link","openapi":"GET /event-types/{uuid}/single-use-link","href":"/api/scheduling-pages/get-a-single-use-scheduling-link"},{"title":"Get Available Time Slots","openapi":"GET /availability/{ownerSlug}/event-types/{eventTypeSlug}","href":"/api/scheduling-pages/get-available-time-slots"},{"title":"Get Available Time Slots by ID","openapi":"GET /event-types/{uuid}/availability","href":"/api/scheduling-pages/get-available-time-slots-by-id"},{"title":"Create an Event","openapi":"POST /event","href":"/api/scheduling-pages/create-an-event"}]},{"group":"Availability Schedule","expanded":false,"pages":[{"title":"Get All Availability Schedules","openapi":"GET /schedules","href":"/api/availability/get-all-availability-schedules"},{"title":"Get Default Availability Schedule","openapi":"GET /schedules/default","href":"/api/availability/get-default-availability-schedule"},{"title":"Update Default Availability Schedule","openapi":"PATCH /schedules/default","href":"/api/availability/update-default-availability-schedule"},{"title":"Get Availability Schedule by UUID","openapi":"GET /schedules/{uuid}","href":"/api/availability/get-availability-schedule-by-uuid"},{"title":"Update Availability Schedule by UUID","openapi":"PATCH /schedules/{uuid}","href":"/api/availability/update-availability-schedule-by-uuid"},{"title":"List Time-Off Periods","openapi":"GET /time-off","href":"/api/availability/list-time-off-periods"},{"title":"Create Time-Off Periods","openapi":"POST /time-off","href":"/api/availability/create-time-off-periods"},{"title":"Update Time-Off Period","openapi":"PATCH /time-off/{uuid}","href":"/api/availability/update-time-off-period"},{"title":"Delete Time-Off Period","openapi":"DELETE /time-off/{uuid}","href":"/api/availability/delete-time-off-period"},{"title":"List Holiday Categories","openapi":"GET /holidays/categories","href":"/api/holidays/list-holiday-categories"},{"title":"Preview Holidays for a Category","openapi":"GET /holidays/preview","href":"/api/holidays/preview-holidays"},{"title":"List Holiday Subscriptions","openapi":"GET /holidays/subscriptions","href":"/api/holidays/list-holiday-subscriptions"},{"title":"Create Holiday Subscriptions","openapi":"POST /holidays/subscriptions","href":"/api/holidays/create-holiday-subscriptions"},{"title":"Delete a Holiday Subscription","openapi":"DELETE /holidays/subscriptions/{id}","href":"/api/holidays/delete-holiday-subscription"},{"title":"Toggle Holiday Overrides","openapi":"PUT /holidays/subscriptions/{id}/overrides","href":"/api/holidays/toggle-holiday-overrides"}]},{"group":"Webhooks","expanded":false,"pages":[{"title":"Create Webhook Subscription","openapi":"POST /webhooks","href":"/api/webhooks/create-webhook-subscription"},{"title":"List Webhook Subscriptions","openapi":"GET /webhooks/scope/{scope}","href":"/api/webhooks/list-webhook-subscriptions"},{"title":"Get Webhook Subscription","openapi":"GET /webhooks/{uuid}","href":"/api/webhooks/get-webhook-subscription"},{"title":"Delete Webhook Subscription","openapi":"DELETE /webhooks/{uuid}","href":"/api/webhooks/delete-webhook-subscription"}]},{"group":"Notes","expanded":false,"pages":[{"title":"Create a Note","openapi":"POST /notes","href":"/api/notes/create-a-note"},{"title":"List Notes by Event","openapi":"GET /notes/event/{uuid}","href":"/api/notes/list-notes-by-event"},{"title":"Get a Note","openapi":"GET /notes/{id}","href":"/api/notes/get-a-note"},{"title":"Update a Note","openapi":"PUT /notes/{id}","href":"/api/notes/update-a-note"},{"title":"Delete a Note","openapi":"DELETE /notes/{id}","href":"/api/notes/delete-a-note"}]},{"group":"Workspaces \u0026 Teams","expanded":false,"pages":[{"title":"Check Logged-in User","openapi":"GET /whoami","href":"/api/workspaces-teams/check-logged-in-user"},{"title":"List Users in a Workspace","openapi":"GET /organizations/users","href":"/api/workspaces-teams/list-users-in-a-workspace"},{"title":"List Teams","openapi":"GET /teams","href":"/api/workspaces-teams/list-teams"},{"title":"Create a Team","openapi":"POST /teams","href":"/api/workspaces-teams/create-a-team"},{"title":"Update a Team","openapi":"PATCH /teams/{teamId}","href":"/api/workspaces-teams/update-a-team"},{"title":"Delete a Team","openapi":"DELETE /teams/{teamId}","href":"/api/workspaces-teams/delete-a-team"},{"title":"List Team Members","openapi":"GET /teams/{teamId}/members","href":"/api/workspaces-teams/list-team-members"},{"title":"Add a Team Member","openapi":"POST /teams/{teamId}/members","href":"/api/workspaces-teams/add-a-team-member"},{"title":"Remove a Team Member","openapi":"DELETE /teams/{teamId}/members/{memberId}","href":"/api/workspaces-teams/remove-a-team-member"},{"title":"Invite People to the Workspace","openapi":"POST /organizations/invitations","href":"/api/workspaces-teams/invite-people"},{"title":"List Pending Invitations","openapi":"GET /organizations/invitations","href":"/api/workspaces-teams/list-invitations"},{"title":"Revoke an Invitation","openapi":"DELETE /organizations/invitations/{invitationId}","href":"/api/workspaces-teams/revoke-an-invitation"}]},{"group":"AI Agent","expanded":false,"pages":[{"title":"Create Outbound Call","openapi":"POST /agents/{agentUuid}/outbound-calls","href":"/api/ai-agent/create-outbound-call"},{"title":"List AI Agents","openapi":"GET /agents","href":"/api/ai-agent/list-agents"},{"title":"List Agent Calls","openapi":"GET /agents/{agentUuid}/calls","href":"/api/ai-agent/list-agent-calls"},{"title":"Get Agent Call","openapi":"GET /agent-calls/{callId}","href":"/api/ai-agent/get-agent-call"}]},{"group":"Webhook Payloads","expanded":false,"pages":[{"title":"Event Webhook Payload","href":"/api/webhook-payloads/event-webhook-payload"},{"title":"Routing Form Webhook Payload","href":"/api/webhook-payloads/routing-form-webhook-payload"},{"title":"AI Agent Call Webhook Payload","href":"/api/webhook-payloads/ai-agent-call-webhook-payload"}]},{"group":"CRM","expanded":false,"pages":[{"title":"CRM Overview","href":"/api/crm/overview"},{"group":"Objects","pages":[{"title":"List CRM Objects","description":"Retrieve every CRM object in your Zeeg workspace with full attribute schemas, including standard people and companies plus any custom objects you created","openapi":"GET /crm/objects","href":"/api/crm/list-crm-objects"},{"title":"Get a CRM Object","openapi":"GET /crm/objects/{slug}","href":"/api/crm/get-a-crm-object"},{"title":"Create a CRM Object","description":"Create a custom CRM object in your Zeeg workspace with a unique, immutable slug. Each new object gets id, created_at, and updated_at system attributes.","openapi":"POST /crm/objects","href":"/api/crm/create-a-crm-object"},{"title":"Update a CRM Object","openapi":"PATCH /crm/objects/{slug}","href":"/api/crm/update-a-crm-object"},{"title":"Delete a CRM Object","openapi":"DELETE /crm/objects/{slug}","href":"/api/crm/delete-a-crm-object"},{"title":"Add Attribute to CRM Object","openapi":"POST /crm/objects/{slug}/attributes","href":"/api/crm/add-attribute-to-crm-object"},{"title":"Update CRM Object Attribute","openapi":"PATCH /crm/objects/{slug}/attributes/{attributeKey}","href":"/api/crm/update-crm-object-attribute"}]},{"group":"Companies","pages":[{"title":"List CRM Companies","openapi":"GET /crm/companies","href":"/api/crm/list-crm-companies"},{"title":"Get a CRM Company","openapi":"GET /crm/companies/{id}","href":"/api/crm/get-a-crm-company"},{"title":"Create a CRM Company","openapi":"POST /crm/companies","href":"/api/crm/create-a-crm-company"},{"title":"Assert a CRM Company","openapi":"PUT /crm/companies","href":"/api/crm/assert-a-crm-company"},{"title":"Patch a CRM Company","openapi":"PATCH /crm/companies/{id}","href":"/api/crm/patch-a-crm-company"},{"title":"Delete a CRM Company","openapi":"DELETE /crm/companies/{id}","href":"/api/crm/delete-a-crm-company"}]},{"group":"People","pages":[{"title":"List CRM People","openapi":"GET /crm/people","href":"/api/crm/list-crm-people"},{"title":"Get a CRM Person","openapi":"GET /crm/people/{id}","href":"/api/crm/get-a-crm-person"},{"title":"Create a CRM Person","openapi":"POST /crm/people","href":"/api/crm/create-a-crm-person"},{"title":"Assert a CRM Person","openapi":"PUT /crm/people","href":"/api/crm/update-a-crm-person"},{"title":"Patch a CRM Person","openapi":"PATCH /crm/people/{id}","href":"/api/crm/patch-a-crm-person"},{"title":"Delete a CRM Person","openapi":"DELETE /crm/people/{id}","href":"/api/crm/delete-a-crm-person"}]},{"group":"Records","pages":[{"title":"List CRM Records","openapi":"GET /crm/{objectSlug}","href":"/api/crm/list-crm-records"},{"title":"Get a CRM Record","openapi":"GET /crm/{objectSlug}/{recordId}","href":"/api/crm/get-a-crm-record"},{"title":"Create a CRM Record","openapi":"POST /crm/{objectSlug}","href":"/api/crm/create-a-crm-record"},{"title":"Assert a CRM Record (Upsert)","openapi":"PUT /crm/{objectSlug}","href":"/api/crm/assert-a-crm-record"},{"title":"Patch a CRM Record","openapi":"PATCH /crm/{objectSlug}/{recordId}","href":"/api/crm/patch-a-crm-record"},{"title":"Delete a CRM Record","openapi":"DELETE /crm/{objectSlug}/{recordId}","href":"/api/crm/delete-a-crm-record"},{"title":"Update a CRM Record Relation","openapi":"PATCH /crm/{objectSlug}/{recordId}/relation","href":"/api/crm/update-relation-crm-record"}]}]},{"group":"Routing Forms","expanded":false,"pages":[{"title":"Routing Forms Overview","href":"/api/routing-forms/overview"},{"group":"Forms","pages":[{"title":"List Routing Forms","openapi":"GET /routing-forms","href":"/api/routing-forms/list-routing-forms"},{"title":"Get a Routing Form","openapi":"GET /routing-forms/{id}","href":"/api/routing-forms/get-a-routing-form"},{"title":"Create a Routing Form","openapi":"POST /routing-forms","href":"/api/routing-forms/create-a-routing-form"},{"title":"Update a Routing Form","openapi":"PATCH /routing-forms/{id}","href":"/api/routing-forms/update-a-routing-form"},{"title":"Duplicate a Routing Form","openapi":"POST /routing-forms/{id}/duplicate","href":"/api/routing-forms/duplicate-a-routing-form"},{"title":"Replace Routing Form Questions","openapi":"PUT /routing-forms/{id}/inputs","href":"/api/routing-forms/replace-routing-form-questions"},{"title":"Replace Routing Form Routes","openapi":"PUT /routing-forms/{id}/routes","href":"/api/routing-forms/replace-routing-form-routes"},{"title":"Delete a Routing Form","openapi":"DELETE /routing-forms/{id}","href":"/api/routing-forms/delete-a-routing-form"}]},{"group":"Submissions","pages":[{"title":"List Routing Form Submissions","openapi":"GET /routing-form-submissions","href":"/api/routing-forms/list-routing-form-submissions"},{"title":"Get a Routing Form Submission","openapi":"GET /routing-form-submissions/{id}","href":"/api/routing-forms/get-a-routing-form-submission"},{"title":"Delete a Routing Form Submission","openapi":"DELETE /routing-form-submissions/{id}","href":"/api/routing-forms/delete-a-routing-form-submission"}]}]}]}]}]},"basePath":"","title":"Get a CRM Object - Zeeg Developer Hub","deploymentId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","buildId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","dynamics":["c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["OpenApiReferenceProvider-CiUHMMOm.js","snippetPresets-BgfXU7Bw.js","utils-DWvOwgy_.js","style-to-object-BY3JEAdk.js","utils-BN7RXSMJ.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-CFw8bq89.js","conditional-requirements-CFM0id0Q.js","cloneDeep-CAwdfOU2.js","_Uint8Array-BJr8e-ZL.js","isObject-FP1Yky1u.js","Page-CVJ-f_k1.js","CodeSnippet-D_HwgQO_.js","DynamicMarkdown-CQM9Bhbv.js","SectionHeading-DpbrP8nQ.js","icon-BPCgijHy.js","ApiExamples-XX0UgMZK.js","usePlaygroundInputsStore-DXDFSa1V.js","shallow-CdX5aREi.js","isEqual-CoOaxexF.js","CodeSnippets-Cg2wpzWm.js","getApiPlaygroundDisplay-CmCoerhe.js","MethodPill-GQ8DuY0c.js","getPastedJson-Cb5mT31m.js","Check2Icon-a7bUI6e8.js","axios-CsQoIw0U.js","Markdown-CX2QY19L.js","AssistantPageLink-CY3bFglh.js","dist-Dl6_zDnT.js","lib-DMeTj1gb.js","lib-B8HbPgcC.js","katex-Dbtb6Wk7.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js"]}