Individual

List individuals

GET/v4/config/consent/individuals

Lists the individuals of the organisation, one page at a time, newest first. Use search to find individuals by part of their ID, name, email, phone, externalId, iamId or mapperId. Use externalIndividualId to get the individual with that external ID.

List individuals

Language of the request sample

curl 'https://demo-api.igrant.io/v4/config/consent/individuals' \
  -H 'Authorization: ApiKey <your-api-key>'

{
  "individuals": [
    {
      "id": "6af081b138e8f33dcf799628",
      "externalId": "customer-1001",
      "externalIdType": "customerNumber",
      "identityProviderId": "",
      "name": "Alex Doe",
      "iamId": "3314e64f-b0ab-4078-923f-2250ebbbd9aa",
      "email": "[email protected]",
      "phone": "+46700000001",
      "pushNotificationToken": "",
      "deviceType": "android",
      "mapperId": ""
    }
  ],
  "pagination": {
    "currentPage": 1,
    "totalItems": 1,
    "totalPages": 1,
    "limit": 10,
    "hasPrevious": false,
    "hasNext": false
  }
}

Authorizations

Authorizationstringheaderrequired
Your API key with the prefix ApiKey: ApiKey <your-api-key>. Get an API key.
Scope:individuals:read

Query parameters

offsetinteger
Number of records to skip for pagination. A negative or unreadable value falls back to 0.
At least 0.
Default:0
limitinteger
Maximum number of records to return per page.
Default:10
externalIndividualIdstring
Gives only the individual with this externalId. An unknown external ID gets 500.
searchstring
Text to look for in the ID, name, email, phone, externalId, iamId and mapperId. The search ignores case.

Response

application/json

One page of individuals.

individualsobject[]
paginationobject