Skip to main content

​
Not Supported Yet

This page lists common expectations that are not part of the current Public API v2 surface.

​
Versioned date paths

Use /api/v2, not date-versioned paths. 
Supported:     /api/v2/contact
Not supported: /api/2026-05/contact

​
Query, assert, and schema path names

Use the underscore-prefixed route names. 
Supported:     /api/v2/contact/_query
Supported:     /api/v2/contact/_assert
Supported:     /api/v2/_schema/contact

Not supported: /api/v2/contact/query
Not supported: /api/v2/contact/assert
Not supported: /api/v2/objects/contact/schema

​
Record types not exposed today

These record types are not available as Public API v2 record routes today:
  • comment
  • user
  • team
  • email_thread
  • email_message
  • voice_call
  • canonical junction record types such as contact_account_role and contact_opportunity_role
Some of these may still appear as record_reference targets inside other records. That does not mean they are readable or writable as top-level Public API v2 records.

​
Canonical junction endpoints

Create and manage relationship edges through parent-scoped relationship endpoints instead of canonical junction record endpoints. 
Supported:
/api/v2/contact/{contact_id}/relationship/accounts
/api/v2/account/{account_id}/relationship/contacts

Not supported:
/api/v2/contact_account_role

​
Generic attribute item reads

Public API v2 supports selected attribute sub-resources, such as contact emails, contact phone numbers, and account domains. It does not expose a generic item-level GET surface for every array attribute.

​
Batched relationship writes

Public API v2 does not expose a single endpoint that writes multiple relationship names at once with partial-failure metadata. Use the parent-scoped relationship endpoints for one relationship at a time.

​
Custom object limitations

Custom objects can be created, read, queried, updated, archived, connected through relationships, and inspected through GET /api/v2/_schema/{record_type}. The unsupported case is using a generic /api/v2/custom_object/_schema endpoint to discover every custom object type at once.

​
Public source of truth

Use this knowledge base and the generated OpenAPI reference as the public source of truth.