Get a location

Returns an active location under a company linked to the API token. Returns 404 for any failure — does not reveal whether the location exists. Requires the location.read scope.

GET /api/v2/locations/{id}

Get a location

cURL

curl --request GET \
  --url https://api.stage.origin.one/api/v2/locations/{id} \
  --header 'Authorization: Bearer <token>'

200

{
  "id": "456",
  "name": "Acme Downtown",
  "object": "location",
  "address": {
    "city": "Seattle",
    "country": "US",
    "line1": "123 Main St",
    "line2": "Suite 400",
    "object": "address",
    "postalCode": "98101",
    "state": "WA"
  },
  "company": {
    "id": "123",
    "name": "Acme Inc",
    "object": "company",
    "url": "/api/v2/companies/123"
  },
  "createdAt": "2025-01-15T10:30:00.000Z",
  "phone": "[phone]",
  "url": "/api/v2/locations/456"
}

Authorizations

Authorization · string · header · required

Origin One API token. Pass it in the Authorization header: Authorization: Bearer <token>.

Path Parameters

id · string · required

Unique identifier of the resource.

Example:

"123"

Response

200

application/json

Success.

id · string · required

Unique identifier of the location.

Example:

"456"

name · string · required

Location name.

Example:

"Acme Downtown"

object · enum<string> · required

Object type; always location.

Available options: location

Example:

"location"

address · object | null · required

Postal address; null when the location has none.

Show child attributes

company · object · required

Company the location belongs to.

Show child attributes

createdAt · string<date-time> · required

When the location was created.

Example:

"2025-01-15T10:30:00.000Z"

phone · string | null · required

Primary phone number.

Example:

"[phone]"

url · string<uri-reference> · required

Canonical path of this resource, relative to the API origin.

Example:

"/api/v2/locations/456"