GET private-locations

Retrieves a list of private locations for the current customer.

Request example

curl --request GET "https://api-asm1.apica.io/v3/private-locations?auth_ticket=C471ADC4-19B4-4219-BBF4-671A97EC653E"

Response body model example and description

[
  {
    "access_group": "f20e9d95-e93b-4e57-8e9d-2a9cc8c92309",
    "private_locations": [
      {
        "private_location_id": "b21e8b17-179a-4227-ae4e-f1fcf871a155",
        "enabled": true,
        "geoloc": "sample string 3",
        "customer_guid": "16abe4e5-fc39-4811-8373-4798fb475b9a"
      },
      {
        "private_location_id": "87ec4497-0e45-43e2-a8c8-212a1e19c86e",
        "enabled": true,
        "geoloc": "sample string 3",
        "customer_guid": "843c93f0-cfd9-4455-94e6-071a4288fbfe"
      },
      {
        "private_location_id": "20ecd717-75a5-43c7-b239-64b173787024",
        "enabled": true,
        "geoloc": "sample string 3",
        "customer_guid": "3bb5e742-aef1-4c82-89ed-c09a89640d90"
      }
    ]
  },
  {
    "access_group": "39ebe465-6605-4bc4-9dfa-d9cc8f1ab104",
    "private_locations": [
      {
        "private_location_id": "20ecd717-75a5-43c7-b239-64b173787024",
        "enabled": true,
        "geoloc": "sample string 3",
        "customer_guid": "3bb5e742-aef1-4c82-89ed-c09a89640d90"
      },
      {
        "private_location_id": "20ecd717-75a5-43c7-b239-64b173787024",
        "enabled": true,
        "geoloc": "sample string 3",
        "customer_guid": "3bb5e742-aef1-4c82-89ed-c09a89640d90"
      },
      {
        "private_location_id": "87ec4497-0e45-43e2-a8c8-212a1e19c86e",
        "enabled": true,
        "geoloc": "sample string 3",
        "customer_guid": "843c93f0-cfd9-4455-94e6-071a4288fbfe"
      }
    ]
  },
  {
    "access_group": "36704127-314d-498b-9327-c111b0b2524a",
    "private_locations": [
      {
        "private_location_id": "b21e8b17-179a-4227-ae4e-f1fcf871a155",
        "enabled": true,
        "geoloc": "sample string 3",
        "customer_guid": "16abe4e5-fc39-4811-8373-4798fb475b9a"
      },
      {
        "private_location_id": "87ec4497-0e45-43e2-a8c8-212a1e19c86e",
        "enabled": true,
        "geoloc": "sample string 3",
        "customer_guid": "843c93f0-cfd9-4455-94e6-071a4288fbfe"
      },
      {
        "private_location_id": "b21e8b17-179a-4227-ae4e-f1fcf871a155",
        "enabled": true,
        "geoloc": "sample string 3",
        "customer_guid": "16abe4e5-fc39-4811-8373-4798fb475b9a"
      }
    ]
  }
]

Name	Type	Description
AccessGroup	Guid	Unique identifier for the access group associated with the private locations.
PrivateLocations	Object	A list of private location details.
PrivateLocationId	Guid	Unique identifier for the private location.
Enabled	Boolean	Indicates whether the private location is enabled.
Geoloc	String	Geographical location of the private location.
CustomerGuid	Guid	Customer identifier associated with the private location.