PlunkPlunk
API ReferenceContacts

List contacts

Get a paginated list of contacts with cursor-based pagination

GET
/contacts

Authorization

ApiKeyAuth

AuthorizationBearer <token>

API Key authentication. Secret keys (sk_*) are required for all endpoints except /v1/track. Public keys (pk_*) only work with the /v1/track endpoint for client-side event tracking. The project is automatically derived from the key.

In: header

Query Parameters

limit?integer

Maximum items per page

Default20
Range1 <= value <= 100
cursor?string

Pagination cursor

subscribed?boolean

Filter by subscription status

search?string

Search by email

Response Body

application/json

curl -X GET "https://next-api.useplunk.com/contacts"
{
  "success": true,
  "data": {
    "items": [
      {
        "id": "string",
        "email": "user@example.com",
        "subscribed": true,
        "data": {},
        "createdAt": "2019-08-24T14:15:22Z",
        "updatedAt": "2019-08-24T14:15:22Z"
      }
    ],
    "nextCursor": "string",
    "hasMore": true,
    "total": 0
  }
}