Listar clientes no Clockify, por uma API

Lista os clientes de um workspace, 50 por página. Uma página com menos de 50 clientes é a última.

Identificador
clockify_list_clients

A chamada

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

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

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
workspaceIdstringSimId of the workspace, from List workspaces or the activeWorkspace of Get current user.
namestringNãoOnly clients whose name contains this text.
archivedstringNãotrue for archived clients only, false for active ones only. Leave it out for both.
pageintegerNãoPage to fetch, starting at 1. Pages have 50 items, and a page with fewer is the last one.

Conexões possíveis

O seu cliente conecta a conta do Clockify 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 {region}: 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/clockify_list_clients. 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.