Skip to main content
GET
/
subscribers
List subscribers
curl --request GET \
  --url https://apiv2.example.com/subscribers \
  --header 'X-Api-Key: <api-key>'
{
  "items": [
    {
      "subscriberId": "<string>",
      "name": "<string>",
      "email": "[email protected]",
      "address": {
        "street1": "500 S Main St",
        "city": "Natick",
        "zip": "01701",
        "country": "US",
        "street2": "Apt 1",
        "state": "CA",
        "region": "<string>",
        "attention": "<string>"
      },
      "customerId": "<string>",
      "subscriptionIds": [
        "<string>"
      ],
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "pagination": {
    "nextCursor": "<string>"
  }
}

Authorizations

​
X-Api-Key
string
header
required

An API key that grants access to the Connect API. You can create and manage API keys in the portal.

Query Parameters

​
customerIds
string[]

The unique identifier of the customer to filter by.

​
subscriptionIds
string[]

The unique identifier of the subscription to filter by.

​
limit
integer
default:100

The maximum number of items to return.

Required range: 1 <= x <= 1000
​
cursor
string

Opaque pagination token from a previous response's nextCursor.

Response

A list of subscribers.

​
items
object[]
required
​
pagination
object
required