GET Accounts
Gebruik dit endpoint om accounts op te halen, zoals klanten, leveranciers en vervoerders.
Gebruikersniveau: Gevorderd
Endpoint
GET /v1/{branchId}/accounts| Eigenschap | Waarde |
|---|---|
| Method | GET |
| Scope ID | Branch UUID |
| Authenticatie | Authorization: Bearer <access_token> |
| Vereiste scope | routix:accounts:read |
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
Gebruik deze sectie als je binnen de accounts GET-pagina direct naar de ondersteunde query-syntax wilt springen.
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.
- Voor
accountshangt filter- en sorteersupport af van de veldwhitelist van deze resource.
Voorbeeldfilters voor accounts
?filter=status:eq:active
?filter=account_type:in:customer,carrier
?filter=company_name:ilike:%transport%
?filter=created_at:gte:2026-01-01
?filter=comment:isnull:true
?sort=company_name:asc
?sort=created_at:descVoorbeeldrequest
curl -X GET "https://api.routix.com/v1/550e8400-e29b-41d4-a716-446655440000/accounts?limit=25&offset=0&sort=company_name:asc&filter=status:eq:active&filter=account_type:in:customer,carrier" \
-H "Authorization: Bearer eyJhbGciOiJIUzI1NiIs..."Voorbeeldresponse voor v1
{
"data": [
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"company_name": "Acme Transport B.V.",
"email": "[email protected]",
"phone": "+31 20 123 4567",
"account_type": "customer",
"status": "active"
},
{
"id": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
"company_name": "FastFreight Logistics",
"email": "[email protected]",
"phone": "+31 30 987 6543",
"account_type": "carrier",
"status": "active"
}
],
"pagination": {
"limit": 10,
"offset": 0,
"total": 2
},
"version": "v1"
}Velden per versie
v1-velden voor accounts
De v1-response bevat een stabiele, onveranderlijke set van 6 velden:
| Veld | Type | Beschrijving |
|---|---|---|
| id | uuid | Unieke identifier. |
| company_name | string | Bedrijfsnaam. |
| string | Primair emailadres. | |
| phone | string | Telefoonnummer. |
| account_type | string | customer, vendor of carrier. |
| status | string | Accountstatus. |
v2-velden voor accounts
v2 retourneert alle v1-velden plus extra detailvelden:
| Extra veld | Type | Beschrijving |
|---|---|---|
| website | string | Website van het bedrijf. |
| industry | string | Branche of sector. |
| lead_source | string | Hoe het account is binnengekomen. |
| visit_address_street | string | Straat van bezoekadres. |
| visit_address_number | string | Huisnummer van bezoekadres. |
| visit_address_addition | string | Toevoeging van bezoekadres. |
| visit_address_zipcode | string | Postcode van bezoekadres. |
| visit_address_city | string | Plaats van bezoekadres. |
| shipping_address_street | string | Straat van verzendadres. |
| shipping_address_number | string | Huisnummer van verzendadres. |
| shipping_address_addition | string | Toevoeging van verzendadres. |
| shipping_address_zipcode | string | Postcode van verzendadres. |
| shipping_address_city | string | Plaats van verzendadres. |
| billing_address_street | string | Straat van factuuradres. |
| billing_address_number | string | Huisnummer van factuuradres. |
| billing_address_addition | string | Toevoeging van factuuradres. |
| billing_address_zipcode | string | Postcode van factuuradres. |
| billing_address_city | string | Plaats van factuuradres. |
| invoice_email | string | Afwijkend factuuremailadres. |
| vat_number | string | BTW-nummer. |
| chamber_of_commerce_number | string | KvK-nummer. |
| iban | string | IBAN-bankrekening. |
| bic | string | BIC- of SWIFT-code. |
| payment_terms | string | Betaalcondities. |
| credit_limit | number | Kredietlimiet. |
| comment | string | Interne notities. |
| registration_date | timestamp | Registratiedatum. |
| created_at | timestamp | Aanmaakdatum van het record. |
| last_updated_at | timestamp | Laatste wijzigingsdatum. |
Aanbeveling: gebruik v1 voor stabiele productie-integraties. Gebruik v2 als je extra detail nodig hebt en toevoegingen aan velden kunt opvangen.
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: routix:accounts:read"
}Gerelateerde pagina’s
- API integratie
- API calls en voorbeelden
- Setup guide
Last updated on
