CompanyBranch

A company branch: one of the organisation's own locations, used to group the customers a branch is responsible for.

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

Example

detail view

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

Deleting one un-assigns its customers rather than blocking.

Used by

GETList company branches/company-branchesCompanyBranchList

POSTCreate a company branch/company-branchesCompanyBranch

GETRead a company branch/company-branches/{company_branch}CompanyBranch

PATCHUpdate a company branch/company-branches/{company_branch}CompanyBranch

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

Branch name as shown in the UI, e.g. Rotterdam.

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

Creation timestamp.

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

Last-write timestamp; use for incremental sync.

customers_countinteger≥ 0

Number of customers assigned to this branch.

linksCompanyBranchLinks

Show 2 child fields

links.selfurl

The canonical URI of this record.

links.customersurl

Customers assigned to this branch.

Variants

CompanyBranchList 6 fields

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

The same fields as the detail object.

CompanyBranchSummary 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, customers_count, links

CompanyBranchLinks 2 fields

The links object on this resource.

Keys: self, customers

Something wrong or missing on this page? Tell us