GET
/
v2
/
api
/
customers
/
curl --location --request GET 'https://api.explo.co/v2/api/customers/?pageSize=2&page=1' \
--header 'Content-Type: application/json' \
--header 'Explo-Authorization: Token <token>'
{
  "count": 10,
  "results": {
    "customers": [{
      "token": "<customer_token_to_auth_dashboard>",
      "name": "Example 1",
      "providedId": "example_1",
      "isDemoGroup": false,
      "emails": ["[email protected]"],
      "groupTags": ["designers", "engineers"],
      "properties": { "filterValue": "value" },
      "computedProperties": { "filterValue": "value" },
      "accessGroup": "Development",
      "parentSchemaDatasourceMapping": {"40": "213": "134": "386"},
      "computedParentSchemaDatasourceMapping": {"40": "213": "134": "386"},
      "hierarchyLevel": "Level 1"
    }, {
      "token": "<customer_token_to_auth_dashboard>",
      "name": "Example 2",
      "providedId": "example_2",
      "isDemoGroup": false,
      "emails": ["[email protected]"],
      "groupTags": [],
      "properties": { "filterValue": "value" },
      "computedProperties": { "filterValue": "value" },
      "accessGroup": "Production",
      "parentSchemaDatasourceMapping": {"40": "213": "134": "386"},
      "computedParentSchemaDatasourceMapping": {"40": "213": "134": "386"},
      "hierarchyLevel": "Level 2"
    }]
  }
}
This endpoint gets all of your customers. This list will be filtered to the customers your API token has access to.
parentProvidedId
string
Filters customers to those with specified parent provided id.
hierarchyLevelName
string
Filters customers to those within the specified hierarchy level.
page
number
The result page number to request. Defaults to 1.
pageSize
number
The result page size. Defaults to 20. The max is 1000

Response

count
number
The total number of results possible.
results
object
Response wrapper object. Contains the customers response field.
customers
object[]
The contents of each customer
curl --location --request GET 'https://api.explo.co/v2/api/customers/?pageSize=2&page=1' \
--header 'Content-Type: application/json' \
--header 'Explo-Authorization: Token <token>'
{
  "count": 10,
  "results": {
    "customers": [{
      "token": "<customer_token_to_auth_dashboard>",
      "name": "Example 1",
      "providedId": "example_1",
      "isDemoGroup": false,
      "emails": ["[email protected]"],
      "groupTags": ["designers", "engineers"],
      "properties": { "filterValue": "value" },
      "computedProperties": { "filterValue": "value" },
      "accessGroup": "Development",
      "parentSchemaDatasourceMapping": {"40": "213": "134": "386"},
      "computedParentSchemaDatasourceMapping": {"40": "213": "134": "386"},
      "hierarchyLevel": "Level 1"
    }, {
      "token": "<customer_token_to_auth_dashboard>",
      "name": "Example 2",
      "providedId": "example_2",
      "isDemoGroup": false,
      "emails": ["[email protected]"],
      "groupTags": [],
      "properties": { "filterValue": "value" },
      "computedProperties": { "filterValue": "value" },
      "accessGroup": "Production",
      "parentSchemaDatasourceMapping": {"40": "213": "134": "386"},
      "computedParentSchemaDatasourceMapping": {"40": "213": "134": "386"},
      "hierarchyLevel": "Level 2"
    }]
  }
}