Skip to main content
Individual

List individuals

GET/v4/service/consent/individuals

Lists the individuals of the organisation, one page at a time, newest first. Use externalIndividualId to find the individual with that external ID. This route takes an API key, or a token of the identity provider of the organisation: with such a token, the list has only the individual of the token. An individual token and a token of the privacy dashboard login get 403.

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

    Lists only the individual with this externalId.

Response

application/json

One page of individuals.

  • individualsobject[]
  • paginationobject