Find Subscriber

Fetch one or many subscribers in your account.

Query Parameters

• site_uuid string required

  Your site's unique identifier.

• email string

  This will return a subscriber if it exists in your account.

• uuid string

  This will return the subscriber who has this identifier. Rare you would ever do this.

Responses

• 200

---

Returns a list of visitors.

application/json

• Schema
• Example (from schema)

---

Schema

• data object

  id string

  The unique identifier for the subscriber.

  type string

  The type of the data.

  attributes object

  uuid string

  The UUID of the subscriber.

  email string

  The email of the subscriber.

  fields object

  Additional fields related to the subscriber.

  cached_tag_ids string[]

  An array of cached tag IDs associated with the subscriber.

{
  "data": {
    "id": "string",
    "type": "string",
    "attributes": {
      "uuid": "string",
      "email": "string",
      "fields": {},
      "cached_tag_ids": [
        "string"
      ]
    }
  }
}

Loading...