List all individuals

GET 
/config/individuals

This endpoint is used to list all individuals in the organisation defined in the consent building block.

Request

Query Parameters

offset integerrequired

Number of records to skip for pagination.

limit integerrequired

Default value: 10

Maximum number of records to return per page.

externalIndividualId stringrequired

Unique ID of an object

Responses

200

Individuals listed successfully

Response Headers

application/json

Schema

Schema

individuals object[]
pagination object

currentPage integer

Current page number

totalItems integer

Total number of items available

totalPages integer

Total number of pages based on limit

limit integer

Number of items per page

hasPrevious boolean

Indicates if there's a previous page

hasNext boolean

Indicates if there's a next page

Example (from schema)

{
  "individuals": [
    {
      "id": "64541a2e6e7569000145cd66",
      "externalId": "[email protected]",
      "externalIdType": "email",
      "identityProviderId": "64541a2e6e7569000145ab12",
      "name": "string",
      "iamId": "string",
      "email": "string",
      "phone": "string",
      "pushNotificationToken": "string",
      "deviceType": "android",
      "mapperId": "string"
    }
  ],
  "pagination": {
    "currentPage": 1,
    "totalItems": 25,
    "totalPages": 3,
    "limit": 10,
    "hasPrevious": false,
    "hasNext": true
  }
}

400

bad input parameter

Response Headers

401

Unauthorized

Response Headers

application/json

Schema

Schema

errorCode integerrequired
errorDescription stringrequired

Example (from schema)

{
  "errorCode": 400,
  "errorDescription": "Bad input parameter"
}

500

Internal server error

Response Headers

application/json

Schema

Schema

errorCode integerrequired
errorDescription stringrequired

Example (from schema)

{
  "errorCode": 400,
  "errorDescription": "Bad input parameter"
}

Loading...