Skip to main content
POST
/
companies
Create company
curl --request POST \
  --url https://productlane.com/api/v2/companies \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "logo_url": "<string>",
  "domains": [
    "<string>"
  ],
  "size": 1,
  "revenue": 1,
  "external_ids": [
    "<string>"
  ],
  "status_id": "<string>",
  "tier_id": "<string>",
  "owner_id": "<string>"
}
'
{
  "id": "<string>",
  "name": "<string>",
  "logo_url": "<string>",
  "domains": [
    "<string>"
  ],
  "size": 123,
  "revenue": 123,
  "status_id": "<string>",
  "status_name": "<string>",
  "tier_id": "<string>",
  "tier_name": "<string>",
  "owner": {
    "id": "<string>",
    "name": "<string>",
    "avatar_url": "<string>"
  },
  "external_ids": {
    "intercom": "<string>",
    "front": "<string>",
    "zendesk": "<string>",
    "hubspot": "<string>",
    "plain": "<string>",
    "productboard": "<string>",
    "slack_channel": "<string>"
  },
  "created_at": "<string>",
  "updated_at": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://productlane.mintlify.dev/docs/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
name
string
required
Required string length: 1 - 255
​
logo_url
string<uri> | null
​
domains
string[]
Required string length: 1 - 63
Pattern: [0-9a-z-]+\.(?:(?:co|or|gv|ac|com)\.)?[a-z]{2,7}$
​
size
integer
Required range: x >= 0
​
revenue
integer
Required range: x >= 0
​
external_ids
string[]

Replaces the company's full external-id set. Use for cross-system identifiers (CRM ids, etc.).

​
status_id
string | null

Linear customer-status id. Fetch valid ids from GET /companies/linear-options. Pass null to clear.

​
tier_id
string | null

Linear customer-tier id. Fetch valid ids from GET /companies/linear-options. Pass null to clear.

​
owner_id
string | null

Linear user id of the owner. Fetch valid ids from GET /companies/linear-options. Pass null to clear.

Response

Successful response

​
id
string
required
​
name
string
required
​
logo_url
string | null
required
​
domains
string[]
required
​
size
number | null
required
​
revenue
number | null
required
​
status_id
string | null
required
​
status_name
string | null
required
​
tier_id
string | null
required
​
tier_name
string | null
required
​
owner
object
required
​
external_ids
object
required
​
created_at
string
required
​
updated_at
string
required