This article shows you where to find the location ID and zone ID for your locations in the Indivd platform. You need these IDs to scope requests to the Indivd API and to map your Indivd locations in external systems such as BI tools or POS dashboards.
Included in: ✓ Indivd Basic ✓ Indivd Pro ✓ Indivd Complete
Related articles
This article contains the following topics:
Before you begin
You need access to Settings in the Indivd platform. Location IDs and zone IDs are integers assigned by Indivd. They do not change, and they are separate from any Custom ID you may have entered yourself.
| ID | What it identifies | Where it is used |
|---|---|---|
| Location ID | A physical site, such as a store | The location parameter in API requests, and store mapping in external systems |
| Zone ID | A defined area inside a location | The zones parameter in API requests (comma-separated for several zones) |
| Custom ID | Your own reference, for example an internal store number | Not used by the API |
Find your location ID
To find a location ID:
- Open Settings.
- Select Locations in the left menu.
- Find the location in the list.
- Click View on the location.
- Read the value under Location ID in the General Information section.
Note: The Location ID field is read-only. The Custom ID field next to it is a free-text field you can use for your own reference, for example your internal store number. The API uses the Location ID, not the Custom ID.
Find your zone IDs
To find a zone ID:
- Open Settings.
- Select Zones in the left menu.
- Select your organisation under Select Organization.
- Read the value in the ID column for the zone you need.
Note: The zone list also shows the Bounce Rate Threshold for each zone. This is the value the API applies to the bounce field unless you override it in your request.
Retrieve the IDs through the API
If you prefer to retrieve the IDs programmatically, the filter endpoints return the same values. Replace [your-token-here] with your token.
To list your locations and their IDs:
curl --location --request GET \ 'https://api.indivd.com/filters/locations' \ --header 'Authorization: Token [your-token-here]' \ --header 'Content-Type: application/json'
To list your zones and their IDs:
curl --location --request GET \ 'https://api.indivd.com/filters/zones' \ --header 'Authorization: Token [your-token-here]' \ --header 'Content-Type: application/json'
The id field in each response object is the same value shown in the platform. For the full response reference, see How to use the Indivd filter endpoints.
Note: The filter endpoints only return locations and zones within your token's scope. If a location is missing from the response, contact support@indivd.com.
Support
Questions about IDs, token scope, or connecting Indivd to an external system:
Comments
0 comments
Please sign in to leave a comment.