Skip to main content
GET
/
contacts
Get contacts
curl --request GET \
  --url https://productlane.com/api/v1/contacts \
  --header 'Authorization: Bearer <token>'
{
  "contacts": [
    {
      "id": "<string>",
      "email": "<string>",
      "name": "<string>",
      "imageUrl": "<string>",
      "companyId": "<string>",
      "workspaceId": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "isDeleted": true,
      "version": 123,
      "company": {
        "id": "<string>",
        "name": "<string>",
        "workspaceId": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "isDeleted": true,
        "version": 123,
        "linearCustomerId": "<string>",
        "size": 123,
        "revenue": 123,
        "statusId": "<string>",
        "statusName": "<string>",
        "statusColor": "<string>",
        "tierId": "<string>",
        "tierName": "<string>",
        "logoUrl": "<string>",
        "domains": [
          "<string>"
        ],
        "autoAdd": true,
        "intercomId": "<string>",
        "hubspotId": "<string>",
        "productboardId": "<string>",
        "externalIds": [
          "<string>"
        ],
        "slugId": "<string>"
      },
      "intercomId": "<string>",
      "hubspotId": "<string>",
      "productboardId": "<string>",
      "zendeskId": "<string>"
    }
  ],
  "nextPage": {
    "take": 123,
    "skip": 123
  },
  "hasMore": true,
  "count": 123
}

​
List Contacts

Retrieve all contacts in your workspace with optional pagination. You can only access contacts from your own workspace.

​
Query Parameters

​
skip
integer
Number of contacts to skip for pagination (default: 0)
​
take
integer
Number of contacts to return (default: 10)

​
Response

​
contacts
object[]
Array of contact objects
​
contacts[].id
string
Unique identifier for the contact
​
contacts[].name
string
Contact name
​
contacts[].email
string
Contact email address
​
contacts[].companyId
string
ID of the associated company
​
contacts[].company
object
Associated company information
​
contacts[].company.id
string
Company ID
​
contacts[].company.name
string
Company name
​
contacts[].company.domains
string[]
Company domains
​
contacts[].createdAt
string
Timestamp when the contact was created
​
contacts[].updatedAt
string
Timestamp when the contact was last updated
​
contacts[].workspaceId
string
ID of the workspace this contact belongs to
​
total
integer
Total number of contacts in the workspace

​
Example Request

GET /api/v1/contacts?skip=0&take=10

​
Example Response

{
  "contacts": [
    {
      "id": "contact_123456789",
      "name": "John Doe",
      "email": "john@acme.com",
      "companyId": "comp_123456789",
      "company": {
        "id": "comp_123456789",
        "name": "Acme Corp",
        "domains": ["acme.com"]
      },
      "createdAt": "2024-01-15T10:30:00Z",
      "updatedAt": "2024-01-15T10:30:00Z",
      "workspaceId": "ws_123456789"
    }
  ],
  "total": 1
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
skip
integer
​
take
integer

Response

Successful response

​
contacts
object[]
required
​
nextPage
object
required
​
hasMore
boolean
required
​
count
number
required