Introduction
Using this API, you get the hierarchy structure from your CustomerGauge system.
About this API
Resource Information
Response formats | JSON (default), XML |
HTTP method | GET |
Response family | Hierarchy |
Header | Authorization: Bearer XXXXX |
Resource URL
Europe Production Server: https://api.eu.customergauge.com/v4.1/hierarchy.json
US Production Server: https://api.us.customergauge.com/v4.1/hierarchy.json
Australia Production Server: https://api.au.customergauge.com/v4.1/hierarchy.json
Authentication
OAuth2 Authentication is used to connect to this API. In order to create the Connected App, which is needed to generate the Access Token, Administrator access to CustomerGauge is needed. Once you've created your Connected App, you can acquire a Bearer Access Token by calling our OAuth2/Token API:
curl -X POST -H "Content-Type: application/x-www-form-urlencoded"
-d "grant_type=client_credentials&client_id={{ Client ID }}&client_secret={{ Client Secret }}"
https://auth.{{ apiRegion }}.customergauge.com/oauth2/token
The acquired Bearer Access Token is used in the Authorization header in your API request.
How to call
Example Requests
GET (json) | https://api.eu.customergauge.com/v4.1/hierarchy.json |
GET (xml) | https://api.eu.customergauge.com/v4.1/hierarchy.xml |
To call this API through cURL:
curl -H "Authorization: Bearer XXXXX" -X GET "https://api.eu.customergauge.com/v4.1/hierarchy.json"
Example Result
Message reported on successful operation:
{ "Data": [{ "id": "1", "division": "Global", "parent": "" }, { "id": "2", "division": "Netherlands", "parent": "Global" }, { "id": "3", "division": "Amsterdam", "parent": "Netherlands" } ] }
Not the API you're looking for?
Related APIs:
Or view: