Skip to main content
GET
/
contacts
cURL
curl --request GET \
  --url https://api.notocat.com/v1/contacts \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "workspace_id": "<string>",
      "name": "<string>",
      "first_name": "<string>",
      "last_name": "<string>",
      "email": "<string>",
      "subscribed": true,
      "unsub_token": "<string>",
      "custom_fields": {},
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "total": 123,
  "page": 123,
  "offset": 123
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

newsletter_id
string

The newsletter ID

limit
integer<int64>

How many contacts per page to return. Default is 100.

page
integer<int64>

The current page. Default is 1.

email
string

Used to search by email. The search is case-insensitive.

subscribed
boolean

Used to filter by subscription status.

Response

Contact response

data
object[]
total
integer
page
integer
offset
integer