List unsubscribes

Authorization

AuthorizationRequiredBearer <token>

API key as Bearer token: Authorization: Bearer sk_live_.... Use sk_live_ prefixed keys for production data and sk_test_ prefixed keys for sandbox/test data.

In: header

X-API-Key<token>

API key via header: X-API-Key: sk_live_.... Use sk_live_ prefixed keys for production data and sk_test_ prefixed keys for sandbox/test data.

In: header

Query Parameters

pageinteger

Page number

Default: 1

limitinteger

Items per page (max 100)

Default: 20Maximum: 100

searchstring

Search term

curl -X GET "https://clientsphere.io/api/v1/email-unsubscribes?page=1&limit=20&search=%3Cstring%3E" \
  -H "Authorization: Bearer <token>"

Paginated list of unsubscribes

{
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "companyId": "8bb73d03-06b4-47c7-80c7-59301f770eda",
      "email": "user@example.com",
      "contactId": "b5ec5d98-4bee-4da1-ad24-dde86346cb1d",
      "source": "website",
      "reason": "string",
      "createdAt": "2019-08-24T14:15:22Z"
    }
  ],
  "meta": {
    "pagination": {
      "page": 1,
      "limit": 20,
      "totalCount": 137,
      "totalPages": 7
    }
  }
}

List unsubscribes

Authorization

Query Parameters

Response

TypeScript