Skip to main content
GET
/
v3
/
locations
/
{location}
Read Location
curl --request GET \
  --url http://localhost/api/v3/locations/{location}
{
  "data": {
    "id": 123,
    "type": "<string>",
    "name": "<string>",
    "handle": "<string>",
    "description": "<string>",
    "phone": "<string>",
    "email": "<string>",
    "timezone": "<string>",
    "external_id": "<string>",
    "external_code": "<string>",
    "is_published": true,
    "is_permanently_closed": true,
    "address": {
      "id": 123,
      "address_line_1": "<string>",
      "address_line_2": "<string>",
      "address_line_3": "<string>",
      "company": "<string>",
      "latitude": 123,
      "longitude": 123,
      "city": "<string>",
      "postcode": "<string>",
      "state": "<string>",
      "country": "<string>",
      "notes": "<string>",
      "external_id": "<string>",
      "is_default": true,
      "created_at": "<string>",
      "updated_at": "<string>",
      "meta": [
        "<unknown>"
      ],
      "name": "<string>",
      "type": "<string>",
      "phone": "<string>",
      "iso": "<string>",
      "iso_state": "<string>",
      "profile_id": "<string>",
      "custom_fields": {}
    },
    "normal_hours": [
      [
        "<unknown>"
      ]
    ],
    "special_hours": [
      [
        "<unknown>"
      ]
    ],
    "tags": [
      "<string>"
    ],
    "custom_fields": {},
    "icon": "<string>",
    "country_iso_3": "<string>",
    "image_url": "<string>",
    "created_at": "<string>",
    "updated_at": "<string>",
    "departments": [
      {
        "id": 123,
        "name": "<string>",
        "handle": "<string>",
        "external_id": "<string>",
        "external_code": "<string>",
        "description": "<string>",
        "short_description": "<string>",
        "url": "<string>",
        "image_url": "<string>",
        "internal_note": "<string>",
        "meta": [
          "<unknown>"
        ],
        "brand_id": 123,
        "location_id": 123,
        "brand": {
          "name": "<string>",
          "handle": "<string>"
        },
        "created_at": "<string>",
        "updated_at": "<string>"
      }
    ]
  }
}

Documentation Index

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

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

Path Parameters

location
integer
required

The location ID

Response

Location

data
Location · object
required