Contacts

Contacts are organizations or customers and are the parent of addresses, address users, projects, devices, and contracts.

Identifiers and provider fields

Resource paths accept a record ID or the record's external identifier. External identifiers are opaque strings assigned by the source system. Provider-specific fields use the custom-field group configured through Custom Fields & Mappings.

Use JSON Schemas to retrieve the current request fields and validation constraints instead of relying on a frozen field list in a client.

List contacts

Required scope: contacts:read. Supports shared collection filtering, relation loading, limit, and opt-in perPage pagination.

Query contacts

Required scope: contacts:read. Send a structured JSON query with POST to /contacts/query.

Create a contact

Required scope: contacts:write. Send fields accepted by the current contact.schema.json, including a stable external identifier when synchronizing another system.

Get a contact

Required scope: contacts:read. {contact} accepts ID or identifier.

Update a contact

Required scope: contacts:write. PUT is also registered.

Delete a contact

Required scope: contacts:write. Returns 204 No Content on success.

Restore a contact

Restores a soft-deleted contact. Required scope: contacts:write.