RelayAPI

List current and/or unsubscribed list members

Returns list membership state only. Delivery still requires current channel and purpose consent at send time.

GET
/v1/subscription-lists/{id}/members
AuthorizationBearer <token>

API key (rlay_live_* or rlay_test_). Invite redemption also accepts a server-derived rlay_session_ bearer for a current user session.

In: header

Path Parameters

id*string

Query Parameters

cursor?string

Opaque pagination cursor

limit?integer
Range1 <= value <= 100
Default20
status?string
Default"active"

Value in

  • "active"
  • "unsubscribed"
  • "all"

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/subscription-lists/string/members"
{  "data": [    {      "channel": "instagram",      "contact": {        "email": "string",        "id": "string",        "name": "string",        "phone": "string"      },      "contact_id": "string",      "list_id": "string",      "source": "automation",      "status": "active",      "subscribed_at": "2019-08-24T14:15:22Z",      "unsubscribed_at": "2019-08-24T14:15:22Z",      "updated_at": "2019-08-24T14:15:22Z"    }  ],  "has_more": true,  "next_cursor": "string"}

Found something wrong? Help us improve this page.