Companies

Operations related to companies

Get all Companies

get

Returns a list of companies with pagination support.

Autorizaciones
x-api-keystringRequerido
Parámetros de consulta
pagenumberOpcional

Page number to retrieve.

limitnumberOpcional

Number of items per page.

namestringOpcional

Company name to filter companies by (partial match).

domainstringOpcional

Company domain to filter companies by (partial match).

opportunityIdstringOpcional

Opportunity ID to filter companies by opportunity relationship.

Respuestas
chevron-right
200Éxito
application/json
get
/api/v1/companies

Create Company

post

Creates a new company.

Autorizaciones
x-api-keystringRequerido
Cuerpo
namestringRequerido

Name of the company

Example: Acme Corporation
domainstringRequerido

Company domain

Example: acme.com
descriptionstringOpcional

Company description

Example: Leading provider of innovative solutions
industrystringOpcional

Company industry

Example: Technology
phonestringOpcional

Company phone number

Example: +1-555-123-4567
emailstringOpcional

Company email address

Example: [email protected]
currencystringOpcional

Company currency

Example: USD
addressstringOpcional

Company address

Example: 123 Main Street
postalCodestringOpcional

Postal code

Example: 12345
citystringOpcional

City

Example: New York
nEmployeesnumberOpcional

Number of employees

Example: 150
sourcestringOpcional

Company source

Example: Website
annualRevenuenumberOpcional

Annual revenue

Example: 1000000
statusstringOpcional

Company status

Example: Active
foundationYearnumberOpcional

Foundation year

Example: 2020
sellRatingnumberOpcional

Sell rating (0-100)

Example: 85
linkedinUrlstringOpcional

LinkedIn URL

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

Parent company ID

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

Get Company by ID

get

Get a company by ID.

Autorizaciones
x-api-keystringRequerido
Parámetros de ruta
idstringRequerido

Company ID to retrieve.

Respuestas
chevron-right
200Éxito
application/json
get
/api/v1/companies/{id}

Update Company

put

Updates an existing company.

Autorizaciones
x-api-keystringRequerido
Parámetros de ruta
idstringRequerido

Company ID to update.

Cuerpo
namestringOpcional

Name of the company

Example: Acme Corporation
domainstringOpcional

Company domain

Example: acme.com
descriptionstringOpcional

Company description

Example: Leading provider of innovative solutions
industrystringOpcional

Company industry

Example: Technology
phonestringOpcional

Company phone number

Example: +1-555-123-4567
emailstringOpcional

Company email address

Example: [email protected]
currencystringOpcional

Company currency

Example: USD
addressstringOpcional

Company address

Example: 123 Main Street
postalCodestringOpcional

Postal code

Example: 12345
citystringOpcional

City

Example: New York
nEmployeesnumberOpcional

Number of employees

Example: 150
sourcestringOpcional

Company source

Example: Website
annualRevenuenumberOpcional

Annual revenue

Example: 1000000
statusstringOpcional

Company status

Example: Active
foundationYearnumberOpcional

Foundation year

Example: 2020
sellRatingnumberOpcional

Sell rating (0-100)

Example: 85
linkedinUrlstringOpcional

LinkedIn URL

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

Parent company ID

Example: 5516cd47-2bd0-4f4f-adc2-22524e54ba4d
Respuestas
chevron-right
200Éxito
application/json
put
/api/v1/companies/{id}

Delete Company

delete

Deletes a company by ID.

Autorizaciones
x-api-keystringRequerido
Parámetros de ruta
idstringRequerido

Company ID to delete.

Respuestas
chevron-right
200Éxito
application/json
delete
/api/v1/companies/{id}

Get Company Integrations

get

Returns a list of integrations for a given company ID.

Autorizaciones
x-api-keystringRequerido
Parámetros de ruta
idstringRequerido

Company ID to get integrations from.

Respuestas
chevron-right
200Éxito
application/json
get
/api/v1/companies/{id}/integrations

Get Company Contacts

get

Returns a list of contacts associated with a company.

Autorizaciones
x-api-keystringRequerido
Parámetros de ruta
idstringRequerido

Company ID to get contacts from.

Parámetros de consulta
pagenumberOpcional

Page number to retrieve.

limitnumberOpcional

Number of items per page.

Respuestas
chevron-right
200Éxito
application/json
get
/api/v1/companies/{id}/contacts

Create Company Contact Relationship

post

Creates a relationship between a company and a contact.

Autorizaciones
x-api-keystringRequerido
Parámetros de ruta
idstringRequerido

Company ID.

Cuerpo
contactIdstringRequerido

Contact ID

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

Get Company Opportunities

get

Returns a list of opportunities associated with a company.

Autorizaciones
x-api-keystringRequerido
Parámetros de ruta
idstringRequerido

Company ID to get opportunities from.

Parámetros de consulta
pagenumberOpcional

Page number to retrieve.

limitnumberOpcional

Number of items per page.

Respuestas
chevron-right
200Éxito
application/json
get
/api/v1/companies/{id}/opportunities

Create Company Opportunity Relationship

post

Creates a relationship between a company and an opportunity.

Autorizaciones
x-api-keystringRequerido
Parámetros de ruta
idstringRequerido

Company ID.

Cuerpo
opportunityIdstringRequerido

Opportunity ID

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

Delete Company Contact Relationship

delete

Deletes a relationship between a company and a contact.

Autorizaciones
x-api-keystringRequerido
Parámetros de ruta
idstringRequerido

Company ID.

contactIdstringRequerido

Contact ID.

Respuestas
chevron-right
200Éxito
application/json
delete
/api/v1/companies/{id}/contacts/{contactId}

Delete Company Opportunity Relationship

delete

Deletes a relationship between a company and an opportunity.

Autorizaciones
x-api-keystringRequerido
Parámetros de ruta
idstringRequerido
opportunityIdstringRequerido

Opportunity ID.

Respuestas
chevron-right
200Éxito
application/json
delete
/api/v1/companies/{id}/opportunities/{opportunityId}

Última actualización

¿Te fue útil?