List contacts with filtering and pagination

curl --request GET \
  --url https://{notifuseDomain}/api/contacts.list \
  --header 'Authorization: Bearer <token>'

{
  "contacts": [
    {
      "email": "[email protected]",
      "external_id": "user_12345",
      "timezone": "America/New_York",
      "language": "en-US",
      "first_name": "John",
      "last_name": "Doe",
      "full_name": "John Doe",
      "phone": "+15551234567",
      "address_line_1": "123 Main St",
      "address_line_2": "Apt 4B",
      "country": "US",
      "postcode": "10001",
      "state": "NY",
      "job_title": "Software Engineer",
      "custom_string_1": "Premium tier",
      "custom_string_2": "<string>",
      "custom_string_3": "<string>",
      "custom_string_4": "<string>",
      "custom_string_5": "<string>",
      "custom_number_1": 42,
      "custom_number_2": 123,
      "custom_number_3": 123,
      "custom_number_4": 123,
      "custom_number_5": 123,
      "custom_datetime_1": "2023-06-01T09:00:00Z",
      "custom_datetime_2": "2023-11-07T05:31:56Z",
      "custom_datetime_3": "2023-11-07T05:31:56Z",
      "custom_datetime_4": "2023-11-07T05:31:56Z",
      "custom_datetime_5": "2023-11-07T05:31:56Z",
      "custom_json_1": {
        "preferences": {
          "theme": "dark",
          "notifications": true
        }
      },
      "custom_json_2": {},
      "custom_json_3": {},
      "custom_json_4": {},
      "custom_json_5": {},
      "created_at": "2023-01-15T10:30:00Z",
      "updated_at": "2023-04-22T15:45:00Z",
      "contact_lists": [
        {
          "email": "[email protected]",
          "list_id": "newsletter",
          "list_name": "Newsletter",
          "status": "active",
          "created_at": "2023-01-15T10:30:00Z",
          "updated_at": "2023-01-15T10:30:00Z",
          "deleted_at": null
        }
      ],
      "contact_segments": [
        {
          "email": "[email protected]",
          "segment_id": "premium_users",
          "version": 1,
          "matched_at": "2023-01-15T10:30:00Z",
          "computed_at": "2023-01-15T10:30:00Z"
        }
      ]
    }
  ],
  "next_cursor": "MjAyMy0wMS0xNVQxMDozMDowMFp+dXNlckBleGFtcGxlLmNvbQ=="
}

Contacts

List contacts with filtering and pagination

Retrieves a paginated list of contacts with optional filtering. All contact fields are always returned.

Filtering: Use filters to search for contacts. Text filters (email, external_id, first_name, last_name, full_name, phone, country, language) use case-insensitive partial matching (ILIKE).

List filtering: Use list_id and/or contact_list_status to filter contacts by list membership.

Segment filtering: Use segments[] to filter contacts that belong to specific segments.

Contact lists: By default, contact_lists is not included in the response. Set with_contact_lists=true to include the contact’s list subscriptions.

Pagination: Uses cursor-based pagination. Use the next_cursor from the response to fetch the next page.

GET

api

contacts.list

List contacts with filtering and pagination

curl --request GET \
  --url https://{notifuseDomain}/api/contacts.list \
  --header 'Authorization: Bearer <token>'

