Skip to main content
GET
/
subscribers
/
{subscriberId}
{
  "subscriberId": "<string>",
  "name": "<string>",
  "email": "jsmith@example.com",
  "address": {
    "street1": "500 S Main St",
    "street2": "Apt 1",
    "city": "Natick",
    "zip": "01701",
    "country": "US",
    "state": "CA",
    "region": "<string>",
    "attention": "<string>"
  },
  "customerId": "<string>",
  "customer": {
    "customerId": "<string>",
    "name": "<string>"
  },
  "subscriptions": [
    {
      "subscriptionId": "<string>",
      "status": "PENDING",
      "type": "<string>",
      "display": "<string>",
      "msisdn": "<string>",
      "customerId": "<string>",
      "productOfferingId": "<string>",
      "subscriberId": "<string>",
      "activatedAt": "2023-11-07T05:31:56Z",
      "cancelledAt": "2023-11-07T05:31:56Z",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

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.

Path Parameters

​
subscriberId
string
required

The unique identifier of the subscriber.

Response

A subscriber object.

A subscriber is a person or entity that has a subscription.

​
subscriberId
string
required

The unique identifier of the subscriber.

​
name
string
required

The name of the subscriber.

​
email
string<email>

Optional email address of the subscriber.

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

​
customerId
string

The unique identifier for the customer.

​
customer
object

Customer information embedded in responses. Sensitive details require separate API calls with appropriate authorization.

​
subscriptions
object[]

List of subscriptions associated with the subscriber.

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

​
createdAt
string<date-time>

Date and time when the subscriber was created.

​
updatedAt
string<date-time>

Date and time when the subscriber was last updated.

⌘I