Listar oportunidades no Salesflare, por uma API
Lista as oportunidades, com etapa, valor, conta e responsável. close_after e close_before filtram por close_date. Pagine com limit e offset; uma página menor que limit é a última.
- Identificador
- salesflare_list_opportunities
A chamada
POST https://connect.reportei.com/api/tools/salesflare_list_opportunities/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"search": "<search>"
}
}Seu sistema envia o id da conexão do cliente e os argumentos da tool. Os headers são os mesmos de toda a API do Connect: o token do seu produto e o token do cliente.
Parâmetros
As descrições dos parâmetros seguem a documentação oficial do app, em inglês.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| search | string | Não | Text to search for in the opportunities. |
| id | integer | Não | Id of one opportunity, from List opportunities or Create opportunity, to read only that one. |
| name | string | Não | Name of the opportunity. |
| pipeline | integer | Não | Id of a pipeline, from List pipelines. |
| stage | integer | Não | Id of a stage, from the stages of List pipelines. |
| account | integer | Não | Id of an account, from List accounts. |
| owner | integer | Não | Id of the owner, from List users. |
| closed | boolean | Não | Filters by closed. |
| done | boolean | Não | Filters by done. |
| min_value | number | Não | Lowest value. |
| max_value | number | Não | Highest value. |
| close_after | string | Não | Only the opportunities with close_date after this moment, in ISO 8601. |
| close_before | string | Não | Only the opportunities with close_date before this moment, in ISO 8601. |
| order_by | array | Não | Sort keys, each a field name for ascending or the name followed by desc, such as value desc. |
| limit | integer | Não | Opportunities per page. |
| offset | integer | Não | Opportunities to skip, for the next page. |
Conexões possíveis
O seu cliente conecta a conta do Salesflare uma vez, por um dos modos abaixo. A mesma conexão serve para todas as tools do toolkit.
Chave de API
O cliente cola a chave do app numa tela do Connect, ou o seu sistema envia a chave por POST /api/customer-toolkits, sem tela.
A resposta
Em caso de sucesso, o Connect preserva o status e o corpo da resposta do app. Erros HTTP retornados pelo app usam o envelope {error, api_error}; falhas de autenticação ou validação podem ocorrer antes da execução. O header X-Toolkit-Execution-Id identifica a execução registrada, consultável em GET /api/tools/executions/{uuid}.
Pronta para agentes de IA
O input desta tool é um JSON Schema, disponível em GET /api/tools/salesflare_list_opportunities. Ele vira a definição de tool do seu agente sem conversão.
Outras tools do Salesflare
- Listar contasGETLista as contas, as empresas do time, 10 por página por padrão. Pagine com limit e offset; uma página menor que limit é a última.
- Obter contaGETRetorna uma conta com endereços, emails, telefones, tags e campos personalizados.
- Criar contaPOSTCria uma conta, a empresa à qual contatos e oportunidades pertencem. Retorna a nova conta com seu id.
- Atualizar contaPUTAtualiza os campos informados de uma conta.
- Listar contatosGETLista os contatos do time, 20 por página por padrão. Pagine com limit e offset; uma página menor que limit é a última.
- Obter contatoGETRetorna um contato com sua conta, cargos, telefones, endereços, tags e campos personalizados.
- Criar contatoPOSTCria um contato, vinculado a uma conta com account. Retorna o novo contato com seu id.
- Atualizar contatoPUTAtualiza os campos informados de um contato. archived true o arquiva.
Toolkits da mesma categoria
Ver os 100 toolkitsVeja o Connect aplicado ao seu produto.
Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.
