ContactRole

A contact role: the organisation-wide list a contact's function is picked from, e.g.

Summary view: ContactRoleList, 6 fields. What a list returns by default.
Detail view: ContactRole, 6 fields. The default for a single read and for every write.
Read with: api:read:customersandcustomers::read
Write with: api:write:customersandcustomers::create

Example

detail view

{
  "id": 1,
  "name": "Invoicing",
  "created_at": "2026-03-04T09:15:00Z",
  "updated_at": "2026-03-04T09:15:00Z",
  "contacts_count": 1,
  "links": {
    "self": "https://<your-url>/api/v2/work-items/1",
    "contacts": "https://<your-url>/api/v2/work-items/1"
  }
}

Technical contact or Invoicing. Deleting one unassigns it from every contact rather than refusing.

Used by

GETList contact roles/contact-rolesContactRoleList

POSTCreate a contact role/contact-rolesContactRole

GETRead a contact role/contact-roles/{contact_role}ContactRole

PATCHUpdate a contact role/contact-roles/{contact_role}ContactRole

Fields

Detail only: Only in the detail view.
Only with include: Only when you ask for it with include.
Server-assigned: Set by plnnrly, never by a request.

idinteger

Unique identifier.

namestring≤ 255

Role name as shown in the UI, unique across the organisation. This is the default sort key and the field ?q= searches.

created_attimestamp (YYYY-MM-DDThh:mm:ssZ)

Creation timestamp.

updated_attimestamp (YYYY-MM-DDThh:mm:ssZ)

Last-write timestamp; use for incremental sync.

contacts_countinteger≥ 0

Number of contacts assigned this role.

linksContactRoleLinks

Show 2 child fields

links.selfurl

The canonical URI of this record.

links.contactsurl

Contacts assigned this role.

Variants

ContactRoleList 6 fields

What a collection returns, and what ?view=summary returns on a single record.

The same fields as the detail object.

ContactRoleSummary 2 fields

The embedded form: what you get when another resource carries this one and you did not include it.

Leaves out: created_at, updated_at, contacts_count, links

ContactRoleLinks 2 fields

The links object on this resource.

Keys: self, contacts

Something wrong or missing on this page? Tell us