Skip to main content
GET
/
companies
List companies
curl --request GET \
  --url https://productlane.com/api/v1/companies \
  --header 'Authorization: Bearer <token>'
{
  "companies": [
    {
      "id": "<string>",
      "name": "<string>",
      "domains": [
        "<string>"
      ],
      "externalIds": [
        "<string>"
      ],
      "autoAdd": true,
      "size": 123,
      "revenue": 123,
      "tierId": "<string>",
      "statusId": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "workspaceId": "<string>"
    }
  ],
  "total": 123
}

​
List Companies

Retrieve all companies in your workspace with optional filtering and pagination. You can filter by domain or name, and paginate through results using skip and take parameters.

​
Query Parameters

​
skip
integer
Number of companies to skip for pagination (default: 0)
​
take
integer
Number of companies to return (default: 10)
​
domain
string
Filter companies by domain (1-255 characters)
​
name
string
Filter companies by name (1-255 characters)

​
Response

​
companies
object[]
Array of company objects
​
companies[].id
string
Unique identifier for the company
​
companies[].name
string
Company name
​
companies[].domains
string[]
List of domains associated with the company
​
companies[].externalIds
string[]
External IDs for the company
​
companies[].autoAdd
boolean
Whether to automatically add contacts with matching domains
​
companies[].size
number
Company size (number of employees)
​
companies[].revenue
number
Annual revenue
​
companies[].tierId
string
Linear customer tier ID
​
companies[].statusId
string
Linear customer status ID
​
companies[].createdAt
string
Timestamp when the company was created
​
companies[].updatedAt
string
Timestamp when the company was last updated
​
companies[].workspaceId
string
ID of the workspace this company belongs to
​
total
integer
Total number of companies matching the filters

​
Example Request

GET /api/v1/companies?skip=0&take=10&domain=acme.com

​
Example Response

{
  "companies": [
    {
      "id": "comp_123456789",
      "name": "Acme Corp",
      "domains": ["acme.com", "acme.io"],
      "externalIds": ["ACME-001"],
      "autoAdd": true,
      "size": 50,
      "revenue": 1000000,
      "tierId": "tier_123",
      "statusId": "status_456",
      "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
​
domain
string
Required string length: 1 - 255
​
name
string
Required string length: 1 - 255

Response

Successful response

​
companies
object[]
required
​
total
integer
required