List inventory locations

GET/api/v1/inventory/locations

List all inventory locations for the business with optional filtering.

Operation ID: list_locations_api_v1_inventory_locations_get·View as markdown·OpenAPI slice

Authentication

Bearer token authentication. Pass your DayZero API token in the Authorization header and the target business UUID in x-business-id.

Parameters

Query

location_typeLocationTypeEnum: Filter by location type
include_archivedbooleandefault: False: Include archived locations
cursorstring: Pagination cursor
limitintegerdefault: 50: Page size
include_total_countbooleandefault: False: Include total count

Responses

200Successful Response

Schema: SuccessEnvelope_LocationListResponse_

successboolean
messagestring
codestring
dataLocationListResponse

401Unauthorized - Authentication required

403Forbidden - Insufficient permissions

422Validation Error

Schema: HTTPValidationError

detailarray · ValidationErrorValidationError

5 fields

locarray · string | integerrequired
msgstringrequired
typestringrequired
inputobject
ctxobject

Code samples

GET/api/v1/inventory/locations

bash

curl -X GET 'https://api.ondayzero.com/api/v1/inventory/locations' \
  -H 'Authorization: Bearer dz_your_token' \
  -H 'x-business-id: YOUR_BUSINESS_ID'