Metadata API

The Metadata API provides a seamless way to view and manage custom fields (metadata) on unified objects.

Use it to list, create, and update custom field definitions for a connection — including each field's name, slug, format, and the unified object type it applies to. The associated objects then expose those custom fields in a metadata array.

Supported objects

Custom fields are available on the following unified objects:

CRM

• Companies (crm_company)
• Contacts (crm_contact)
• Deals (crm_deal)
• Leads (crm_lead)

ATS

• Activities (ats_activity)
• Applications (ats_application)
• Candidates (ats_candidate)
• Companies (ats_company)
• Jobs (ats_job)

HRIS

• Employees (hris_employee)

Commerce

• Collections (commerce_collection)
• Items (commerce_item), including item media
• Item variants (commerce_itemvariant)
• Reviews (commerce_review), including review comments

KMS

• Pages (kms_page)

Task

• Projects (task_project)
• Tasks (task_task)

CDP

• Events (cdp_event)
• Profiles (cdp_profile)

Custom field values

On those objects, metadata is an array of custom field values. For example, a CRM contact:

{
  "id": "contact1",
  "name": "Jane Doe",
  "metadata": [
    {
      "slug": "industry",
      "value": "Software",
      "format": "TEXT"
    }
  ]
}

Custom field definitions

The Metadata object_type field identifies the unified object the custom field belongs to (for example, crm_contact or commerce_item).

The Metadata objects field maps unified object types to arrays of IDs associated with those objects. For example:

{
  "objects": {
    "crm_contact": ["contact1", "contact2"],
    "ats_candidate": ["candidate1"],
    "commerce_item": ["item1", "item2"]
  }
}