Users

Contact people are managed below the contact and address they belong to. The nested URL prevents a user from being accidentally addressed outside its parent records.

User context

Nested operations use contacts:read or contacts:write. The global query endpoints use users:read. Route parameters accept IDs or identifiers and enforce parent-child ownership.

Query users

Searches users with the current HTTP QUERY model, including supported options such as licensed-only filtering. Required scope: users:read.

Structured user query

Runs a JSON query against user resources. Required scope: users:read.

List address users

Lists contact people assigned to the address.

Create an address user

Creates a contact person in the nested address context.

Get an address user

Returns one nested contact person.

Update an address user

Updates one contact person. PUT is also registered.

Delete an address user

Soft-deletes the contact person.

Restore an address user

Restores the soft-deleted user and revalidates the complete parent path.

Restore a user by ID

Restores a soft-deleted user using its record ID. Required scope: users:write.