Recipient groups

List recipient groups

Returns the recipient groups of the company the API key belongs to, ordered by name. Use it to resolve a group name to the UUID that POST /notifications/send-to-group takes. Members are not included — fetch a single group for those. The paginator sits at the top level: data plus per_page, total, current_page, last_page.

get/api/v1/recipient-groups

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/recipient-groups
  • Auth: API key in header X-API-Key

Query parameters

per_pageinteger

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

pageinteger

Page number, starting at 1.

Response

Paginated groups.

per_pageinteger
totalinteger

Example response

{
  "per_page": 100,
  "total": 3
}

Changes

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