Recipients

List recipients

Returns the recipients of the company the API key belongs to, ordered by name. Use it to resolve a human name to the UUID every other recipient endpoint takes. The paginator sits at the top level: data plus per_page, total, current_page, last_page. Every row carries delivery — scan it for deliverable: false to find the recipients who look configured and receive nothing. When reason is no_usable_channel on every row, the gap is the account, not the people: no channel is working at all.

get/api/v1/recipients

Request

  • Base URL: https://wardenpoint.com (the document declares no server; this is the origin it was published from)
  • URL: https://wardenpoint.com/api/v1/recipients
  • Auth: API key in header X-API-Key

Query parameters

per_pageinteger

Recipients per page. Defaults to 100, clamped to 1..200.

pageinteger

Page number, starting at 1.

Response

Paginated recipients.

per_pageinteger
totalinteger

Example response

{
  "data": [
    {
      "contacts": [
        {
          "contact_type": "telegram"
        }
      ]
    }
  ],
  "per_page": 100,
  "total": 7
}

Changes

No recorded changes to this operation across all 1 revision of this API.