List All Recipient Lists

Retrieve all recipient lists for a Business Account. Lists will be retrieved for the Business Account associated with the request access token or API key.

Use sortBy and sortDir to sort the results, and use page and pageSize to limit the number of results returned.

Endpoint

GET /v1/recipients/lists

Authorization Header

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

Query Parameters

sortBy

string

Sort the response by any field.

sortDir

string, values: desc, asc

Sort direction.

page

integer (int32), default: 0

Page number to return.

pageSize

integer (int32)

Maximum number of results to return per page.

Request Body

None

Returns

Returns a paginated response with an array of Recipient List objects.

SAMPLE RESPONSE

				
					{
  "content": [
    {
      "id": "23e281a7-b9bc-4a11-8657-3ca0600e2451",
      "name": "Recipient List",
      "createdAt": "2023-10-21T23:41:00.683Z",
      "updatedAt": "2023-10-31T23:41:00.683Z",
      "recipientsAmount": 200
    },
    {...},
    {...}
  ],
  "page": 0,
  "total": 0,
  "pageSize": 0
}