Skip to main content
GET
/
contacts
Get contact
curl --request GET \
  --url https://app.getaptly.com/api/contacts \
  --header 'x-token: <x-token>'
[
  {
    "_id": "JShpBxEFgRmZnivTf",
    "name": "Jane Smith",
    "email": "jane@example.com"
  }
]

Headers

​
x-token
string
required

Your Aptly API Token. Available in the Aptly UI under Card Sources > API.

Query Parameters

​
page
integer
default:0

The page of results to return, 0-indexed. Page size is 200 items.

Response

A list of contacts

​
_id
string
Example:

"JShpBxEFgRmZnivTf"

​
name
string
Example:

"Jane Smith"

​
email
string<email>
Example:

"jane@example.com"