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

ParameterTypeRequiredDescription
searchTermstringNoText to search people by.
userTypestringNoOnly people of this type.Values: account, collaborator, contact, client
includeClientsbooleanNoTrue to include the people of client companies.
orderBystringNoField to sort by.Values: name, company, dateupdated
orderModestringNoSort order.Values: asc, desc
pageintegerNoPage to fetch, starting at 1.
pageSizeintegerNoItems 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.

See Connect applied to your product.

Try it for 15 days with no card, or walk our team through your use case.