Skip to main content
GET
/
companies
/
{id}
Get company
curl --request GET \
  --url https://productlane.com/api/v1/companies/{id} \
  --header 'Authorization: Bearer <token>'
{
  "company": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<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,
    "workspaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "intercomId": "<string>",
    "hubspotId": "<string>",
    "productboardId": "<string>",
    "externalIds": [
      "<string>"
    ],
    "slugId": "<string>"
  },
  "upvotes": "<unknown>",
  "pastUpvotes": "<unknown>",
  "pastProjects": "<unknown>"
}

​
Get Company

Retrieve a specific company by its ID. You can optionally group upvotes to get aggregated vote counts.

​
Path Parameters

​
id
string
required
Unique identifier of the company

​
Query Parameters

​
groupUpvotes
boolean
Whether to group upvotes and return aggregated counts

​
Response

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

​
Example Request

GET /api/v1/companies/comp_123456789?groupUpvotes=true

​
Example Response

{
  "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",
  "contacts": [
    {
      "id": "contact_123",
      "name": "John Doe",
      "email": "john@acme.com"
    }
  ],
  "upvotes": 15
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
string
required

Query Parameters

​
groupUpvotes
boolean

Response

Successful response

​
company
object
required
​
upvotes
any
​
pastUpvotes
any
​
pastProjects
any