Skip to main content
POST
/
api
/
contacts
/
by-email
Look up contacts by email
curl --request POST \
  --url https://core-api.getaptly.com/api/contacts/by-email \
  --header 'Content-Type: application/json' \
  --header 'x-token: <api-key>' \
  --data '
{
  "email": "jane@example.com",
  "limit": 20,
  "skip": 0
}
'
{
  "contacts": [
    {
      "_id": "<string>",
      "uuid": "<string>",
      "firstname": "<string>",
      "lastname": "<string>",
      "fullName": "<string>",
      "duogram": "<string>",
      "photoId": "<string>",
      "imageUrl": "<string>",
      "email": "<string>",
      "phone": "<string>",
      "typeId": "<string>",
      "companyId": "<string>",
      "address": {},
      "title": "<string>",
      "alerts": [
        {}
      ],
      "company": "<string>",
      "isCompany": true,
      "customFields": {}
    }
  ]
}

Authorizations

​
x-token
string
header
required

Body

application/json
​
email
required

A single email address or an array of email addresses to look up.

​
limit
integer
default:20

Maximum number of results to return.

​
skip
integer
default:0

Number of results to skip (for pagination).

Response

Matching contacts.

​
contacts
object[]