Skip to main content
GET
/
contacts
List all contacts
curl --request GET \
  --url https://www.postable.com/api/v1/contacts \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "prefix": "<string>",
      "first_name": "<string>",
      "middle_name": "<string>",
      "last_name": "<string>",
      "company": "<string>",
      "email": "jsmith@example.com",
      "phone": "<string>",
      "address": "<string>",
      "apt": "<string>",
      "city": "<string>",
      "state": "<string>",
      "zip": "<string>",
      "country": "<string>",
      "spouse_prefix": "<string>",
      "spouse_first_name": "<string>",
      "spouse_middle_name": "<string>",
      "spouse_last_name": "<string>",
      "birth_month": 6,
      "birth_day": 16,
      "birth_year": 123,
      "anniversary_month": 6,
      "anniversary_day": 16,
      "anniversary_year": 123,
      "spouse_birth_month": 6,
      "spouse_birth_day": 16,
      "spouse_birth_year": 123,
      "children": [
        {
          "first_name": "<string>",
          "birth_month": 6,
          "birth_day": 16,
          "birth_year": 123
        }
      ],
      "pets": [
        {
          "name": "<string>",
          "birth_month": 6,
          "birth_day": 16,
          "birth_year": 123,
          "secondary_type": "<string>"
        }
      ],
      "notes": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "links": {
    "first": "https://postable.com/api/contacts?cursor=",
    "prev": null,
    "next": "https://postable.com/api/contacts?cursor=eyJpZCI6MTAsImZpcnN0bmFtZSI6IkpvaG4iLCJsYXN0bmFtZSI6IkRvZSJ9"
  },
  "meta": {
    "path": "https://postable.com/api/contacts",
    "per_page": 15,
    "next_cursor": "eyJpZCI6MTAsImZpcnN0bmFtZSI6IkpvaG4iLCJsYXN0bmFtZSI6IkRvZSJ9",
    "prev_cursor": null
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

cursor
string

Cursor for pagination

per_page
integer
default:15

Number of items per page

Required range: 1 <= x <= 100
query
string

Search query to filter contacts by name, email, or phone

Response

200 - application/json

List of contacts

data
object[]
meta
object
I