Export Warehouses
GET/api/v2/warehouses/export
Exports warehouses matching the current filters as a CSV or XLSX file download.
warehouses:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Columns: Sr No., id, name, type, city, province, province_code, country, country_code, zip, created_at, updated_at. Archived warehouses are excluded unless filter[archived] is provided (values: only, all).
Column filters accept operator suffixes in the form filter[column.operator], e.g. filter[name.contains]=main or filter[created_at.between]=2026-01-01,2026-06-30. Text operators: is, is_not, contains, does_not_contain, starts_with, ends_with, is_empty, is_not_empty, is_one_of. Numeric operators: is, is_not, greater_than, greater_than_or_equal, less_than, less_than_or_equal, between, is_empty, is_not_empty. Date operators: is, is_not, on_or_before, on_or_after, between, is_empty, is_not_empty.
Authentication: Requires Bearer token.
Optional. When include_contacts=1, the export flattens to one row per contact with the parent columns repeated (parent-only row when a record has no contacts), appending Contact ID/Name/Email/Phone/Role/Title/Primary/Notes columns.
Request
Responses
- 200
- 401
- 403
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.