Token needs the read ability. About tokens

Path parameters

• id string (uuid) required
  Resource UUID.

Query parameters

• include string
  Allowed: locations.

Responses

• 200 A single LocationGroup.
  • data LocationGroup
    Show 6 properties
    • id string (uuid)
    • name string
    • external_id string nullable
    • created_at string (date-time) nullable
    • updated_at string (date-time) nullable
    • locations array of Location
      Present only when included.
      Show 27 properties
      • id string (uuid)
      • external_id string nullable
      • name string
      • address string nullable
      • city string nullable
      • region string nullable
      • postal_code string nullable
      • country string nullable
      • timezone string nullable
        IANA zone the location's business day runs on. Null until resolved; the tenant timezone applies meanwhile.
      • timezone_source string nullable
        Where the timezone came from. user was chosen by a person and is never overwritten by the nightly resolver; the others were detected automatically.
        user pos google state
      • is_private boolean
      • is_corporate boolean
      • is_active boolean
        True only for an active location; false for both pending and deactivated ones — see activation_status.
      • activation_status string
        pending was never activated; active collects metrics and ranks on leaderboards; deactivated was taken out of service and stays in historical network totals.
        pending active deactivated
      • deactivated_at string (date-time) nullable
        When the location was taken out of service. Null unless activation_status is deactivated.
      • is_deletable boolean
        Whether DELETE will succeed: true for a pending location, a deactivated one that never loaded any sales, labor or custom-metric data, or a deactivated one whose daily history has aged out of reporting retention.
      • deletable_on string (date) nullable
        For a deactivated location still inside retention, the date it becomes deletable (always a Jan 1). Null when it is already deletable, active, or pending.
      • district_id string (uuid) nullable
      • district_id_2 string (uuid) nullable
      • location_category_id string (uuid) nullable
      • created_at string (date-time) nullable
      • updated_at string (date-time) nullable
      • datasource_settings object
        POS identifiers for the location. Credentials are never returned: each one is reported only as {key}_set, true when a value is stored.
        Show 2 properties
        • qu object
        • brink object
      • district object nullable
        Present only when included.
        Show 7 properties
        • id string (uuid)
        • name string
        • external_id string nullable
        • district_group_id string (uuid) nullable
        • created_at string (date-time) nullable
        • updated_at string (date-time) nullable
        • districtGroup object nullable
          Present only when included.
      • district2 object nullable
        Present only when included.
        Show 7 properties
        • id string (uuid)
        • name string
        • external_id string nullable
        • district_group_id string (uuid) nullable
        • created_at string (date-time) nullable
        • updated_at string (date-time) nullable
        • districtGroup object nullable
          Present only when included.
      • locationCategory object nullable
        Present only when included.
        Show 8 properties
        • id string (uuid)
        • name string
        • external_id string nullable
        • location_category_group_id string (uuid) nullable
        • sort_order integer nullable
        • created_at string (date-time) nullable
        • updated_at string (date-time) nullable
        • locationCategoryGroup object nullable
          Present only when included.
      • locationGroups array of LocationGroup
        Present only when included (and on the Sync Location Groups response).
        Show 6 properties
        • id string (uuid)
        • name string
        • external_id string nullable
        • created_at string (date-time) nullable
        • updated_at string (date-time) nullable
        • locations array of any
          Present only when included.
• 401 Authentication failed or missing.
  • message string
• 403 The token lacks the required ability or the caller is not permitted.
  • message string
• 404 Resource not found.
  • message string