NextSDS Docs

List locations

Returns a paginated list of storage locations, rooms, and departments for the authenticated team.

GET
/locations

Authorization

bearerAuth
AuthorizationBearer <token>

Bearer token authentication. Use your API key as the token. Obtain from your NextSDS team settings.

In: header

Query Parameters

page?integer

Page number (1-based)

Default1
Range1 <= value
per_page?integer

Items per page (max 100)

Default25
Range1 <= value <= 100
type?|

Filter by location type

Value in"room" | "cabinet" | "drawer" | "building" | "floor" | "department" | "warehouse" | null
query?string

Search by location name or description

Response Body

application/json

application/json

curl -X GET "https://api.nextsds.com/v1/locations"
{
  "meta": {
    "page": 0,
    "per_page": 0,
    "total": 0,
    "has_more": true
  },
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "Lab Storage Room A",
      "type": "room",
      "description": "string",
      "ventilation": "natural",
      "process_category": "production",
      "tags": [
        "string"
      ],
      "inventory_count": 0,
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  ]
}
{
  "type": "https://api.nextsds.com/errors/unauthorized",
  "title": "Unauthorized",
  "status": 401,
  "detail": "Invalid or missing X-API-Key header"
}