Skip to main content
GET
/
v1
/
contacts
List contacts
curl --request GET \
  --url https://api.example.com/v1/contacts \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "firstName": "John",
      "lastName": "Doe",
      "phoneNumbers": [
        "+33612345678"
      ],
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "lastModificationSource": "SKIPCALL",
      "email": "john.doe@example.com",
      "company": "Acme Inc."
    }
  ],
  "total": 100,
  "page": 1,
  "limit": 10,
  "totalPages": 10
}

Authorizations

​
Authorization
string
header
required

Enter your API Key (sk_live_xxx or sk_test_xxx)

Query Parameters

​
page
number
default:1

Page number (1-indexed)

Required range: x >= 1
Example:

1

​
limit
number
default:10

Number of items per page

Required range: 1 <= x <= 50
Example:

10

​
search
string

Search query to filter contacts by name, email, or company

Maximum string length: 100
Example:

"john"

Response

Paginated list of contacts

​
data
object[]
required
​
total
number
required
Example:

100

​
page
number
required
Example:

1

​
limit
number
required
Example:

10

​
totalPages
number
required
Example:

10