Sign in

v1

latestOpenAPI 3.1.02026-08-062951103.4 KB
subscribers

List subscribers

get/subscribers

Query parameters

platform_idstring

Filter subscribers by subscription platform ID

emailstring

Filter subscribers by email address

status'active' | 'canceled' | 'converted' | 'deflected' | 'inactive' | 'reactivated' | 'recovered' | 'saved'

Filter subscribers by status

latest_flow_session_status'saved' | 'deflected' | 'canceled' | 'incomplete'

Filter subscribers by the status of their latest flow session

created_atstring

Filter subscribers by the created_at property. Specify as a dictionary with one or more of the following properties:

  • created_at[gt] — Return subscribers where created_at is greater than this value
  • created_at[lt] — Return subscribers where created_at is less than this value
  • created_at[gte] — Return subscribers where created_at is greater than or equal to this value
  • created_at[lte] — Return subscribers where created_at is less than or equal to this value

Specify date values in ISO 8601 format.

updated_atstring

Filter subscribers by the updated_at property. Specify as a dictionary with one or more of the following properties:

  • updated_at[gt] — Return subscribers where updated_at is greater than this value
  • updated_at[lt] — Return subscribers where updated_at is less than this value
  • updated_at[gte] — Return subscribers where updated_at is greater than or equal to this value
  • updated_at[lte] — Return subscribers where updated_at is less than or equal to this value

Specify date values in ISO 8601 format.

cursorstring

Pagination cursor to retrieve

limitinteger

Limit of subscribers to return

Response

OK

next_cursorstring nullable

Example response

{
  "data": [
    {
      "id": "subr_dRiytWmkVtSBt9mOpRaC0ca0",
      "platform_id": "cus_Jax42BBWGOWuDp",
      "name": "Jane Doe",
      "email": "jane@example.com",
      "status": "saved",
      "properties": [
        {
          "property": {
            "id": "prop_jrtpyZs1httwFFIl7V80cHwf",
            "key": "number_of_contacts",
            "name": "Number of contacts",
            "type": "number",
            "format": "number"
          },
          "formatted_value": "5,800"
        }
      ]
    }
  ],
  "next_cursor": "null"
}