For the full API reference, see the Front API documentation.
Connection setup
Create an API token
In Front, go to Settings > Developers > API Tokens. Click Create API Token, give it a name, and select the scopes your workflows need. Copy the generated token.
Tools
Conversations
list-conversations: List conversations
list-conversations: List conversations
get-conversation: Get a conversation by ID
get-conversation: Get a conversation by ID
Inboxes
list-inboxes: List inboxes
list-inboxes: List inboxes
No parameters required. Returns all inboxes accessible to the authenticated token.Example response:
Contacts
list-contacts: List contacts
list-contacts: List contacts
get-contact: Get a contact by ID
get-contact: Get a contact by ID
Messages
send-message: Send a message from a channel
send-message: Send a message from a channel
Channel ID to send from.
Array of recipient handles.
Message body (HTML supported).
Message subject (for email channels).
Additional options (e.g.,
{ "archive": true, "tag_ids": [] }).Tags
list-tags: List tags
list-tags: List tags
add-tag: Add tags to a conversation
add-tag: Add tags to a conversation
Teammates
list-teammates: List teammates
list-teammates: List teammates
No parameters required. Returns all teammates in the workspace.Example response:
Advanced
raw-api-request: Make an arbitrary API request
raw-api-request: Make an arbitrary API request