List person lists

Purpose

Use this call to list the person lists of your account and see how many persons each holds.

Request

POST <API_BASE_URL>/person/lists. All calls are POST under your API address. Replace <API_BASE_URL> with the API address provided with your access.

This operation takes no permanent API token. Send a user token in the token header. See authentication and user authorization.

The body has no fields.

Response

HTTP 200. Every list of the account, sent as a bare array. This operation does not wrap its success in the status envelope.

Field	Type	Description
`id`	string (uuid)	The identifier of the list, as you send it in `list_id`.
`name`	string	The name of the list.
`persons`	integer	How many persons the list holds, from a counter kept alongside it. Zero when the counter has never been written.

Errors

400: The request body failed validation.
401: The token is missing, expired or unknown.

A refusal can also come before the operation runs: an address outside your IP allowlist, a token bound to another address, or a body that is not valid JSON. See response format and errors.

Example

Request:

curl -X POST "<API_BASE_URL>/person/lists" \
  -H "token: <your user token>" \
  -H "Content-Type: application/json"

Response:

[
  {
    "id": "<person list id>",
    "name": "Blocklist",
    "persons": 12
  }
]