Sign in

v1

latestOpenAPI 3.1.02026-08-04253331435.1 KB
CRM Automation Push

Check Custom Object Schema

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.

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

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

existsboolean required

Whether the custom object schema exists

schema_keystring required

The schema key that was checked

providerstring required

CRM provider (hubspot or salesforce)

object_type_idstring nullable

Provider-specific object type identifier (e.g. HubSpot objectTypeId or Salesforce API name)

missing_fieldsstring[]

Schema fields not found on the existing CRM object

company_association_existsboolean

Whether a Company association is defined on the object, defaults to True for providers/schemas where it does not apply.