curl -sS -X GET 'https://apipub.firstbasehq.com/api/v1/warehouses?page=1&size=100' \
-H 'Authorization: ApiKey YOUR_API_KEY' \
-H 'Accept: application/json'import requests
url = "https://apipub.firstbasehq.com/api/v1/warehouses"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://apipub.firstbasehq.com/api/v1/warehouses', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"size": 10,
"totalElements": 42,
"totalPages": 5,
"pageNumber": 1,
"data": [
"<unknown>"
]
}{
"errors": [
{
"detail": "Invalid request",
"source": "request"
}
]
}{
"errors": [
{
"detail": "Invalid request",
"source": "request"
}
]
}{
"errors": [
{
"detail": "Invalid request",
"source": "request"
}
]
}{
"errors": [
{
"detail": "Invalid request",
"source": "request"
}
]
}List warehouses
Returns a paginated list of Firstbase warehouses that the caller’s organization can use when creating inventory orders or shipment notices. Optionally filter by country code (ISO 3166-1 alpha-2). Page and size are 1-based and capped at 100 per page.
curl -sS -X GET 'https://apipub.firstbasehq.com/api/v1/warehouses?page=1&size=100' \
-H 'Authorization: ApiKey YOUR_API_KEY' \
-H 'Accept: application/json'import requests
url = "https://apipub.firstbasehq.com/api/v1/warehouses"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://apipub.firstbasehq.com/api/v1/warehouses', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"size": 10,
"totalElements": 42,
"totalPages": 5,
"pageNumber": 1,
"data": [
"<unknown>"
]
}{
"errors": [
{
"detail": "Invalid request",
"source": "request"
}
]
}{
"errors": [
{
"detail": "Invalid request",
"source": "request"
}
]
}{
"errors": [
{
"detail": "Invalid request",
"source": "request"
}
]
}{
"errors": [
{
"detail": "Invalid request",
"source": "request"
}
]
}Authorizations
Prefix the value with "ApiKey" to indicate the custom authorization type
Query Parameters
1-based page number for paginated results. Default is usually 1. Combine with size to page through large result sets.
x >= 11
Number of results to return per page. Keep requests within published API page-size limits; oversized values may be capped by the server.
1 <= x <= 100100
ISO 3166-1 alpha-2 country code filter (for example US, GB).
Response
Paginated list of warehouses
Standard paginated response wrapper used by all list endpoints. Use pageNumber and size to paginate; stop when pageNumber >= totalPages.
Maximum number of items per page as requested
10
Total number of items matching the query across all pages
42
Total number of pages based on totalElements / size
5
Current page number, 1-based (first page = 1)
1
Items in the current page; may be fewer than size on the last page