GET Organizations
Gebruik dit endpoint om organisaties op te halen.
Gebruikersniveau: Gevorderd
Endpoint
GET /v1/{organizationId}/organizations| 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 organizations
?filter=trial_end_date:lt:2026-12-31
?filter=name:ilike:%logistics%
?sort=name:ascVoorbeeldrequest
curl -X GET "https://api.routix.com/v1/123e4567-e89b-12d3-a456-426614174000/organizations?limit=25&offset=0&sort=name:asc&filter=trial_end_date:lt:2026-12-31" \
-H "Authorization: Bearer eyJhbGciOiJIUzI1NiIs..."Voorbeeldresponse voor v1
{
"data": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "Acme Logistics B.V.",
"email": "[email protected]",
"phone": "+31 20 123 4567",
"trial_end_date": "2026-12-31",
"created_at": "2026-01-10T09:15:00Z"
}
],
"pagination": {
"limit": 10,
"offset": 0,
"total": 1
},
"version": "v1"
}Velden
| Veld | Beschrijving |
|---|---|
id | UUID van de organisatie. |
name | Naam van de organisatie. |
email | Primair e-mailadres van de organisatie. |
phone | Telefoonnummer van de organisatie. |
trial_end_date | Einddatum van de trialperiode. |
created_at | Aanmaakdatum van het record. |
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 organizations"
}Gerelateerde pagina’s
- API integratie
- API calls en voorbeelden
- Setup guide
Last updated on