{
  "contacts": [
    {
      "email": "[email protected]",
      "external_id": "user_12345",
      "timezone": "America/New_York",
      "language": "en-US",
      "first_name": "John",
      "last_name": "Doe",
      "full_name": "John Doe",
      "phone": "+15551234567",
      "address_line_1": "123 Main St",
      "address_line_2": "Apt 4B",
      "country": "US",
      "postcode": "10001",
      "state": "NY",
      "job_title": "Software Engineer",
      "custom_string_1": "Premium tier",
      "custom_string_2": "<string>",
      "custom_string_3": "<string>",
      "custom_string_4": "<string>",
      "custom_string_5": "<string>",
      "custom_number_1": 42,
      "custom_number_2": 123,
      "custom_number_3": 123,
      "custom_number_4": 123,
      "custom_number_5": 123,
      "custom_datetime_1": "2023-06-01T09:00:00Z",
      "custom_datetime_2": "2023-11-07T05:31:56Z",
      "custom_datetime_3": "2023-11-07T05:31:56Z",
      "custom_datetime_4": "2023-11-07T05:31:56Z",
      "custom_datetime_5": "2023-11-07T05:31:56Z",
      "custom_json_1": {
        "preferences": {
          "theme": "dark",
          "notifications": true
        }
      },
      "custom_json_2": {},
      "custom_json_3": {},
      "custom_json_4": {},
      "custom_json_5": {},
      "created_at": "2023-01-15T10:30:00Z",
      "updated_at": "2023-04-22T15:45:00Z",
      "contact_lists": [
        {
          "email": "[email protected]",
          "list_id": "newsletter",
          "list_name": "Newsletter",
          "status": "active",
          "created_at": "2023-01-15T10:30:00Z",
          "updated_at": "2023-01-15T10:30:00Z",
          "deleted_at": null
        }
      ],
      "contact_segments": [
        {
          "email": "[email protected]",
          "segment_id": "premium_users",
          "version": 1,
          "matched_at": "2023-01-15T10:30:00Z",
          "computed_at": "2023-01-15T10:30:00Z"
        }
      ]
    }
  ],
  "next_cursor": "MjAyMy0wMS0xNVQxMDozMDowMFp+dXNlckBleGFtcGxlLmNvbQ=="
}

Authorizations

Authorization

string

header

required

API token for authentication

Query Parameters

workspace_id

string

required

The ID of the workspace

string

Filter by email (case-insensitive partial match)

external_id

string

Filter by external ID (case-insensitive partial match)

first_name

string

Filter by first name (case-insensitive partial match)

last_name

string

Filter by last name (case-insensitive partial match)

full_name

string

Filter by full name (case-insensitive partial match)

phone

string

Filter by phone number (case-insensitive partial match)

country

string

Filter by country (case-insensitive partial match)

language

string

Filter by language (case-insensitive partial match)

list_id

string

Filter by list membership (contacts subscribed to this list)

contact_list_status

enum<string>

Filter by subscription status within the list

Available options:

active,

pending,

unsubscribed,

bounced,

complained

segments[]

string[]

Filter by segment membership (contacts in any of these segments)

with_contact_lists

boolean

default:false

Include contact list subscriptions in the response

limit

integer

default:20

Maximum number of contacts to return (1-100)

Required range: 1 <= x <= 100

cursor

string

Pagination cursor from previous response

Response

Contacts retrieved successfully

contacts

object[]

Array of contacts matching the query

Show child attributes

contacts.email

string<email>

required

Email address of the contact

Example:

"[email protected]"

contacts.external_id

string | null

External identifier for the contact

Example:

"user_12345"

contacts.timezone

string | null

Timezone of the contact

Example:

"America/New_York"

contacts.language

string | null

Preferred language of the contact

Example:

"en-US"

contacts.first_name

string | null

First name of the contact

Example:

"John"

contacts.last_name

string | null

Last name of the contact

Example:

"Doe"

contacts.full_name

string | null

