Sign in

v1

latestOpenAPI 3.1.02026-07-249097.5 KB

/locations

get/c/{company_id}/locations

Path parameters

company_idstring required

Company ID. Company subdomain can also be used.

Query parameters

limitinteger

Limits the number of results.

pageinteger

Page number.

querystring

Allows searching through an entered term.

scopestring

active contains only active locations; archived contains only archived locations; all contains all locations

view_modestring

brief contains location information without translations; full contains all the information along with translations and active offer counters

Response

200

OR

Example response

{
  "meta": {
    "limit": 1000,
    "page": 1,
    "total_count": 2
  },
  "locations": [
    {
      "id": 214600,
      "name": "Location 2",
      "is_valid": true,
      "state_name": "Mazowieckie",
      "updated_at": "2024-07-17T07:07:05.126408Z",
      "city": "Warsaw",
      "note": "Location note 2",
      "country_code": "PL",
      "created_at": "2024-07-17T07:07:05.122231Z",
      "lang_code": "en",
      "postal_code": "00-497",
      "state_code": "14",
      "street": "Nowy Świat",
      "full_address": "Poland, Mazowieckie, Warsaw, 00-497, Nowy Świat"
    }
  ]
}