GET Accounts

Use this endpoint to retrieve accounts such as customers, vendors, and carriers.

User level: Advanced

Endpoint


GET /v1/{branchId}/accounts

Property	Value
Method	`GET`
Scope ID	Branch UUID
Authentication	`Authorization: Bearer <access_token>`
Required scope	`routix:accounts:read`

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

Use this section when you need to jump directly to the supported query syntax for the accounts list call.

Syntax


sort=field:asc
sort=field:desc
filter=field:operator:value

You 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_id and branch_id are reserved for server-side scoping and cannot be filtered by clients.
Tenant scope remains server-controlled.
For accounts, filtering and sorting availability depends on the fields exposed by the resource whitelist.

Example filters for 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:desc

Example request


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..."

Example response for `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"
}

Fields per version

v1 fields for accounts

The v1 response contains a stable, immutable set of 6 fields:

Field	Type	Description
id	uuid	Unique identifier.
company_name	string	Company name.
email	string	Primary email address.
phone	string	Phone number.
account_type	string	`customer`, `vendor`, or `carrier`.
status	string	Account status.

v2 fields for accounts

v2 returns all v1 fields plus additional detail fields:

Additional field	Type	Description
website	string	Company website.
industry	string	Industry sector.
lead_source	string	How the account was acquired.
visit_address_street	string	Visit address street.
visit_address_number	string	Visit address number.
visit_address_addition	string	Visit address addition.
visit_address_zipcode	string	Visit address postal code.
visit_address_city	string	Visit address city.
shipping_address_street	string	Shipping address street.
shipping_address_number	string	Shipping address number.
shipping_address_addition	string	Shipping address addition.
shipping_address_zipcode	string	Shipping address postal code.
shipping_address_city	string	Shipping address city.
billing_address_street	string	Billing address street.
billing_address_number	string	Billing address number.
billing_address_addition	string	Billing address addition.
billing_address_zipcode	string	Billing address postal code.
billing_address_city	string	Billing address city.
invoice_email	string	Separate invoicing email.
vat_number	string	VAT registration number.
chamber_of_commerce_number	string	Chamber of commerce number.
iban	string	Bank account number.
bic	string	Bank BIC or SWIFT code.
payment_terms	string	Payment terms.
credit_limit	number	Credit limit.
comment	string	Internal notes.
registration_date	timestamp	Registration date.
created_at	timestamp	Record creation date.
last_updated_at	timestamp	Last modification date.

Recommendation: use v1 for stable production integrations. Use v2 when you need more detail and can handle field additions.

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: routix:accounts:read"
}

API integration
API calls & examples
Setup guide