GET Branches
Gebruik dit endpoint om branches op te halen.
Gebruikersniveau: Gevorderd
Endpoint
GET /v1/{organizationId}/branches| Eigenschap | Waarde |
|---|---|
| Method | GET |
| Scope ID | Organization UUID |
| Authenticatie | Authorization: Bearer <access_token> |
Queryparameters
| Parameter | Type | Default | Max | Beschrijving |
|---|---|---|---|---|
limit | integer | 50 | 1000 | Aantal records per pagina. |
offset | integer | 0 | - | Paginatie-offset. |
sort | string | - | Sorteerexpressie in het formaat field:asc of field:desc. | |
filter | string | - | Filterexpressie in het formaat field:operator:value. Herhaal filter om meerdere filters te combineren. |
Filteren en sorteren
Syntax
sort=field:asc
sort=field:desc
filter=field:operator:valueJe kunt filter meerdere keren in dezelfde request gebruiken.
Ondersteunde operators
| Operator | Betekenis |
|---|---|
eq | Exact gelijk aan |
ne | Niet gelijk aan |
in | Waarde zit in een lijst |
gt | Groter dan |
gte | Groter dan of gelijk aan |
lt | Kleiner dan |
lte | Kleiner dan of gelijk aan |
like | Hoofdlettergevoelige tekstmatch |
ilike | Niet-hoofdlettergevoelige tekstmatch |
isnull | Controle op nullwaarde |
Resource-regels
- Filteren en sorteren is per resource gewhitelist.
organization_idenbranch_idzijn gereserveerd voor server-side scoping en kunnen niet door clients gefilterd worden.- Tenant-scope blijft server-controlled.
- Gebruik voor deze resource een organization UUID in
{scopeId}.
Voorbeeldfilters voor branches
?filter=region_code:eq:NL-NH
?filter=name:ilike:%amsterdam%
?sort=name:ascVoorbeeldrequest
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..."Voorbeeldresponse voor 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"
}Velden
| Veld | Beschrijving |
|---|---|
id | UUID van de branch. |
name | Naam van de branch. |
email | Primair e-mailadres van de branch. |
phone | Telefoonnummer van de branch. |
base_currency | Basisvaluta van de branch. |
organization_id | UUID van de organisatie. |
region_code | Regiocode van de branch. |
Responseformaat
Succes: lijstresponse
{
"data": [],
"pagination": { "limit": 50, "offset": 0, "total": 123 },
"version": "v1"
}Foutresponse
{
"error": "insufficient_scope",
"error_description": "Token does not contain the required scope for branches"
}Gerelateerde pagina’s
- API integratie
- API calls en voorbeelden
- Setup guide
Last updated on
