Skip to main content
GET
Get a list of locations
Requires permission:

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

type
enum<string>

Filter by site type

Available options:
factory,
warehouse,
office,
port,
other
company
string<uuid>

Filter by owning company uuid (your own company or an unclaimed supplier of yours)

limit
integer

Limit the number of results

Example:

100

page
integer

The page number

Example:

1

Response

A list of locations

count
integer
Example:

1500

page
integer
Example:

1

pageSize
integer
Example:

100

data
object[]