Sign in

v1

latestOpenAPI 3.1.02026-08-04253331435.1 KB
CRM Automation Push

Get Custom Object Schema Spec

Return the full, static definition of a NationGraph custom object schema.

This is the source of truth for manual-setup instructions when a custom object must be created by hand .

get/api/v3/crm/{integration_id}/custom-object-schemas/{schema_key}/spec

Path parameters

integration_idstring uuid required

The CRM integration ID

The CRM integration ID

schema_keystring required

Schema identifier (e.g. 'vendor_contract')

Schema identifier (e.g. 'vendor_contract')

Response

Successful Response

schema_keystring required
providerstring required
object_internal_namestring required

Exact internal name the custom object must have

singular_labelstring required
plural_labelstring required
associate_to_companyboolean required

Whether the object must be associated to the Company object