Full name of the contact (for systems that don't have separate first/last names)

Example:

"John Doe"

contacts.phone

string | null

Phone number of the contact

Example:

"+15551234567"

contacts.address_line_1

string | null

First line of address

Example:

"123 Main St"

contacts.address_line_2

string | null

Second line of address

Example:

"Apt 4B"

contacts.country

string | null

Country of the contact

Example:

"US"

contacts.postcode

string | null

Postal code

Example:

"10001"

contacts.state

string | null

State or province

Example:

"NY"

contacts.job_title

string | null

Job title of the contact

Example:

"Software Engineer"

contacts.custom_string_1

string | null

Custom string field 1

Example:

"Premium tier"

contacts.custom_string_2

string | null

Custom string field 2

contacts.custom_string_3

string | null

Custom string field 3

contacts.custom_string_4

string | null

Custom string field 4

contacts.custom_string_5

string | null

Custom string field 5

contacts.custom_number_1

number<float> | null

Custom number field 1

Example:

42

contacts.custom_number_2

number<float> | null

Custom number field 2

contacts.custom_number_3

number<float> | null

Custom number field 3

contacts.custom_number_4

number<float> | null

Custom number field 4

contacts.custom_number_5

number<float> | null

Custom number field 5

contacts.custom_datetime_1

string<date-time> | null

Custom datetime field 1

Example:

"2023-06-01T09:00:00Z"

contacts.custom_datetime_2

string<date-time> | null

Custom datetime field 2

contacts.custom_datetime_3

string<date-time> | null

Custom datetime field 3

contacts.custom_datetime_4

string<date-time> | null

Custom datetime field 4

contacts.custom_datetime_5

string<date-time> | null

Custom datetime field 5

contacts.custom_json_1

object

Custom JSON field 1

Example:

{
  "preferences": { "theme": "dark", "notifications": true }
}

contacts.custom_json_2

object

Custom JSON field 2

contacts.custom_json_3

object

Custom JSON field 3

contacts.custom_json_4

object

Custom JSON field 4

contacts.custom_json_5

object

Custom JSON field 5

contacts.created_at

string<date-time>

When the contact was created (read-only, set by server)

Example:

"2023-01-15T10:30:00Z"

contacts.updated_at

string<date-time>

When the contact was last updated (read-only, set by server)

Example:

"2023-04-22T15:45:00Z"

contacts.contact_lists

object[]

Lists the contact is subscribed to (read-only, included in GET responses only)

Show child attributes

contacts.contact_lists.email

string<email>

Email address of the contact

Example:

"[email protected]"

contacts.contact_lists.list_id

string

ID of the list

Example:

"newsletter"

contacts.contact_lists.list_name

string

Name of the list

Example:

"Newsletter"

contacts.contact_lists.status

enum<string>

Subscription status

Available options:

active,

pending,

unsubscribed,

bounced,

complained

Example:

"active"

contacts.contact_lists.created_at

string<date-time>

When the contact was subscribed to this list

Example:

"2023-01-15T10:30:00Z"

contacts.contact_lists.updated_at

string<date-time>

When the subscription was last updated

Example:

"2023-01-15T10:30:00Z"

contacts.contact_lists.deleted_at

string<date-time> | null

When the subscription was deleted (null if active)

Example:

null

Example:

[
  {
    "email": "[email protected]",
    "list_id": "newsletter",
    "list_name": "Newsletter",
    "status": "active",
    "created_at": "2023-01-15T10:30:00Z",
    "updated_at": "2023-01-15T10:30:00Z",
    "deleted_at": null
  }
]

contacts.contact_segments

object[]

Segments the contact belongs to (read-only, included in GET responses only)

Show child attributes

contacts.contact_segments.email

string<email>

Email address of the contact

Example:

"[email protected]"

contacts.contact_segments.segment_id

string

ID of the segment

Example:

"premium_users"

contacts.contact_segments.version

integer<int64>

Version of the segment computation

Example:

1

contacts.contact_segments.matched_at

string<date-time>

When the contact was matched to this segment

Example:

"2023-01-15T10:30:00Z"

contacts.contact_segments.computed_at

string<date-time>

When the segment was last computed

Example:

"2023-01-15T10:30:00Z"

next_cursor

string | null

Cursor for fetching the next page of results. Null if no more results.

Example:

"MjAyMy0wMS0xNVQxMDozMDowMFp+dXNlckBleGFtcGxlLmNvbQ=="

Send a transactional notification Count contacts in a workspace

⌘I

Transactional

Contacts

Lists

Custom Events

Broadcasts

Templates

Webhooks

List contacts with filtering and pagination

Authorizations

Query Parameters

Response