Location - Get List

Retrieve a paginated list of locations with optional filtering.

GET /location/get_list

Location - Get List

cURL

curl --request GET \
  --url https://api.skulabs.com/location/get_list \
  --header 'Authorization: Bearer <token>'

200

[
  {
    "_id": "507f1f77bcf86cd799439011",
    "name": "<string>",
    "warehouse_id": "507f1f77bcf86cd799439011",
    "deleted": true
  }
]

Authorizations

Authorization · string · header · required

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

Query Parameters

selector · object · required

Query selector object for filtering results

limit · number

Max results to return

Example:

50

skip · number

Number of results to skip

Example:

0

sort · object

Sort fields object, e.g. { "name": 1 }

Response

200

application/json

Array of locations matching the query

_id · string · required

Unique location identifier

Example:

"507f1f77bcf86cd799439011"

name · string · required

Location name

warehouse_id · string

Parent warehouse ID

Example:

"507f1f77bcf86cd799439011"

deleted · boolean

Whether the location has been deleted