Skip to main content

List warehouses

Returns active warehouses (valid = 1). Filtering, sorting, and paging follow the public API rules for the Warehouse domain.

Endpoint

URL: /api/v6.1/warehouses
Method: GET

Request headers

X-API-KEY: <your_api_key>

Query parameters

ParameterTypeDescription
fieldsstringComma-separated fields (per public API Warehouse configuration).
filteringobjectFilters for supported fields.
sortstringSort field and direction.
limitintegerMax records per request.
offsetintegerSkip leading records.

Example request

curl --location 'https://example.getflycrm.com/api/v6.1/warehouses?fields=id,store_name,store_code&limit=50' \
--header 'X-API-KEY: <your_api_key>'
GET /api/v6.1/warehouses?fields=id,store_name,store_code&limit=50 HTTP/1.1
Host: example.getflycrm.com
X-API-KEY: your-api-key

Response

Same list shape as other list APIs: data, has_more, offset, limited, etc. (see Needed info).