Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.spojit.com/llms.txt

Use this file to discover all available pages before exploring further.

The Front connector lets your workflows manage shared inboxes, conversations, contacts, and messages through the Front API.
For the full API reference, see the Front API documentation.

​
Connection setup

1

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.
2

Add the connection in Spojit

Go to Connections in Spojit, click Add Connection, select Front, and enter:
  • API Token: Your Front API token

​
Tools

​
Conversations

​
q
string
Search query to filter conversations.
​
page_token
string
Pagination token from _pagination.next.
Example request:
{
  "q": "order shipping"
}
Example response:
{
  "_pagination": {
    "next": "https://api2.frontapp.com/conversations?page_token=abc123"
  },
  "_results": [
    {
      "id": "cnv_abc123",
      "subject": "Order #1234 — delivery question",
      "status": "open",
      "assignee": {
        "id": "tea_xyz789",
        "email": "alice@company.com",
        "first_name": "Alice",
        "last_name": "Johnson"
      },
      "recipient": {
        "handle": "customer@example.com",
        "role": "from"
      },
      "tags": [
        { "id": "tag_shipping", "name": "Shipping" }
      ],
      "last_message": {
        "id": "msg_111222",
        "body": "Hi, when will my order arrive?",
        "created_at": 1718460000
      },
      "created_at": 1718400000,
      "is_private": false
    },
    {
      "id": "cnv_def456",
      "subject": "Billing inquiry",
      "status": "open",
      "assignee": null,
      "recipient": {
        "handle": "billing@example.com",
        "role": "from"
      },
      "tags": [],
      "created_at": 1718380000,
      "is_private": false
    }
  ]
}
​
id
string
required
Conversation ID.
Example request:
{
  "id": "cnv_abc123"
}
Example response:
{
  "id": "cnv_abc123",
  "subject": "Order #1234 — delivery question",
  "status": "open",
  "assignee": {
    "id": "tea_xyz789",
    "email": "alice@company.com",
    "first_name": "Alice",
    "last_name": "Johnson"
  },
  "recipient": {
    "handle": "customer@example.com",
    "role": "from"
  },
  "tags": [
    { "id": "tag_shipping", "name": "Shipping" }
  ],
  "inboxes": [
    { "id": "inb_support", "name": "Support" }
  ],
  "created_at": 1718400000,
  "is_private": false,
  "_links": {
    "self": "https://api2.frontapp.com/conversations/cnv_abc123",
    "related": {
      "messages": "https://api2.frontapp.com/conversations/cnv_abc123/messages",
      "events": "https://api2.frontapp.com/conversations/cnv_abc123/events"
    }
  }
}

​
Inboxes

No parameters required. Returns all inboxes accessible to the authenticated token.Example response:
{
  "_results": [
    {
      "id": "inb_support",
      "name": "Support",
      "address": "support@company.com",
      "type": "smtp",
      "is_private": false
    },
    {
      "id": "inb_sales",
      "name": "Sales",
      "address": "sales@company.com",
      "type": "smtp",
      "is_private": false
    },
    {
      "id": "inb_billing",
      "name": "Billing",
      "address": "billing@company.com",
      "type": "smtp",
      "is_private": true
    }
  ]
}

​
Contacts

