cURL
curl -sS -X GET 'https://apipub.firstbasehq.com/api/v1/regions?page=1&size=100' \
-H 'Authorization: ApiKey YOUR_API_KEY' \
-H 'Accept: application/json'import requests
url = "https://apipub.firstbasehq.com/api/v1/regions"
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/regions', 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"
}
]
}Regions
List regions
Returns a paginated list of geographic regions associated with the caller’s organization. Regions define where inventory levels apply and where warehouses operate. Optionally filter by region name (partial match) or region code. Page and size are 1-based and capped at 100 per page. Set includeCountries=true to include each region’s enabled countries.
GET
https://apipub.firstbasehq.com
/
api
/
v1
/
regions
cURL
curl -sS -X GET 'https://apipub.firstbasehq.com/api/v1/regions?page=1&size=100' \
-H 'Authorization: ApiKey YOUR_API_KEY' \
-H 'Accept: application/json'import requests
url = "https://apipub.firstbasehq.com/api/v1/regions"
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/regions', 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
Query Parameters
Response
Paginated list of regions
Standard paginated response wrapper used by all list endpoints. Use pageNumber and size to paginate; stop when pageNumber >= totalPages.