GET
/api/public/v1/locations/{locationId}

Get a location

Retrieve a single location by ID.

Required scope

The access token must carry this scope. A token missing it gets 403 Forbidden. Grant them to an API client under Dev Tools → API, to an assistant or CLI sign-in when you approve or edit it under Dev Tools, and to a teammate under Employee → Permissions.

locations:read

Path Parameters

NameTypeRequiredDescription
locationIdstringRequiredLocation ID.
GETExample request
curl
curl -X GET "https://www.pxb.app/api/public/v1/locations/{locationId}" \
  -H "Authorization: Bearer your_access_token"
200Example response
json
{
  "message": "Location retrieved successfully!",
  "content": {
    "location": {
      "id": "loc_abc123",
      "reference": "Acme Corp",
      "type": "SERVICES"
    }
  }
}

In the console

The same thing done by hand, for anyone comparing the API against the screen they already use.

Company menu → Locations
/dashboard
  1. Open the company menu → Locations.
  2. Select a location to scope the console to it.