List contacts with filtering and pagination

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

import requests

url = "https://{notifuseDomain}/api/contacts.list"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://{notifuseDomain}/api/contacts.list', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{notifuseDomain}/api/contacts.list",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://{notifuseDomain}/api/contacts.list"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://{notifuseDomain}/api/contacts.list")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{notifuseDomain}/api/contacts.list")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "contacts": [
    {
      "email": "user@example.com",
      "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": "user@example.com",
          "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": "user@example.com",
          "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>'

import requests

url = "https://{notifuseDomain}/api/contacts.list"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://{notifuseDomain}/api/contacts.list', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{notifuseDomain}/api/contacts.list",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://{notifuseDomain}/api/contacts.list"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://{notifuseDomain}/api/contacts.list")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{notifuseDomain}/api/contacts.list")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "contacts": [
    {
      "email": "user@example.com",
      "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": "user@example.com",
          "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": "user@example.com",
          "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

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