Retrieve all subscribers to an email list.

get/api/v1/email/lists/{emailListUid}/subscriptions

Request

Base URL: https://go.outseta.com
URL: https://go.outseta.com/api/v1/email/lists/{emailListUid}/subscriptions
Auth: one of:
- HTTP bearer
- API key in header Authorization

Path parameters

emailListUidstring nullable required

The email list's unique identifier

Query parameters

qstring nullable

Matches person's first name or last name or email address.

limitinteger

Requested page size. The server caps it at 100, or 25 when requested fields expand child objects or require additional queries; metadata.limit reports the applied value. Use offset=1 for the second page.

offsetinteger

Zero-based page number, not a record offset. With limit=50, the second page is offset=1; offset=50 is page index 50 (records 2501-2550).

Response

Example response

{
  "metadata": {
    "limit": 0,
    "offset": 0,
    "total": 0
  },
  "items": [
    {
      "Uid": "string",
      "_objectType": "string",
      "Created": "string",
      "Updated": "string",
      "ActivityEventData": {},
      "EmailList": {},
      "Person": {},
      "EmailListSubscriberStatus": 1,
      "SubscribedDate": "string",
      "ConfirmedDate": "string",
      "ConfirmationNotes": "string",
      "UnsubscribedDate": "string",
      "CleanedDate": "string",
      "WelcomeEmailDeliverDateTime": "string",
      "WelcomeEmailOpenDateTime": "string",
      "UnsubscribeReason": "string",
      "UnsubscribeReasonOther": "string",
      "RecaptchaToken": "string",
      "RecaptchaSiteKey": "string",
      "SendWelcomeEmail": false,
      "Source": "string"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.