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

Requested index for start of resources to be provided in response requested by client

limit integerrequired

Default value: 10

Number of items returned per page. Requested number of resources to be provided in response requested by client

externalIndividualId stringrequired

Unique ID of an object

Responses

200

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": "",
      "externalId": "",
      "externalIdType": "",
      "identityProviderId": "",
      "name": "string",
      "iamId": "string",
      "email": "string",
      "phone": "string"
    }
  ],
  "pagination": {
    "currentPage": 0,
    "totalItems": 0,
    "totalPages": 0,
    "limit": 0,
    "hasPrevious": true,
    "hasNext": true
  }
}

400

bad input parameter

Response Headers

Loading...