---
title: "Get Custom Object Schema Spec"
method: GET
path: "/api/v3/crm/{integration_id}/custom-object-schemas/{schema_key}/spec"
tags: ["CRM Automation Push"]
---

# Get Custom Object Schema Spec

`GET /api/v3/crm/{integration_id}/custom-object-schemas/{schema_key}/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 .

## Path parameters

- `integration_id` string, uuid, required — The CRM integration ID
- `schema_key` string, required — Schema identifier (e.g. 'vendor_contract')

## Response `200`

Successful Response

- CustomObjectSchemaSpecResponse — Full, static definition of a custom object for manual setup instructions.
  - `schema_key` string, required
  - `provider` string, required
  - `object_internal_name` string, required — Exact internal name the custom object must have
  - `singular_label` string, required
  - `plural_label` string, required
  - `associate_to_company` boolean, required — Whether the object must be associated to the Company object
  - `fields` CustomObjectFieldSpec[], required
    - `internal_name` string, required — Exact internal name the property must have
    - `label` string, required — Human-readable label to type
    - `field_type_label` string, required — HubSpot UI wording for the field type
    - `is_primary_display` boolean, required — Whether this property is the object's primary display property

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.dev/nationgraph/apis/nationgraph-api.md) · [All operations](https://skmtc.dev/nationgraph/apis/nationgraph-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/nationgraph/nationgraph-api/revisions/85804e68d86d/schema)