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

# Check Custom Object Schema

`GET /api/v3/crm/{integration_id}/custom-object-schemas/{schema_key}`

Check whether a custom object schema exists in the user's CRM.

The `schema_key` determines which NationGraph schema definition to check for.
Currently supported schemas:
- **`vendor_contract`**: NationGraph Vendor Contract custom object

Returns whether the object exists, its provider-specific identifier, and
any expected fields that are missing from the existing object.

## 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

- CustomObjectSchemaStatusResponse — Response describing whether a custom object schema exists in the CRM.
  - `exists` boolean, required — Whether the custom object schema exists
  - `schema_key` string, required — The schema key that was checked
  - `provider` string, required — CRM provider (hubspot or salesforce)
  - `object_type_id` string, nullable — Provider-specific object type identifier (e.g. HubSpot objectTypeId or Salesforce API name)
  - `missing_fields` string[] — Schema fields not found on the existing CRM object
  - `company_association_exists` boolean — Whether a Company association is defined on the object, defaults to True for providers/schemas where it does not apply.

## 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)