GET Branches
Use this endpoint to retrieve branches.
User level: Advanced
Endpoint
GET /v1/{organizationId}/branches| Property | Value |
|---|---|
| Method | GET |
| Scope ID | Organization UUID |
| Authentication | Authorization: Bearer <access_token> |
Query parameters
| Parameter | Type | Default | Max | Description |
|---|---|---|---|---|
limit | integer | 50 | 1000 | Number of records per page. |
offset | integer | 0 | - | Pagination offset. |
sort | string | - | Sort expression in the format field:asc or field:desc. | |
filter | string | - | Filter expression in the format field:operator:value. Repeat filter to combine multiple filters. |
Filtering and sorting
Syntax
sort=field:asc
sort=field:desc
filter=field:operator:valueYou can repeat filter in the same request.
Supported operators
| Operator | Meaning |
|---|---|
eq | Exact match |
ne | Not equal |
in | Value is part of a list |
gt | Greater than |
gte | Greater than or equal |
lt | Less than |
lte | Less than or equal |
like | Case-sensitive text match |
ilike | Case-insensitive text match |
isnull | Null check |
Resource rules
- Filtering and sorting are whitelisted per resource.
organization_idandbranch_idare reserved for server-side scoping and cannot be filtered by clients.- Tenant scope remains server-controlled.
- Use an organization UUID in
{scopeId}for this resource.
Example filters for branches
?filter=region_code:eq:NL-NH
?filter=name:ilike:%amsterdam%
?sort=name:ascExample request
curl -X GET "https://api.routix.com/v1/123e4567-e89b-12d3-a456-426614174000/branches?limit=25&offset=0&sort=name:asc&filter=region_code:eq:NL-NH" \
-H "Authorization: Bearer eyJhbGciOiJIUzI1NiIs..."Example response for v1
{
"data": [
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "Amsterdam Branch",
"email": "[email protected]",
"phone": "+31 20 123 4567",
"base_currency": "EUR",
"organization_id": "123e4567-e89b-12d3-a456-426614174000",
"region_code": "NL-NH"
}
],
"pagination": {
"limit": 10,
"offset": 0,
"total": 1
},
"version": "v1"
}Fields
| Field | Description |
|---|---|
id | UUID of the branch. |
name | Branch name. |
email | Primary branch email address. |
phone | Branch phone number. |
base_currency | Base currency for the branch. |
organization_id | Organization UUID. |
region_code | Branch region code. |
Response format
Success: list response
{
"data": [],
"pagination": { "limit": 50, "offset": 0, "total": 123 },
"version": "v1"
}Error response
{
"error": "insufficient_scope",
"error_description": "Token does not contain the required scope for branches"
}Related pages
- API integration
- API calls & examples
- Setup guide
Last updated on
