Listar projetos no Teamwork.com, por uma API

Lista os projetos a que o usuário conectado tem acesso, 50 por página por padrão. Pagine com page, a partir de 1, enquanto meta.page.hasMore na resposta for true.

Identificador
teamwork_list_projects

A chamada

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

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "searchTerm": "<searchTerm>"
  }
}

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
searchTermstringNãoOnly projects whose name contains this text.
projectStatusesstringNãoComma-separated statuses to filter by: active, inactive, archived, current, late, upcoming, completed or deleted.
onlyStarredProjectsbooleanNãoTrue to return only the projects the user starred.
includeArchivedProjectsbooleanNãoTrue to include archived projects.
updatedAfterstringNãoOnly projects updated after this moment, as an ISO 8601 date-time.
orderBystringNãoField to sort by.Valores: name, datecreated, startdate, duedate, lastactivity, companyname, status, health, taskcompletion
orderModestringNãoSort order.Valores: asc, desc
pageintegerNãoPage to fetch, starting at 1.
pageSizeintegerNãoItems per page, 50 by default and up to 500.

Conexões possíveis

O seu cliente conecta a conta do Teamwork.com uma vez, por um dos modos abaixo. A mesma conexão serve para todas as tools do toolkit.

OAuth com o app do seu produto

Você cadastra o app OAuth do seu produto uma vez, em POST /api/merchants/credentials/teamwork, e o cliente autoriza a conta numa tela de consentimento. O Connect renova o token quando ele está para vencer.

Na conexão, o cliente informa também {site}: 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/teamwork_list_projects. 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.