For the complete documentation index, see llms.txt. This page is also available as Markdown.

Companies

Operations related to companies

Get all Companies

get

Returns a list of companies with pagination support.

Authorizations
x-api-keystringRequired
Query parameters
pagenumberOptional

Page number to retrieve.

limitnumberOptional

Number of items per page.

namestringOptional

Company name to filter companies by (partial match).

domainstringOptional

Company domain to filter companies by (partial match).

opportunityIdstringOptional

Opportunity ID to filter companies by opportunity relationship.

Responses
200Success
application/json
statusCodenumberRequiredDefault: 200
countnumberRequired
errorstring · nullableRequired
get
/api/v1/companies

Create Company

post

Creates a new company.

Authorizations
x-api-keystringRequired
Body
namestringRequired

Name of the company

Example: Acme Corporation
domainstringRequired

Company domain

Example: acme.com
descriptionstringOptional

Company description

Example: Leading provider of innovative solutions
industrystringOptional

Company industry

Example: Technology
phonestringOptional

Company phone number

Example: +1-555-123-4567
emailstringOptional

Company email address

Example: contact@acme.com
currencystringOptional

Company currency

Example: USD
addressstringOptional

Company address

Example: 123 Main Street
postalCodestringOptional

Postal code

Example: 12345
citystringOptional

City

Example: New York
nEmployeesnumberOptional

Number of employees

Example: 150
sourcestringOptional

Company source

Example: Website
annualRevenuenumberOptional

Annual revenue

Example: 1000000
statusstringOptional

Company status

Example: Active
foundationYearnumberOptional

Foundation year

Example: 2020
sellRatingnumberOptional

Sell rating (0-100)

Example: 85
linkedinUrlstringOptional

LinkedIn URL

Example: https://linkedin.com/company/acme-corp
parentCompanyIdstringOptional

Parent company ID

Example: 5516cd47-2bd0-4f4f-adc2-22524e54ba4d
Responses
post
/api/v1/companies

Get Company Details tab payload

get

Returns the same aggregate shown in the platform company Details tab: commercial state (sales moment), latest AI company status (current narrative, needs, objections), and the suggested-actions/signals bundle.

Authorizations
x-api-keystringRequired
Path parameters
idstringRequired

Company ID.

Responses
200Success
application/json
statusCodenumberRequiredDefault: 200
countnumberRequired
errorstring · nullableRequired
get
/api/v1/companies/{id}/details

Get Company by ID

get

Get a company by ID.

Authorizations
x-api-keystringRequired
Path parameters
idstringRequired

Company ID to retrieve.

Responses
200Success
application/json
statusCodenumberRequiredDefault: 200
countnumberRequired
errorstring · nullableRequired
get
/api/v1/companies/{id}

Update Company

put

Updates an existing company.

Authorizations
x-api-keystringRequired
Path parameters
idstringRequired

Company ID to update.

Body
namestringOptional

Name of the company

Example: Acme Corporation
domainstringOptional

Company domain

Example: acme.com
descriptionstringOptional

Company description

Example: Leading provider of innovative solutions
industrystringOptional

Company industry

Example: Technology
phonestringOptional

Company phone number

Example: +1-555-123-4567
emailstringOptional

Company email address

Example: contact@acme.com
currencystringOptional

Company currency

Example: USD
addressstringOptional

Company address

Example: 123 Main Street
postalCodestringOptional

Postal code

Example: 12345
citystringOptional

City

Example: New York
nEmployeesnumberOptional

Number of employees

Example: 150
sourcestringOptional

Company source

Example: Website
annualRevenuenumberOptional

Annual revenue

Example: 1000000
statusstringOptional

Company status

Example: Active
foundationYearnumberOptional

Foundation year

Example: 2020
sellRatingnumberOptional

Sell rating (0-100)

Example: 85
linkedinUrlstringOptional

LinkedIn URL

Example: https://linkedin.com/company/acme-corp
parentCompanyIdstringOptional

Parent company ID

