Skip to main content
GET
/
partner
/
commenda-os
/
customers
/
{customerId}
/
business-entities
/
{businessEntityId}
/
locations
/
{locationId}
Get a location
curl --request GET \
  --url https://api.prod.commenda.io/api/v1/partner/commenda-os/customers/{customerId}/business-entities/{businessEntityId}/locations/{locationId} \
  --header 'x-api-key: <api-key>'
{
  "location": {
    "id": "loc_123",
    "businessEntityId": 44,
    "locationTypes": [
      "OPERATIONS"
    ],
    "address": {
      "addressLine1": "548 Market St",
      "postalCode": "94104",
      "country": "US",
      "addressLine2": "Suite 21045",
      "addressLine3": "<string>",
      "city": "San Francisco",
      "state": "CA"
    },
    "createdAt": 1735689600000,
    "updatedAt": 1735776000000,
    "name": "Delaware HQ",
    "startDate": "2025-01-01",
    "employeeCount": 12
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.commenda.io/llms.txt

Use this file to discover all available pages before exploring further.

Retrieve a single location for a customer’s business entity.

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
customerId
integer
required

Commenda customer identifier.

​
businessEntityId
integer
required

Commenda business-entity identifier for the specified customer.

​
locationId
string
required

Commenda location identifier.

Response

Location retrieved successfully

​
location
object
required