Listar personas en Teamwork.com, con una API
Lista las personas del sitio con sus ids, que aceptan los argumentos assignee y user, y sus correos. Pagina con page, desde 1, mientras meta.page.hasMore en la respuesta sea true.
- Identificador
- teamwork_list_people
La llamada
POST https://connect.reportei.com/api/tools/teamwork_list_people/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"searchTerm": "<searchTerm>"
}
}Tu sistema envía el id de la conexión de tu cliente y los argumentos de la tool. Los headers son los mismos de toda la API de Connect: el token de tu producto y el token de tu cliente.
Parámetros
Las descripciones de los parámetros siguen la documentación oficial de la app, en inglés.
| Parámetro | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| searchTerm | string | No | Text to search people by. |
| userType | string | No | Only people of this type.Valores: account, collaborator, contact, client |
| includeClients | boolean | No | True to include the people of client companies. |
| orderBy | string | No | Field to sort by.Valores: name, company, dateupdated |
| orderMode | string | No | Sort order.Valores: asc, desc |
| page | integer | No | Page to fetch, starting at 1. |
| pageSize | integer | No | Items per page, 50 by default and up to 500. |
Conexiones posibles
Tu cliente conecta su cuenta de Teamwork.com una sola vez, con uno de los modos de abajo. La misma conexión sirve para todas las tools del toolkit.
OAuth con la app de tu producto
Registras la app OAuth de tu producto una sola vez, con POST /api/merchants/credentials/teamwork, y tu cliente autoriza la cuenta en una pantalla de consentimiento. Connect renueva el token cuando está por vencer.
Al conectar, tu cliente también indica {site}: la dirección de su cuenta en la API de la app.
La respuesta
Si la llamada tiene éxito, Connect conserva el status y el cuerpo de la respuesta de la app. Los errores HTTP devueltos por la app usan el objeto {error, api_error}; la autenticación o validación pueden fallar antes de la ejecución. El header X-Toolkit-Execution-Id identifica la ejecución registrada, disponible en GET /api/tools/executions/{uuid}.
Lista para agentes de IA
El input de esta tool es un JSON Schema, disponible en GET /api/tools/teamwork_list_people. Se convierte en la definición de tool de tu agente sin conversión.
Otras tools de Teamwork.com
- Listar proyectosGETLista los proyectos a los que el usuario conectado tiene acceso, 50 por página por defecto. Pagina con page, desde 1, mientras meta.page.hasMore en la respuesta sea true.
- Listar listas de tareasGETLista las listas de tareas de un proyecto. Las tareas se crean dentro de una lista. Pagina con page, desde 1, mientras meta.page.hasMore en la respuesta sea true.
- Listar tareasGETLista las tareas a las que el usuario conectado tiene acceso, en todos los proyectos o por proyecto, lista de tareas o asignado, 50 por página por defecto y sin las tareas completadas, salvo que se pidan. Pagina con page, desde 1, mientras meta.page.hasMore en la respuesta sea true.
- Obtener tareaGETDevuelve una tarea con descripción, estado, prioridad, fechas, asignados, estimación y progreso.
- Crear tareaPOSTCrea una tarea en una lista de tareas. Requiere task con un name. Las fechas son yyyy-MM-dd.
- Actualizar tareaPATCHActualiza los campos enviados de una tarea y conserva los demás. Para completar una tarea, usa Complete task. Las fechas son yyyy-MM-dd.
- Completar tareaPUTMarca una tarea como completada. Es la ruta que Teamwork documenta para completar tareas, en la API v1.
- Eliminar tareaDELETEElimina una tarea y sus subtareas.
Toolkits de la misma categoría
Ver los 100 toolkitsMira Connect aplicado a tu producto.
Pruébalo durante 15 días sin tarjeta, o cuéntale tu caso a nuestro equipo.
