Skip to main content
GET
/
api
/
v1
/
contacts
List contacts
curl --request GET \
  --url https://nudgen.net/api/v1/contacts \
  --header 'Authorization: Bearer <token>'
{
  "contacts": [
    {
      "id": "<string>",
      "email": "jsmith@example.com",
      "name": "<string>",
      "phone": "<string>",
      "description": "<string>",
      "tags": [
        "<string>"
      ],
      "createdAt": "2023-11-07T05:31:56Z"
    }
  ],
  "total": 123,
  "page": 123,
  "limit": 123,
  "totalPages": 123
}

Documentation Index

Fetch the complete documentation index at: https://docs.nudgen.net/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

Personal Access Token created from Settings -> API Keys.

Query Parameters

page
integer
default:1
Required range: x >= 1
limit
integer
default:20
Required range: 1 <= x <= 100

Search by decrypted contact email.

tags
string

Comma-separated tags.

status
string

Comma-separated statuses.

Example:

"active,unsubscribed"

Response

Contact list

contacts
object[]
total
integer
page
integer
limit
integer
totalPages
integer