Skip to content
Featurebase Featurebase Featurebase
Dashboard
API Reference
Users

Companies

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

List all companies
client.users.companies.list(CompanyListParams { cursor, limit, featurebaseVersion } params?, RequestOptionsoptions?): CursorPage<Company { id, companyId, companySize, 11 more } >
GET/v2/companies
Create or update a company
client.users.companies.createOrUpdate(CompanyCreateOrUpdateParams { companyId, name, companySize, 7 more } params, RequestOptionsoptions?): Company { id, companyId, companySize, 11 more }
POST/v2/companies
Get company by ID
client.users.companies.retrieve(stringid, CompanyRetrieveParams { featurebaseVersion } params?, RequestOptionsoptions?): Company { id, companyId, companySize, 11 more }
GET/v2/companies/{id}
Delete a company
client.users.companies.delete(stringid, CompanyDeleteParams { featurebaseVersion } params?, RequestOptionsoptions?): DeletedCompany { id, deleted, object }
DELETE/v2/companies/{id}
Delete a company by external company ID
client.users.companies.deleteByCompanyID(stringcompanyID, CompanyDeleteByCompanyIDParams { featurebaseVersion } params?, RequestOptionsoptions?): DeletedCompany { id, deleted, object }
DELETE/v2/companies/by-company-id/{companyId}
Search companies
client.users.companies.search(CompanySearchParams { cursor, limit, query, 2 more } params, RequestOptionsoptions?): CompanySearchResponse { data, nextCursor, object, 2 more }
POST/v2/companies/search
ModelsExpand Collapse
Company { id, companyId, companySize, 11 more }
id: string

Featurebase internal ID

companyId: string

External company ID from your system

companySize: number | null

Company employee headcount

createdAt: string | null

ISO date when company was created

industry: string | null

Industry

lastActivity: string | null

ISO date of last activity

linkedUsers: number | null

Number of users linked to this company

monthlySpend: number | null

Monthly spend

name: string

Company name

object: "company"

Object type identifier

plan: string | null

Plan or tier name

updatedAt: string | null

ISO date when company was last updated

website: string | null

Company website URL

customFields?: Record<string, unknown>

Custom field values

DeletedCompany { id, deleted, object }
id: string

Unique identifier of the deleted company

deleted: true

Indicates the resource was deleted

object: "company"

Object type identifier

CompanySearchResponse { data, nextCursor, object, 2 more }
data: Array<Data>

Array of search results

id: string

Featurebase internal ID

companyId: string

External company ID from your system

companySize: number | null

Company employee headcount

createdAt: string | null

ISO date when company was created

industry: string | null

Industry

lastActivity: string | null

ISO date of last activity

linkedUsers: number | null

Number of users linked to this company

monthlySpend: number | null

Monthly spend

name: string

Company name

object: "company"

Object type identifier

plan: string | null

Plan or tier name

updatedAt: string | null

ISO date when company was last updated

website: string | null

Company website URL

customFields?: Record<string, unknown>

Custom field values

nextCursor: string | null

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

object: "list"

Object type identifier

totalCount?: 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?: 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
client.users.companies.contacts.list(stringid, ContactListParams { cursor, limit, featurebaseVersion } params?, RequestOptionsoptions?): CursorPage<Data>
GET/v2/companies/{id}/contacts
Attach a contact to a company
client.users.companies.contacts.attach(stringid, ContactAttachParams { contactId, featurebaseVersion } params, RequestOptionsoptions?): ContactAttachResponse
POST/v2/companies/{id}/contacts
Remove a contact from a company
client.users.companies.contacts.remove(stringcontactID, ContactRemoveParams { id, featurebaseVersion } params, RequestOptionsoptions?): ContactRemoveResponse
DELETE/v2/companies/{id}/contacts/{contactId}
ModelsExpand Collapse
ContactAttachResponse extends Contact { id, name, object, 16 more } | null

User who submitted the response

ContactRemoveResponse extends Contact { id, name, object, 16 more } | null

User who submitted the response