List Contacts

List Contacts

curl --request GET \
  --url https://api.example.com/v1/contacts

{
  "data": {
    "contacts": [
      {
        "id": "<string>",
        "full_name": "<string>",
        "email": "<string>",
        "phone": "<string>",
        "job_title": "<string>",
        "company_name": "<string>",
        "linkedin_url": "<string>",
        "created_at": "<string>",
        "updated_date": "<string>"
      }
    ]
  },
  "meta": {
    "page": 123,
    "per_page": 123,
    "total": 123
  },
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

GET

contacts

List Contacts

curl --request GET \
  --url https://api.example.com/v1/contacts

{
  "data": {
    "contacts": [
      {
        "id": "<string>",
        "full_name": "<string>",
        "email": "<string>",
        "phone": "<string>",
        "job_title": "<string>",
        "company_name": "<string>",
        "linkedin_url": "<string>",
        "created_at": "<string>",
        "updated_date": "<string>"
      }
    ]
  },
  "meta": {
    "page": 123,
    "per_page": 123,
    "total": 123
  },
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

Request

Query Parameters

page

integer

default:"1"

Page number for pagination

per_page

integer

default:"50"

Number of contacts per page (max: 100)

string

Search by name or email (partial match)

list_id

string

Filter by list membership (UUID)

created_after

string

Filter contacts created after this date (ISO 8601 format)

sort

string

default:"created_at"

Sort field: created_at, updated_date, full_name
Prefix with - for descending order (e.g., -created_at)

Headers

Authorization: Bearer wbk_your_api_key_here

Response

data

object

Show properties

contacts

array

Array of contact objects

Show Contact object

string

Unique contact ID (UUID)

full_name

string

Contact’s full name

string

Email address

phone

string

Phone number

job_title

string

Job title or position

company_name

string

Company name

linkedin_url

string

LinkedIn profile URL

created_at

string

ISO 8601 timestamp

updated_date

string

ISO 8601 timestamp of last update

Example Response

{
  "data": {
    "contacts": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "full_name": "Jane Doe",
        "email": "jane@example.com",
        "phone": "+1234567890",
        "job_title": "General Counsel",
        "company_name": "Acme Legal",
        "linkedin_url": "https://linkedin.com/in/janedoe",
        "created_at": "2026-02-24T10:00:00Z",
        "updated_date": "2026-02-24T10:00:00Z"
      }
    ]
  },
  "meta": {
    "page": 1,
    "per_page": 50,
    "total": 235
  }
}

Examples

Search by Name

curl "https://nbkxaqxwvkgbddekwsma.supabase.co/functions/v1/api-gateway/v1/contacts?search=jane" \
  -H "Authorization: Bearer wbk_your_api_key_here"

Filter by List

curl "https://nbkxaqxwvkgbddekwsma.supabase.co/functions/v1/api-gateway/v1/contacts?list_id=abc-123" \
  -H "Authorization: Bearer wbk_your_api_key_here"

Sort by Name (Ascending)

curl "https://nbkxaqxwvkgbddekwsma.supabase.co/functions/v1/api-gateway/v1/contacts?sort=full_name" \
  -H "Authorization: Bearer wbk_your_api_key_here"

Errors

error

object

Show Error object

code

string

Error code (e.g., invalid_key, rate_limited)

message

string

Human-readable error message

Common Errors

Status	Code	Description
401	`invalid_key`	Invalid or expired API key
403	`insufficient_permissions`	Missing `read` permission
429	`rate_limited`	Rate limit exceeded

Create Contact

⌘I

Contacts

Lists

Prospects

Campaigns

Lexi AI

Request

Query Parameters

Headers

Response

Example Response

Examples

Search by Name

Filter by List

Sort by Name (Ascending)

Errors

Common Errors

Contacts

Lists

Prospects

Campaigns

Lexi AI

​Request

​Query Parameters

​Headers

​Response

​Example Response

​Examples

​Search by Name

​Filter by List

​Sort by Name (Ascending)

​Errors

​Common Errors

Request

Query Parameters

Headers

Response

Example Response

Examples

Search by Name

Filter by List

Sort by Name (Ascending)

Errors

Common Errors