Branches represent offices, sites, locations or departments within your organisation and can have claims linked to them.
Branches are a way to organise your claims into groups based on sub-divisions of your organisation such as offices, locations, sites, departments or even teams. Claims can be linked to the branch they relate to and users can have access to only claims from their branch, or for all branches, company-wide.
The Branch Object
Branch ObjectParameters
| Attribute | Data Type | Description |
|---|---|---|
| id | Integer | The unique ID for the branch given by Claimable. |
| name | String | Required \n \nThe name of the branch. |
| office_email | String | The email address of the branch. Must be a valid email address. |
| office_phone | String | The main/office phone number for the branch. |
| office_address_line1 | String | The first line of the branch's address |
| office_address_line2 | String | The second line of the branch's address. |
| office_address_line3 | String | The third line of the branch's address. |
| office_address_city | String | The town/city of the branch's address. |
| office_address_state | String | The state/county of the branch's address. |
| office_address_postcode | String | The postcode/zipcode of the branch's address. |
| office_address_country | String | Read Only \n \nThe country of the branch's address. Set via address_country_code. |
| office_address_country_code | String | The ISO 3166-1 alpha-3 3-letter country code for the country of the branch's address (e.g. 'gbr' = United Kingdom). \n \nSets address_country. |
| created_at | Timestamp | Read Only \n \nThe date/time the branch was created. |
| updated_at | Timestamp | Read Only \n \nThe date/time the branch was last updated. |
| created_by | Integer | Read Only \n \nThe id of the user who created the branch. |
| updated_by | Integer | Read Only \n \nThe id of the user who last updated the branch. |
# Example Branch Object
{
"id": 123456,
"name": "London Office",
"email": "[email protected]",
"office_phone": "0207 333 2222",
"address_line1": "14 East Bay Lane",
"address_line2": "",
"address_line3": "",
"address_city": "London",
"address_state": "London",
"address_postcode": "E15 2GW",
"address_country": "United Kingdom",
"address_country_code": "gbr",
"created_at": "2025-01-08T11:42:29.584Z",
"updated_at": "2025-02-01T10:02:51.120Z",
"created_by": 123,
"updated_by": 456
}