List All Recipients

Retrieve all recipients for a Business Account. Recipients will be retrieved for the Business Account associated with the request access token or API key.

Use any combination of the query parameters to filter the results (value must be an exact match). Use sortBy and sortDir to sort the results, and use page and pageSize to limit the number of results returned.

Endpoint

GET /v1/recipients

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

firstName

string

Recipient’s first name.

lastName

string

Recipient’s last name.

mobileNumber

string

Recipient’s mobile number.

string

Recipient’s email address.

lastUpdateFrom

string

Date the recipient was last updated. This filter will return Recipients created on or after this date.

lastUpdateTo

string

Date the recipient was last updated. This filter will return Recipients created on or before this date.

city

string

Recipient’s city.

state

string

Recipient’s state.

country

string

Recipient’s country.

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 objects.

SAMPLE RESPONSE

				
					{
  "content": [
    {
      "id": "6a017f06-83a3-44b7-be6f-5e5cae4a9ed7",
      "businessAccountId": "8th32z87-3845-9810-v7gu-1f827g98swk3",
      "firstName": "John",
      "lastName": "Smith",
      "email": "jsmith@abc.com",
      "mobileNumber": "4161234567",
      "address": {
        "addressType": "Home",
        "streetLine1": "200 Queen St",
        "zipCode": "10001",
        "countryCode": "US",
        "stateCode": "NY",
        "cityName": "New York"
      },
      "createdAt": "2023-10-23T00:42:50.311Z",
      "updatedAt": "2023-10-30T00:42:50.311Z"
    },
    {...},
    {...}
  ],
  "page": 1,
  "total": 1,
  "pageSize": 3
}