API Reference

Users

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Companies

Companies represent organizations or businesses that your users belong to. Use this endpoint to list and retrieve company information.

List all companies

GET/v2/companies

Create or update a company

POST/v2/companies

Get company by ID

GET/v2/companies/{id}

Delete a company

DELETE/v2/companies/{id}

Delete a company by external company ID

DELETE/v2/companies/by-company-id/{companyId}

Search companies

POST/v2/companies/search

ModelsExpand Collapse

Company object { id, companyId, companySize, 11 more }

id: string

Featurebase internal ID

companyId: string

External company ID from your system

companySize: number

Company employee headcount

createdAt: string

ISO date when company was created

industry: string

Industry

lastActivity: string

ISO date of last activity

linkedUsers: number

Number of users linked to this company

monthlySpend: number

Monthly spend

name: string

Company name

object: "company"

Object type identifier

plan: string

Plan or tier name

updatedAt: string

ISO date when company was last updated

website: string

Company website URL

customFields: optional map[unknown]

Custom field values

DeletedCompany object { id, deleted, object }

id: string

Unique identifier of the deleted company

deleted: true

Indicates the resource was deleted

object: "company"

Object type identifier

CompanySearchResponse object { data, nextCursor, object, 2 more }

data: array of object { id, companyId, companySize, 11 more }

Array of search results

id: string

Featurebase internal ID

companyId: string

External company ID from your system

companySize: number

Company employee headcount

createdAt: string

ISO date when company was created

industry: string

Industry

lastActivity: string

ISO date of last activity

linkedUsers: number

Number of users linked to this company

monthlySpend: number

Monthly spend

name: string

Company name

object: "company"

Object type identifier

plan: string

Plan or tier name

updatedAt: string

ISO date when company was last updated

website: string

Company website URL

customFields: optional map[unknown]

Custom field values

nextCursor: string

Cursor for fetching the next page (null if no more results)

object: "list"

Object type identifier

totalCount: optional number

Total number of companies matching the query, capped at 5000. When the actual total is at or above the cap, totalCountCapped is true and the value is exactly the cap.

totalCountCapped: optional boolean

True when totalCount is exactly the cap and the real count may be higher. UI can render as e.g. “5000+”.

CompaniesContacts

Companies represent organizations or businesses that your users belong to. Use this endpoint to list and retrieve company information.

List contacts attached to a company

GET/v2/companies/{id}/contacts

Attach a contact to a company

POST/v2/companies/{id}/contacts

Remove a contact from a company

DELETE/v2/companies/{id}/contacts/{contactId}

ModelsExpand Collapse

ContactAttachResponse = Contact { id, name, object, 16 more }

User who submitted the response

ContactRemoveResponse = Contact { id, name, object, 16 more }

User who submitted the response