List contacts with the Wrike API

Lists the users and user groups of the account with their ids, which the responsibles, owners and shareds arguments take, and the email of each user in profiles. With me true it returns only the connected user.

Identifier
wrike_list_contacts

The request

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

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "me": true
  }
}

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
mebooleanNoTrue to return only the connected user.
namestringNoOnly contacts whose name matches this text.
emailsstringNoOnly the users with these emails: JSON array, such as ["ana@example.com"].
typesstringNoOnly these contact types: JSON array of Person, Group, ServiceAccount, Asset, Robot and Workmate, such as ["Person"].
activebooleanNoTrue for active users only, false for inactive ones.
deletedbooleanNoTrue for deleted contacts, false for the others.

Supported connections

Your customer connects their Wrike 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/wrike, 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 {host}: 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/wrike_list_contacts. It becomes your agent's tool definition with no conversion.

Other Wrike tools

See all 13 tools

Toolkits in the same category

See all 100 toolkits

See Connect applied to your product.

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