Contacts

List birthdays

Return every contact that has a stored birthday, as a light card projection: `{ data: { birthdays: [{ contact_id, full_name, image_url, job_title, company, birthday_month, birthday_day, birthday_year,

GET /v2/contacts/birthdays

Responses

200 — Successful response

Content-Type: application/json

data

object required

data.birthdays

array<object> required

data.birthdays[].contact_id

string required

data.birthdays[].full_name

string | null required

data.birthdays[].first_name

string | null required

data.birthdays[].image_url

string | null required

data.birthdays[].job_title

string | null required

data.birthdays[].company

string | null required

data.birthdays[].birthday_month

integer required

data.birthdays[].birthday_day

integer required

data.birthdays[].birthday_year

integer | null required

data.birthdays[].last_dismissal_year

integer | null required

data.birthdays[].linkedin

string | null required

data.birthdays[].twitter

string | null required

data.birthdays[].facebook

string | null required

data.birthdays[].instagram

string | null required

data.birthdays[].telegram

string | null required

data.birthdays[].tiktok

string | null required

data.birthdays[].youtube

string | null required

data.birthdays[].contact_emails

array<object> required

data.birthdays[].contact_emails[].id

string required

data.birthdays[].contact_emails[].email

string required

data.birthdays[].contact_phone_numbers

array<object> required

data.birthdays[].contact_phone_numbers[].id

string required

data.birthdays[].contact_phone_numbers[].phone_number

string required

data.birthdays[].contact_phone_numbers[].phone_number_sanitized

string | null required

data.pagination

object

data.pagination.nextCursor

string | null

data.pagination.count

integer

Example

{
  "data": {
    "birthdays": [
      {
        "contact_id": "string",
        "full_name": "string",
        "first_name": "string",
        "image_url": "string",
        "job_title": "string",
        "company": "string",
        "birthday_month": 0,
        "birthday_day": 0,
        "birthday_year": 0,
        "last_dismissal_year": 0,
        "linkedin": "string",
        "twitter": "string",
        "facebook": "string",
        "instagram": "string",
        "telegram": "string",
        "tiktok": "string",
        "youtube": "string",
        "contact_emails": [
          {
            "id": "string",
            "email": "string"
          }
        ],
        "contact_phone_numbers": [
          {
            "id": "string",
            "phone_number": "string",
            "phone_number_sanitized": "string"
          }
        ]
      }
    ]
  }
}

400 — Request body failed validation.

Content-Type: application/json

(body)

any

401 — Missing or invalid API key.

Content-Type: application/json

(body)

any

403 — Valid key, insufficient permission.

Content-Type: application/json

(body)

any

404 — Resource does not exist.

Content-Type: application/json

(body)

any

409 — Request conflicts with the current state of the resource.

Content-Type: application/json

(body)

any

429 — Rate limit exceeded.

Content-Type: application/json

(body)

any

500 — Unexpected server error.

Content-Type: application/json

(body)

any

Code samples

curl https://api.prod.getdex.com/v2/contacts/birthdays \
  --header 'Authorization: Bearer YOUR_API_KEY'

fetch('https://api.prod.getdex.com/v2/contacts/birthdays', {
  headers: {
    Authorization: 'Bearer YOUR_API_KEY'
  }
})

requests.get(
    "https://api.prod.getdex.com/v2/contacts/birthdays",
    headers={
      "Authorization": "Bearer YOUR_API_KEY"
    }
)

Get a contact

Retrieve a contact by ID. Email and phone relations are omitted by default; request them with `?include[contact_emails]=true` or `?include[contact_phone_numbers]=true`.

Bulk-create contacts

Create multiple contacts in a single request. **Requires `Idempotency-Key`.** Returns the created contacts as `{ data: { contacts: [...] }, ... }` with status 201, alongside a `data.batch` partial-suc