Skip to main content
GET
/
v1
/
contacts
List contacts
curl --request GET \
  --url https://api-public.skipcall.app/v1/contacts \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "firstName": "John",
      "lastName": "Doe",
      "allowPhoneCalls": true,
      "callCount": 5,
      "teamId": "550e8400-e29b-41d4-a716-446655440000",
      "phoneNumbers": [
        "+33612345678"
      ],
      "customFields": {
        "Industry": "Technology",
        "Size": "50-100"
      },
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "email": "john.doe@example.com",
      "company": "Acme Inc.",
      "city": "Paris",
      "country": "France",
      "url": "https://example.com",
      "linkedinUrl": "https://linkedin.com/in/johndoe",
      "linkedinSalesUrl": "https://linkedin.com/sales/people/johndoe",
      "role": "CTO",
      "lastCallAt": "2023-11-07T05:31:56Z"
    }
  ],
  "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

​
workspaceIds
string

Workspace IDs to narrow down results. Must be a subset of the workspaces accessible by the API key. Omit to return data from every workspace in scope. Accepts either a comma-separated string (?workspaceIds=uuid1,uuid2) — the documented format — or repeated array params (?workspaceIds[]=uuid1&workspaceIds[]=uuid2).

Example:

"550e8400-e29b-41d4-a716-446655440000,6ba7b810-9dad-11d1-80b4-00c04fd430c8"

​
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