List subscribers

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

customerId

string[]

The unique identifier of the customer to filter by.

subscriptionId

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

offset

integer

default:0

The number of items to skip before starting to collect the result set.

Required range: x >= 0

Response

A list of subscribers.

items

object[]

Show child attributes

items.subscriberId

string

required

The unique identifier of the subscriber.

items.name

string

required

The name of the subscriber.

items.email

string<email>

Optional email address of the subscriber.

items.address

object

The address of the subscriber. In the US, this refers to the E911 address associated with the subscriber's phone number, which is used for emergency services.

Show child attributes

items.address.street1

string

required

The first line of the address, typically street and house number.

Example:

"500 S Main St"

items.address.city

string

required

The city or municipality of the address.

Example:

"Natick"

items.address.zip

string

required

The zip code of the address.

Depending on the country, this may be referred to as a postal code or postcode.

Specifically for US addresses, the zip can include the optional four-digit extension (e.g., '27604-5121').

Example:

"01701"

items.address.country

string

required

The two-letter country abbreviation (e.g., 'US' for United States, 'SE' for Sweden).

Example:

"US"

items.address.street2

string

The second line of the address, typically apartment, suite, unit, building, floor, etc.

Example:

"Apt 1"

items.address.state

string

For countries that use states or regions, the state or administrative area code (e.g., 'CA' for California in the United States).

Example:

"CA"

items.address.region

string

A province, region, or territory name, applicable in certain countries (e.g., 'Ontario' in Canada, 'Sindh' in Pakistan).

items.address.attention

string

An optional line for specifying a person, department, or attention to a specific entity within an address.

items.customerId

string

The unique identifier of the customer the subscriber belongs to.

items.subscriptionIds

string[]

List of subscriptions ids associated with the subscriber.

Typically a subscriber has exactly one subscription, but in rare cases, a subscriber may have multiple subscriptions.

The unique identifier of the subscription.

items.createdAt

string<date-time>

Date and time when the subscriber was created.

items.updatedAt

string<date-time>

Date and time when the subscriber was last updated.

pagination

object

Show child attributes

pagination.total

integer

The total number of items available.

pagination.limit

integer

The maximum number of items to return.

pagination.offset

integer

The number of items to skip before starting to collect the items.

pagination.sort

object

The sorting criteria.

Show child attributes

pagination.sort.key

string

The key to sort by.

pagination.sort.direction

enum<string>

The direction to sort by.

Available options:

ASC,

DESC

Getting started

Overview

API reference

Authorizations

Query Parameters

Response