Get location by ID

Request

Retrieve location information by location ID. The location must belong to the account associated with the OAuth token.

Security

PartnerApiKey and PartnerOAuth

Path

locationIdinteger, (int64)required

Location ID

Example:12345

accountIdinteger, (int64)required

Account identifier

curl -i -X GET \
  'https://api-docs.lobbie.com/_mock/openapi/partner/v2/account/{accountId}/location/12345' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Location found and returned successfully

Bodyapplication/json

activeboolean

Whether the location is active

Example:true

addressobject(AddressDTO)

Address information

createdAtstring, (date-time)

Creation timestamp (UTC)

Example:"2025-01-15T14:00:00Z"

idinteger, (int64)

Unique location identifier

Example:12345

namestring

Location name

Example:"Main Street Clinic"

phoneNumberstring

Location phone number (digits only)

Example:"5551234567"

storeIdstring

Partner's external store identifier

Example:"STORE123"

timeZonestring

Location timezone (IANA format)

Example:"America/New_York"

Response

{
  "active": true,
  "address": {
    "address1": "123 Main Street",
    "address2": "Suite 100",
    "city": "Baltimore",
    "postalCode": "21202",
    "state": "MD"
  },
  "createdAt": "2025-01-15T14:00:00Z",
  "id": 12345,
  "name": "Main Street Clinic",
  "phoneNumber": "5551234567",
  "storeId": "STORE123",
  "timeZone": "America/New_York"
}