Sign in

v1

latestOpenAPI 3.1.02026-08-062951103.4 KB
subscribers

Retrieve a subscriber

get/subscribers/{id}

Path parameters

idstring required

Subscriber ID to retrieve

Response

OK

idstring required
platform_idstring required
namestring required
emailstring required
status'active' | 'canceled' | 'converted' | 'deflected' | 'inactive' | 'reactivated' | 'recovered' | 'saved' required
dataobject required

Additional data about the subscriber from the connected subscription platform

created_atstring date-time required
updated_atstring date-time required

Example response

{
  "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"
    }
  ]
}