Example: 5516cd47-2bd0-4f4f-adc2-22524e54ba4d
Responses
200Success
application/json
statusCodenumberRequiredDefault: 200
countnumberRequired
errorstring · nullableRequired
put
/api/v1/companies/{id}

Delete Company

delete

Deletes a company by ID.

Authorizations
x-api-keystringRequired
Path parameters
idstringRequired

Company ID to delete.

Responses
200Success
application/json
statusCodenumberRequiredDefault: 200
countnumberRequired
errorstring · nullableRequired
databooleanRequired
delete
/api/v1/companies/{id}

Get Company Integrations

get

Returns a list of integrations for a given company ID.

Authorizations
x-api-keystringRequired
Path parameters
idstringRequired

Company ID to get integrations from.

Responses
200Success
application/json
statusCodenumberRequiredDefault: 200
countnumberRequired
errorstring · nullableRequired
get
/api/v1/companies/{id}/integrations

Get Company Contacts

get

Returns a list of contacts associated with a company.

Authorizations
x-api-keystringRequired
Path parameters
idstringRequired

Company ID to get contacts from.

Query parameters
pagenumberOptional

Page number to retrieve.

limitnumberOptional

Number of items per page.

Responses
200Success
application/json
statusCodenumberRequiredDefault: 200
countnumberRequired
errorstring · nullableRequired
get
/api/v1/companies/{id}/contacts

Create Company Contact Relationship

post

Creates a relationship between a company and a contact.

Authorizations
x-api-keystringRequired
Path parameters
idstringRequired

Company ID.

Body
contactIdstringRequired

Contact ID

Example: 5516cd47-2bd0-4f4f-adc2-22524e54ba4d
Responses
post
/api/v1/companies/{id}/contacts

Get Company Opportunities

get

Returns a list of opportunities associated with a company.

Authorizations
x-api-keystringRequired
Path parameters
idstringRequired

Company ID to get opportunities from.

Query parameters
pagenumberOptional

Page number to retrieve.

limitnumberOptional

Number of items per page.

Responses
200Success
application/json
statusCodenumberRequiredDefault: 200
countnumberRequired
errorstring · nullableRequired
get
/api/v1/companies/{id}/opportunities

Create Company Opportunity Relationship

post

Creates a relationship between a company and an opportunity.

Authorizations
x-api-keystringRequired
Path parameters
idstringRequired

Company ID.

Body
opportunityIdstringRequired

Opportunity ID

Example: 5516cd47-2bd0-4f4f-adc2-22524e54ba4d
Responses
post
/api/v1/companies/{id}/opportunities

Get Company Meetings

get

Returns meetings linked to the company (via meeting-company relations).

Authorizations
x-api-keystringRequired
Path parameters
idstringRequired

Company ID to list meetings for.

Query parameters
pagenumberOptional

Page number to retrieve.

limitnumberOptional

Number of items per page.

Responses
200Success
application/json
statusCodenumberRequiredDefault: 200
countnumberRequired
errorstring · nullableRequired
get
/api/v1/companies/{id}/meetings

Delete Company Contact Relationship

delete

Deletes a relationship between a company and a contact.

Authorizations
x-api-keystringRequired
Path parameters
idstringRequired

Company ID.

contactIdstringRequired

Contact ID.

Responses
200Success
application/json
statusCodenumberRequiredDefault: 200
countnumberRequired
errorstring · nullableRequired
databooleanRequired
delete
/api/v1/companies/{id}/contacts/{contactId}

Delete Company Opportunity Relationship

delete

Deletes a relationship between a company and an opportunity.

Authorizations
x-api-keystringRequired
Path parameters
idstringRequired
opportunityIdstringRequired

Opportunity ID.

Responses
200Success
application/json
statusCodenumberRequiredDefault: 200
countnumberRequired
errorstring · nullableRequired
databooleanRequired
delete
/api/v1/companies/{id}/opportunities/{opportunityId}

Last updated

Was this helpful?