List teammates with the Front API
Lists the teammates of the company with id, email, username, name and availability. The id is the assignee_id and author_id of the other tools and the assignee: filter of Search conversations.
- Identifier
- front_list_teammates
The request
POST https://connect.reportei.com/api/tools/front_list_teammates/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {}
}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
This tool takes no arguments.
Supported connections
Your customer connects their Front account once, with one of the modes below. The same connection serves every tool of the toolkit.
API key
Your customer pastes the app's key on a Connect screen, or your system sends the key with POST /api/customer-toolkits, with no screen.
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/front_list_teammates. It becomes your agent's tool definition with no conversion.
Other Front tools
- Search conversationsGETSearches the conversations the API token can reach, most recent activity first, and returns _total with the matches. Trashed conversations are left out unless the query asks for is:trashed. The next page comes from the page_token inside _pagination.next, which is null on the last page.
- Get conversationGETReturns a conversation with its subject, status, assignee, main recipient, tags, custom fields and links. The messages come from List conversation messages.
- List conversation messagesGETLists the messages of a conversation, newest first unless sort_order is asc, with author, recipients, subject, body and attachment details. The next page comes from the page_token inside _pagination.next, which is null on the last page.
- Update conversationPATCHUpdates the assignee, inbox, status, tags or custom fields of a conversation. Send only the fields to change. tag_ids replaces every tag of the conversation, so use Apply tags to add tags without removing the others.
- Apply tagsPOSTAdds one or more tags to a conversation and keeps the tags it already has.
- Create commentPOSTAdds an internal comment to a conversation. Comments are seen only by teammates, never by the contact. The body accepts Markdown.
- Create draftPOSTCreates a draft reply to the last message of a conversation, for a teammate to review and send in Front. Nothing is sent. A private draft is visible only to its author, so set author_id to the teammate who will review it, or use mode shared.
- Reply to conversationPOSTSends a reply in a conversation right away and answers 202 with a message_uid. Front archives the conversation when the reply goes out, unless options.archive is false. Needs the send permission on the API token. A merged conversation answers with a redirect to the conversation it was merged into.
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.
