Listar cenários no Make, por uma API

Lista os cenários de um time ou de uma organização inteira: envie teamId ou organizationId, nunca os dois. Cada item traz o id e o name do cenário.

Identificador
make_list_scenarios

A chamada

POST https://connect.reportei.com/api/tools/make_list_scenarios/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "teamId": 1
  }
}

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âmetroTipoObrigatórioDescrição
teamIdintegerNãoId of the team, from List teams. Do not send it together with organizationId.
organizationIdintegerNãoId of the organization, from List organizations, to list the scenarios of all its teams. Do not send it together with teamId.
searchstringNãoCase-insensitive text matched against the scenario names. A number also matches the scenario with that id.
isActivebooleanNãoSet to true to return only active scenarios.
isinvalidbooleanNãoSet to true to return only scenarios whose blueprint failed validation, or false for the valid ones.

Conexões possíveis

O seu cliente conecta a conta do Make 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.

Na conexão, o cliente informa também {zone}: o endereço da conta dele na API do app.

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/make_list_scenarios. Ele vira a definição de tool do seu agente sem conversão.

Veja o Connect aplicado ao seu produto.

Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.