List people with the Teamwork.com API
Lists the people of the site with their ids, which the assignee and user arguments take, and their emails. Page through with page, from 1, while meta.page.hasMore in the response is true.
- Identifier
- teamwork_list_people
The request
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>"
}
}Your system sends your customer's connection id and the tool arguments. The headers are the same as the rest of the Connect API: your product's token and your customer's token.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| searchTerm | string | No | Text to search people by. |
| userType | string | No | Only people of this type.Values: account, collaborator, contact, client |
| includeClients | boolean | No | True to include the people of client companies. |
| orderBy | string | No | Field to sort by.Values: name, company, dateupdated |
| orderMode | string | No | Sort order.Values: asc, desc |
| page | integer | No | Page to fetch, starting at 1. |
| pageSize | integer | No | Items per page, 50 by default and up to 500. |
Supported connections
Your customer connects their Teamwork.com account once, with one of the modes below. The same connection serves every tool of the toolkit.
OAuth with your product's app
You register your product's OAuth app once, with POST /api/merchants/credentials/teamwork, and your customer authorizes the account on a consent screen. Connect renews the token when it is about to expire.
When connecting, your customer also enters {site}: the address of their account on the app's API.
The response
On success, Connect preserves the app's response status and body. HTTP errors returned by the app use the {error, api_error} envelope; authentication or validation can fail before execution. The X-Toolkit-Execution-Id header identifies the recorded execution, available at GET /api/tools/executions/{uuid}.
Ready for AI agents
This tool's input is a JSON Schema, available at GET /api/tools/teamwork_list_people. It becomes your agent's tool definition with no conversion.
Other Teamwork.com tools
- List projectsGETLists the projects the connected user can access, 50 per page by default. Page through with page, from 1, while meta.page.hasMore in the response is true.
- List task listsGETLists the task lists of a project. Tasks are created inside a task list. Page through with page, from 1, while meta.page.hasMore in the response is true.
- List tasksGETLists the tasks the connected user can access, across projects or by project, task list or assignee, 50 per page by default and without completed tasks unless asked. Page through with page, from 1, while meta.page.hasMore in the response is true.
- Get taskGETReturns a task with its description, status, priority, dates, assignees, estimate and progress.
- Create taskPOSTCreates a task in a task list. Requires task with a name. Dates are yyyy-MM-dd.
- Update taskPATCHUpdates the fields sent of a task and keeps the others. To complete a task, use Complete task. Dates are yyyy-MM-dd.
- Complete taskPUTMarks a task as complete. It is the route Teamwork documents for completing tasks, in API v1.
- Delete taskDELETEDeletes a task and its subtasks.
Toolkits in the same category
See all 100 toolkitsSee Connect applied to your product.
Try it for 15 days with no card, or walk our team through your use case.
