Locations

Manage physical locations (stores, branches, points of sale) for your tenant. Devices and employees are assigned to locations for reporting and access control.

GET/api/tenant/locations

List all locations for your tenant.

Headers

Name	Type	Required	Description
Authorization	string	Required	Bearer <access_token> — requires locations:read scope

AuthorizationstringRequired

Bearer <access_token> — requires locations:read scope

Response

{
  "data": [
    {
      "id": "loc_abc123",
      "name": "Flagship Store",
      "address": "Laugavegur 1",
      "address2": null,
      "city": "Reykjavík",
      "postcode": "101",
      "createdAt": "2024-01-15T10:00:00.000Z"
    }
  ]
}

GET/api/tenant/locations/:id

Retrieve a single location by ID.

Headers

Name	Type	Required	Description
Authorization	string	Required	Bearer <access_token> — requires locations:read scope

AuthorizationstringRequired

Bearer <access_token> — requires locations:read scope

Response

{
  "data": {
    "id": "loc_abc123",
    "name": "Flagship Store",
    "address": "Laugavegur 1",
    "address2": null,
    "city": "Reykjavík",
    "postcode": "101",
    "createdAt": "2024-01-15T10:00:00.000Z"
  }
}

POST/api/tenant/locations

Create a new location. Returns the generated location ID.

Headers

Name	Type	Required	Description
Authorization	string	Required	Bearer <access_token> — requires admin scope
Content-Type	string	Required	application/json

AuthorizationstringRequired

Bearer <access_token> — requires admin scope

Content-TypestringRequired

application/json

Request Body

Name	Type	Required	Description
name	string	Required	Display name for the location
address	string	Required	Street address
address2	string	Optional	Second address line (floor, unit, etc.)
city	string	Required	City
postcode	string	Required	Postal code

namestringRequired

Display name for the location

addressstringRequired

Street address

address2stringOptional

Second address line (floor, unit, etc.)

citystringRequired

City

postcodestringRequired

Postal code

Response

{
  "data": {
    "id": "loc_abc123",
    "name": "Flagship Store",
    "address": "Laugavegur 1",
    "city": "Reykjavík",
    "postcode": "101",
    "createdAt": "2024-01-15T10:00:00.000Z"
  }
}

PATCH/api/tenant/locations/:id

Update an existing location. All fields are optional.

Headers

Name	Type	Required	Description
Authorization	string	Required	Bearer <access_token> — requires admin scope
Content-Type	string	Required	application/json

AuthorizationstringRequired

Bearer <access_token> — requires admin scope

Content-TypestringRequired

application/json

Request Body

Name	Type	Required	Description
name	string	Optional	Display name for the location
address	string	Optional	Street address
address2	string	Optional	Second address line
city	string	Optional	City
postcode	string	Optional	Postal code

namestringOptional

Display name for the location

addressstringOptional

Street address

address2stringOptional

Second address line

citystringOptional

City

postcodestringOptional

Postal code

Response

{
  "data": {
    "id": "loc_abc123",
    "name": "Flagship Store",
    "address": "Laugavegur 1",
    "address2": null,
    "city": "Reykjavík",
    "postcode": "101",
    "createdAt": "2024-01-15T10:00:00.000Z"
  }
}

DELETE/api/tenant/locations/:id

Delete a location. Also unassigns all devices associated with that location.

Headers

Name	Type	Required	Description
Authorization	string	Required	Bearer <access_token> — requires admin scope

AuthorizationstringRequired

Bearer <access_token> — requires admin scope

Response

{ "success": true }