List contacts

GET /v1/contacts

Send your API key as a bearer token: Authorization: Bearer ssms_sk_.... Test keys run this endpoint against the sandbox; see Authentication for key modes and scopes.

Query parameters

Name	Type	Required	Description
`limit`	integer	No	Default 25. Maximum 100.
`cursor`	string	No
`tag`	string	No	Only contacts carrying this tag
`phone_number`	string	No	Find the contact with this number (0 or 1 results)
`segment_id`	string	No	Only contacts in this saved segment, evaluated now
`q`	string	No	Matches name, email, company, or digits of the number

Results are paged. When has_more is true, pass next_cursor from the response as cursor to fetch the next page.

Responses

Status	Meaning	Body
200	Contacts, newest first	Page of `Contact`
401	Missing, malformed, or revoked API key	`Error`
402	Billable live calls only: the prepaid credit balance cannot cover the call (insufficient_credits); nothing was done or charged	`Error`
429	Rate limit or quota exceeded	`Error`

200: each item in `data` (Contact)

The body is a page: data (the array), has_more, and next_cursor (null on the last page).

Field	Type	Description
`id`	string	Example: `ct_a1B2c3D4e5F6`.
`object`	`contact`
`phone_number`	string	Example: `+14155550132`.
`name`	string	Nullable.
`tags`	array of string	Free-form labels; they double as broadcast audiences
`fields`	object
`notes`	string	Nullable.
`first_name`	string	Nullable.
`last_name`	string	Nullable.
`email`	string	Nullable.
`company`	string	Nullable.
`state`	string	Nullable.
`source`	string	Nullable.
`import_id`	string	The last import that touched this contact Nullable.
`opt_in`	object	Nullable.
`opt_in.source`	string	Nullable.
`opt_in.collected_at`	string (date-time)	Nullable.
`created_at`	string (date-time)
`updated_at`	string (date-time)
`consent_status`	`opted_out`, `opted_in`, `no_record`	Only on retrieve
`topics`	array of TopicSubscription	Only on retrieve
`segments`	array of object	Only on retrieve
`segments[].id`	string
`segments[].name`	string

Errors

Status	When
401	Missing, malformed, or revoked API key
402	Billable live calls only: the prepaid credit balance cannot cover the call (insufficient_credits); nothing was done or charged
429	Rate limit or quota exceeded

Every error has the same JSON shape, and request_id matches the X-Request-Id response header. Errors lists every code and what to do about it.

json

{
  "error": {
    "code": "invalid_request",
    "message": "What went wrong, in plain words.",
    "param": "the_field",
    "request_id": "req_a1B2c3D4e5F6g7H8"
  }
}

Examples

curl

bash

curl -X GET "https://api.joinsimplesms.com/v1/contacts?limit=10" \
  -H "Authorization: Bearer $SIMPLESMS_API_KEY"

Node.js

javascript

import { SimpleSMS } from 'joinsimplesms'; // npm install joinsimplesms

const sms = new SimpleSMS(process.env.SIMPLESMS_API_KEY);

const contacts = await sms.contacts.list({ tag: 'customers', limit: 10 });

Python

python

import os
from joinsimplesms import SimpleSMS  # pip install joinsimplesms

client = SimpleSMS(os.environ["SIMPLESMS_API_KEY"])

contacts = client.contacts.list(tag="customers", limit=10)