Listar empresas

get

https://api.pipe.run/v1/companies

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Endpoint utilizado para listar todos os registros de empresas cadastrados na conta do CRM PipeRun.

Query Params

show

int32

Número de itens na página de resultado.

cursor

string

Defaults to ""

Hash da próxima página.

with

string

Obter recursos com relações. Opções:personsRelated.person ,personsRelated,deals_involved,activities,emails,contactEmails,'contactPhones

city_id

int32

Filtrar pelo ID da cidade da empresa.

manager_id

int32

Filtrar pelo ID do usuário CS responsável pela empresa.

segment_id

int32

Filtrar pelo ID do segmento de negócio da empresa.

name

string

Filtrar pelo nome da empresa.

starts_with

string

Filtrar pelo início do nome da empresa.

cnpj

string

Filtrar pelo CNPJ da empresa. Formatos aceitos: "XXXXXXXX0001XX" e "XX.XXX.XXX/0001-XX".

observation

string

Filtrar pelas observações sobre a empresa.

website

string

Filtrar pelo website da empresa.

company_status

boolean

Filtrar pelo status ativo/inativo do registro da empresa.

company_situation

int32

Filtrar pela situação da empresa: 1: lead, 2: lead suspect, 3: lead qualificado de marketing (MQL), 4: lead qualificado de vendas (SQL), 5: lead aceito por vendas (SAL), 6: lead prospects (OPs), 7: cliente ativo, 8: cliente inativo, 9: cliente perdido.

status_touch

int32

Filtrar pelo modelo touch da empresa: 1: high touch, 2: middle touch, 3: low touch, 4: tech touch, 5: now touch.

is_brand

boolean

Filtrar pelo tipo de empresa: marca.

is_supplier

boolean

Filtrar pelo tipo de empresa: fornecedor.

is_client

boolean

Filtrar pelo tipo de empresa: cliente.

is_carrier

boolean

Filtrar pelo tipo de empresa: transportadora.

is_franchise

boolean

Filtrar pelo tipo de empresa: franquia.

is_channel

boolean

Filtrar pelo tipo de empresa: canal de venda.

status

boolean

Filtrar pela situação cadastral ativo/inativo da empresa.

external_code

string

Filtrar pelo código externo da empresa.

customer_at_start

date

Filtrar por registros de empresas que viraram clientes a partir da data e hora informada.

customer_at_end

date

Filtrar por registros de empresas que viraram clientes até data e hora informada.

created_at_start

date

Filtrar por registros de empresas criadas a partir da data e hora informada.

created_at_end

date

Filtrar por registros de empresas criadas até a datae hora informada.

updated_at_start

date

Filtrar por registros de pessoas atualizadas a partir da data e hora informada.

updated_at_end

date

Filtrar por registros de pessoas atualizadas até a data e hora informada.

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200

404404