List contacts - Leadey

GET

contacts

List contacts

curl --request GET \
  --url https://backend.leadey.ai/v1/contacts \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "id": "<string>",
      "firstName": "<string>",
      "lastName": "<string>",
      "fullName": "<string>",
      "title": "<string>",
      "company": "<string>",
      "email": "<string>",
      "emailStatus": "<string>",
      "phone": "<string>",
      "phoneStatus": "<string>",
      "linkedinUrl": "<string>",
      "location": "<string>",
      "createdAt": "2023-11-07T05:31:56Z"
    }
  ],
  "meta": {
    "page": 1,
    "pageSize": 25,
    "totalCount": 134,
    "totalPages": 6
  }
}

Authorizations

Authorization

string

header

required

Your API key, created in the Leadey dashboard under Settings → API Keys. Send it as Authorization: Bearer leadey_sk_live_….

Query Parameters

page

integer

default:1

1-based page number.

Required range: x >= 1

pageSize

integer

default:25

Items per page (max 100).

Required range: 1 <= x <= 100

string

Free-text search across the resource's key fields.

company

string

Filter by company name (substring match).

Response

A page of contacts.

data

object[]

Show child attributes

meta

object

Show child attributes

Get a contact

⌘I

List contacts

curl --request GET \
  --url https://backend.leadey.ai/v1/contacts \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "id": "<string>",
      "firstName": "<string>",
      "lastName": "<string>",
      "fullName": "<string>",
      "title": "<string>",
      "company": "<string>",
      "email": "<string>",
      "emailStatus": "<string>",
      "phone": "<string>",
      "phoneStatus": "<string>",
      "linkedinUrl": "<string>",
      "location": "<string>",
      "createdAt": "2023-11-07T05:31:56Z"
    }
  ],
  "meta": {
    "page": 1,
    "pageSize": 25,
    "totalCount": 134,
    "totalPages": 6
  }
}