Skip to main content
GET
/
api
/
contacts
/
{contactId}
Get a contact
curl --request GET \
  --url https://core-api.getaptly.com/api/contacts/{contactId} \
  --header 'x-token: <api-key>'
{
  "_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

Path Parameters

​
contactId
string
required

The contact's _id.

Response

Contact data.

​
_id
string

MongoDB ObjectId of the contact.

​
uuid
string
​
firstname
string
​
lastname
string
​
fullName
string

Computed display name (first + last, or company name for org records).

​
duogram
string

Two-letter initials derived from first and last name.

​
photoId
string | null
​
imageUrl
string | null

CDN thumbnail URL for the contact's photo, or null if none.

​
email
string
​
phone
string
​
typeId
string
​
companyId
string
​
address
object
​
title
string
​
alerts
object[]
​
company
string

Company name — populated when isCompany is true.

​
isCompany
boolean
​
customFields
object

Custom fields for this contact, keyed by field ID. Each entry is enriched with the field definition from the contact's type. Fields defined for the type but not yet set on the contact are included with value: null.