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

Request

Base URL
https://api.nationgraph.com (the document declares no server; this is the origin it was published from)
Auth
HTTP bearer
TypeScript
https://skmtc.dev/nationgraph/apis/nationgraph-api/docs/api/v3/crm/:integration_id/custom-object-schemas/:schema_key/spec/get.ts
A function with typed inputs. Its response is checked against the schema.

integration_idstring uuid required

The CRM integration ID

schema_keystring required

Schema identifier (e.g. 'vendor_contract')

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

No recorded changes to this operation across all 1 revision of this API.