​
q
string
Search query to filter contacts.
​
page_token
string
Pagination token from _pagination.next.
Example request:
{
  "q": "example.com"
}
Example response:
{
  "_pagination": {},
  "_results": [
    {
      "id": "crd_abc123",
      "name": "John Smith",
      "description": "VIP customer",
      "handles": [
        { "handle": "john@example.com", "source": "email" }
      ],
      "groups": [
        { "id": "grp_vip", "name": "VIP" }
      ],
      "is_spammer": false,
      "updated_at": 1718460000
    },
    {
      "id": "crd_def456",
      "name": "Jane Doe",
      "description": "",
      "handles": [
        { "handle": "jane@example.com", "source": "email" },
        { "handle": "+15005550006", "source": "phone" }
      ],
      "groups": [],
      "is_spammer": false,
      "updated_at": 1718400000
    }
  ]
}
​
id
string
required
Contact ID.
Example request:
{
  "id": "crd_abc123"
}
Example response:
{
  "id": "crd_abc123",
  "name": "John Smith",
  "description": "VIP customer",
  "handles": [
    { "handle": "john@example.com", "source": "email" }
  ],
  "groups": [
    { "id": "grp_vip", "name": "VIP" }
  ],
  "is_spammer": false,
  "updated_at": 1718460000,
  "_links": {
    "self": "https://api2.frontapp.com/contacts/crd_abc123",
    "related": {
      "conversations": "https://api2.frontapp.com/contacts/crd_abc123/conversations"
    }
  }
}
​
name
string
Contact name.
​
description
string
Contact description or notes.
​
handles
object[]
required
Contact handles (email, phone, etc.). Each object has handle (the value) and source (e.g., email, phone, twitter).
Example request:
{
  "name": "Emily Chen",
  "description": "New enterprise lead",
  "handles": [
    { "handle": "emily@bigcorp.com", "source": "email" },
    { "handle": "+15005550007", "source": "phone" }
  ]
}
Example response:
{
  "id": "crd_ghi789",
  "name": "Emily Chen",
  "description": "New enterprise lead",
  "handles": [
    { "handle": "emily@bigcorp.com", "source": "email" },
    { "handle": "+15005550007", "source": "phone" }
  ],
  "groups": [],
  "is_spammer": false,
  "updated_at": 1718550000
}

​
Messages

​
channelId
string
required
Channel ID to send from.
​
to
string[]
required
Array of recipient handles.
​
body
string
required
Message body (HTML supported).
​
subject
string
Message subject (for email channels).
​
options
object
Additional options (e.g., { "archive": true, "tag_ids": [] }).
Example request:
{
  "channelId": "cha_abc123",
  "to": ["customer@example.com"],
  "body": "<p>Hi John,</p><p>Your order #1234 shipped today via FedEx. Tracking number: <strong>7891011</strong>.</p><p>Best,<br>Support Team</p>",
  "subject": "Your order has shipped"
}
Example response:
{
  "success": true,
  "data": {
    "status": "accepted",
    "message_uid": "msg_uid_abc123"
  }
}

​
Tags

No parameters required. Returns all tags in the workspace.Example response:
{
  "_results": [
    {
      "id": "tag_shipping",
      "name": "Shipping",
      "is_private": false
    },
    {
      "id": "tag_billing",
      "name": "Billing",
      "is_private": false
    },
    {
      "id": "tag_urgent",
      "name": "Urgent",
      "is_private": false
    }
  ]
}
​
conversationId
string
required
Conversation ID.
​
tag_ids
string[]
required
Array of tag IDs to add.
Example request:
{
  "conversationId": "cnv_abc123",
  "tag_ids": ["tag_urgent", "tag_shipping"]
}
Example response:
{
  "success": true
}

​
Teammates

No parameters required. Returns all teammates in the workspace.Example response:
{
  "_results": [
    {
      "id": "tea_xyz789",
      "email": "alice@company.com",
      "first_name": "Alice",
      "last_name": "Johnson",
      "is_admin": true,
      "is_available": true
    },
    {
      "id": "tea_uvw456",
      "email": "bob@company.com",
      "first_name": "Bob",
      "last_name": "Williams",
      "is_admin": false,
      "is_available": true
    }
  ]
}

​
Advanced

Send a request to any Front API endpoint.
​
method
string
required
HTTP method: GET, POST, PUT, PATCH, or DELETE.
​
path
string
required
API path (e.g., /conversations, /contacts).
​
body
object
Request body for POST/PUT/PATCH requests.
Example request:
{
  "method": "GET",
  "path": "/events"
}
Example response:
{
  "_results": [
    {
      "id": "evt_111",
      "type": "assign",
      "emitted_at": 1718460000,
      "conversation": { "id": "cnv_abc123" },
      "target": {
        "id": "tea_xyz789",
        "email": "alice@company.com"
      }
    }
  ]
}