Skip to content

List contacts

Request

Retrieve a paginated list of contacts for your account with filtering and search capabilities.

Features:

  • Paginated results (up to 1000 per page)
  • Filter by status (subscribed, pending_confirmation, unsubscribed, bounced, complained)
  • Search by email or name
  • Filter by tag
  • Sort by multiple fields
  • Returns tags array for each contact
Security
ApiKeyAuth
Query
pageinteger

Page number

Default:1
limitinteger, <= 1000

Results per page (max 1000)

Default:100
statusstring

Filter by contact status

Default:"subscribed"
Enum:"all""subscribed""pending_confirmation""unsubscribed""bounced""complained"
searchstring

Search by email or name

emailstring, (email)

Exact case-insensitive email lookup. When supplied without status, all statuses are searched.

tagstring

Filter by specific tag

include_segmentsboolean

When true, each contact includes a segments array of {id, name} for the segments it belongs to. Use this to render segment membership for a page of contacts in a single request instead of querying each segment separately. Internal system segments are excluded.

Default:false
sort_bystring
Default:"created_at"
Enum:"created_at""updated_at""email""name""last_sent_at""total_sent""total_opened""total_clicked"
sort_orderstring
Default:"desc"
Enum:"asc""desc"
curl -i -X GET \
  'https://api.mailerlogic.net/api/v1/contacts?page=1&limit=100&status=all&search=string&email=user%40example.com&tag=string&include_segments=false&sort_by=created_at&sort_order=asc' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

Contacts retrieved successfully

Bodyapplication/json
successboolean
Example:true
dataArray of objects
paginationobject
Response
{
  "success": true,
  "data": [
    { … },
    { … }
  ],
  "pagination": {
    "page": 1,
    "limit": 100,
    "total": 239,
    "total_pages": 3
  }
}