Returns all contacts associated with your account. Results are sorted by signup date in descending order (newest first). Use query parameters to filter by sending list or active/inactive subscription status.
Query Parameters
string
Filter contacts by sending list phone number. Must be in E.164 format (e.g., +18005551234).
string
Filter by subscription status. Pass "true" to return only active (subscribed) contacts, or "false" to return only inactive (unsubscribed) contacts. Omit to return all contacts regardless of status.
integer
default:"1"
Page number for pagination.
integer
default:"50"
Number of contacts per page. Maximum value is 1000.
Response Fields
array
Array of contact objects.
Show Contact object properties
string
Contact phone number in E.164 format.
string
Sending list phone number in E.164 format.
integer
Unique identifier of the sending list.
boolean
Whether the contact is currently subscribed to the list.
string
ISO 8601 UTC timestamp of when the contact was added.
string
How the contact was added (e.g., api, web_form, import).
object
Key-value pairs of custom fields associated with the contact on this list.
string
Mobile carrier name.
string
Phone line type. Values: mobile, landline, voip, toll_free, unknown, premium_rate. null when the number carries no classification or was flagged as an invalid number (a fake/invalid-number verdict stores line_type: null and sets is_valid to false).
string
Contact’s timezone based on phone number area code.
boolean
Whether the phone number passed carrier validation. null if the number has never been validated for your account.
string
ISO 3166-1 alpha-2 country code. null if the number has never been validated for your account.
integer
Total number of messages sent to this contact on this list.
integer
Total number of link clicks from this contact on this list.
number
Total revenue attributed to this contact on this list.
integer
Total number of conversions attributed to this contact on this list.
string
ISO 8601 UTC timestamp of the last message sent to this contact.
string
ISO 8601 UTC timestamp of the last click from this contact.
boolean
Whether the contact is currently enrolled in an active journey workflow.
object
Pagination metadata.
Show Pagination properties
integer
Current page number.
integer
Number of items per page.
integer
Total number of contacts matching the query.
integer
Total number of pages available.
Examples
curl -X GET "https://api.tracklysms.com/api/v2/contacts?list_number=%2B18005551234&active=true&page=1&per_page=50" \ -H "X-Api-Key: trk_your_api_key_here"