Retrieve a Recipient List

Retrieve a recipient list. The list details are returned, including the number of members in the list.

Note To retrieve details for the recipients, use the Retrieve Recipient List Members API.

Endpoint

GET /v1/recipients/lists/{namedRecipientsListId}

Authorization Header

Authorization: Bearer <access_token>
or
Authorization: Basic <encodedString>
where <encodedString> is your <api-key>:<api-secret> string encoded using Base64 encoding

Path Parameters

namedRecipientsListId REQUIRED

string (UUID)

Unique ID for the recipient list in RocketCOMS.

Request Body

None

Returns

Returns the Recipient List object. This object contains the list details including the number of recipients.

SAMPLE RESPONSE

				
					{
  "id": "23e281a7-b9bc-4a11-8657-3ca0600e2451",
  "name": "Recipient List",
  "createdAt": "2023-10-21T23:30:08.942Z",
  "updatedAt": "2023-10-31T23:30:08.942Z",
  "recipientsAmount": 200
}