Skip to main content
GET
/
locations
Get Locations
curl --request GET \
  --url https://api.example.com/locations
[
  {
    "id": "<string>",
    "identifier": "<string>",
    "referenceNumber": 123,
    "name": "<string>",
    "parentLocationId": "<string>",
    "locationTag": {
      "id": "<string>",
      "code": "<string>",
      "name": "<string>",
      "description": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "deleted": true,
      "deletedAt": "2023-11-07T05:31:56Z"
    }
  }
]

Query Parameters

page
number
default:1

Page number (1-based)

limit
number
default:10

Number of items per page

parentLocationId
string

The ID of the parent location

Response

200 - application/json

The locations have been successfully retrieved

id
string
required

The id of the location

identifier
string
required

The identifier of the location

referenceNumber
number
required

The reference number of the location

name
string
required

The name of the location

parentLocationId
string | null

The id of the parent location

locationTag
object

The tag associated with the location