### Authentication Example

Source: https://context7.com/frontapp/postman-core-api/llms.txt

Demonstrates how to authenticate requests using a Bearer JWT token.

```APIDOC
## Authentication

All endpoints require a Bearer token. API tokens are generated in the Front settings and scoped to specific resource permissions (e.g., `conversations:read`, `messages:send`).

```bash
# All requests use Bearer token authentication
curl -H "Authorization: Bearer <YOUR_API_TOKEN>" \
     -H "Accept: application/json" \
     https://api2.frontapp.com/me
# Response: { "id": "tea_abc", "email": "alice@example.com", "first_name": "Alice", ... }
```
```

--------------------------------

### List Tags - GET /tags

Source: https://context7.com/frontapp/postman-core-api/llms.txt

Lists all tags in the company with pagination. Requires `tags:read` scope. Supports limiting the number of results.

```bash
curl -s -X GET "https://api2.frontapp.com/tags?limit=50" \
  -H "Authorization: Bearer $FRONT_TOKEN" \
  -H "Accept: application/json"
```

--------------------------------

### GET /me — Get current teammate

Source: https://context7.com/frontapp/postman-core-api/llms.txt

Returns the authenticated teammate's profile, including their ID, email, availability status, and linked resources.

```APIDOC
## GET /me — Get current teammate

Returns the authenticated teammate's profile, including their ID, email, availability status, and linked resources.

```bash
curl -s -X GET https://api2.frontapp.com/me \
  -H "Authorization: Bearer $FRONT_TOKEN" \
  -H "Accept: application/json"
# Response:
# {
#   "_links": { "self": "https://yourCompany.api.frontapp.com/teammates/tea_abc" },
#   "id": "tea_abc",
#   "email": "alice@example.com",
#   "username": "alice",
#   "first_name": "Alice",
#   "last_name": "Smith",
#   "is_admin": false,
#   "is_available": true,
#   "is_blocked": false
# }
```
```

--------------------------------

### GET /accounts — List accounts

Source: https://context7.com/frontapp/postman-core-api/llms.txt

Lists all company accounts with optional sorting and cursor-based pagination. Requires `accounts:read` scope.

```APIDOC
## GET /accounts — List accounts

Lists all company accounts with optional sorting and cursor-based pagination. Requires `accounts:read` scope.

```bash
curl -s -X GET "https://api2.frontapp.com/accounts?limit=25&sort_by=updated_at&sort_order=desc" \
  -H "Authorization: Bearer $FRONT_TOKEN" \
  -H "Accept: application/json"
# Response:
# {
#   "_pagination": { "next": "https://...?page_token=abc123" },
#   "_links": { "self": "https://yourCompany.api.frontapp.com/accounts" },
#   "_results": [
#     { "id": "acc_76", "name": "Dunder Mifflin, Inc.", "domains": ["dundermifflininc.com"],
#       "description": "Limitless Paper in a Paperless World", "external_id": "8739674733",
#       "custom_fields": {}, "created_at": 1622672452.363, "updated_at": 1654309308.278,
#       "_links": { "self": "...", "related": { "contacts": "..." } } }
#   ]
# }
```
```

--------------------------------

### Get Current Teammate Profile

Source: https://context7.com/frontapp/postman-core-api/llms.txt

Retrieves the profile of the currently authenticated teammate. This includes their ID, email, availability status, and linked resources.

```bash
curl -s -X GET https://api2.frontapp.com/me \
  -H "Authorization: Bearer $FRONT_TOKEN" \
  -H "Accept: application/json"
```

--------------------------------

### Fetch Analytics Export - GET /analytics/exports/{export_id}

Source: https://context7.com/frontapp/postman-core-api/llms.txt

Polls the status of an analytics export and retrieves the download URL when complete. Requires `analytics:read` scope. Poll until status is 'done'.

```bash
# Poll until status = "done"
curl -s -X GET https://api2.frontapp.com/analytics/exports/exp_o9y1a \
  -H "Authorization: Bearer $FRONT_TOKEN" \
  -H "Accept: application/json"
```

--------------------------------

### Get a single conversation

Source: https://context7.com/frontapp/postman-core-api/llms.txt

Fetches a single conversation by ID with full metadata. Requires `conversations:read` scope.

```bash
curl -s -X GET https://api2.frontapp.com/conversations/cnv_abc \
  -H "Authorization: Bearer $FRONT_TOKEN" \
  -H "Accept: application/json"
# Response:
# {
#   "id": "cnv_abc", "subject": "Order issue", "status": "assigned",
#   "assignee": { "id": "tea_xyz", "email": "support@acme.com" },
#   "tags": [{ "id": "tag_1", "name": "urgent" }],
#   "links": [], "created_at": 1700000000.0,
#   "_links": { "self": "...", "related": { "messages": "...", "comments": "..." } }
# }
```

--------------------------------

### List Inbox Conversations - GET /inboxes/{inbox_id}/conversations

Source: https://context7.com/frontapp/postman-core-api/llms.txt

Lists all conversations in a specific inbox. Supports `q` filter and pagination. Requires `conversations:read` scope.

```bash
curl -s -X GET "https://api2.frontapp.com/inboxes/inb_123/conversations?limit=25" \
  -H "Authorization: Bearer $FRONT_TOKEN" \
  -H "Accept: application/json"
```

--------------------------------

### Get conversation

Source: https://context7.com/frontapp/postman-core-api/llms.txt

Fetches a single conversation by ID with full metadata. Requires `conversations:read` scope.

```APIDOC
## GET /conversations/{conversation_id}

### Description
Fetches a single conversation by ID with full metadata.

### Method
GET

### Endpoint
/conversations/{conversation_id}

### Parameters
#### Path Parameters
- **conversation_id** (string) - Required - The ID of the conversation to fetch.

### Response
#### Success Response (200 OK)
Returns the full Conversation object.

#### Response Example
```json
{
  "id": "cnv_abc", "subject": "Order issue", "status": "assigned",
  "assignee": { "id": "tea_xyz", "email": "support@acme.com" },
  "tags": [{ "id": "tag_1", "name": "urgent" }],
  "links": [], "created_at": 1700000000.0,
  "_links": { "self": "...", "related": { "messages": "...", "comments": "..." } }
}
```
```

--------------------------------

### GET /accounts/{account_id}/contacts — List account contacts

Source: https://context7.com/frontapp/postman-core-api/llms.txt

Lists all contacts associated with a given account, with pagination and sorting support. Requires `accounts:read` scope.

```APIDOC
## GET /accounts/{account_id}/contacts — List account contacts

Lists all contacts associated with a given account, with pagination and sorting support. Requires `accounts:read` scope.

```bash
curl -s -X GET "https://api2.frontapp.com/accounts/acc_76/contacts?limit=10&sort_by=created_at&sort_order=asc" \
  -H "Authorization: Bearer $FRONT_TOKEN" \
  -H "Accept: application/json"
# Response: { "_pagination": {...}, "_results": [ { "id": "crd_abc", "name": "Jim Halpert", ... } ] }
```
```

--------------------------------

### Create Tag - POST /tags

Source: https://context7.com/frontapp/postman-core-api/llms.txt

Creates a new tag. Requires `tags:write` scope. Specify name, highlight color, and visibility.

```bash
curl -s -X POST https://api2.frontapp.com/tags \
  -H "Authorization: Bearer $FRONT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ \
    "name": "VIP Customer", \
    "highlight": "yellow", \
    "is_visible_in_conversation_lists": true \
  }'
```

--------------------------------

### List Knowledge Bases

Source: https://context7.com/frontapp/postman-core-api/llms.txt

Fetches a list of all knowledge bases within the company. Requires the `knowledge_bases:read` scope.

```bash
curl -s -X GET https://api2.frontapp.com/knowledge_bases \
  -H "Authorization: Bearer $FRONT_TOKEN" \
  -H "Accept: application/json"
```

--------------------------------

### List Rules

Source: https://context7.com/frontapp/postman-core-api/llms.txt

Fetch all company-level automation rules. Requires `rules:read` scope.

```bash
curl -s -X GET https://api2.frontapp.com/rules \
  -H "Authorization: Bearer $FRONT_TOKEN" \
  -H "Accept: application/json"
```

--------------------------------

### POST /accounts — Create account

Source: https://context7.com/frontapp/postman-core-api/llms.txt

Creates a new account. `name` is required. Requires `accounts:write` scope.

```APIDOC
## POST /accounts — Create account

Creates a new account. `name` is required. Requires `accounts:write` scope.

```bash
curl -s -X POST https://api2.frontapp.com/accounts \
  -H "Authorization: Bearer $FRONT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "name": "Acme Corp", "description": "Global widget manufacturer", "domains": ["acmecorp.com"], "external_id": "CRM-98765", "custom_fields": { "tier": "Enterprise" } }'
# Response: 201 Created — full AccountResponse object
# { "id": "acc_99", "name": "Acme Corp", "domains": ["acmecorp.com"], ... }
```
```

--------------------------------

### List Events with Query Parameters

Source: https://context7.com/frontapp/postman-core-api/llms.txt

Use this endpoint to list company-wide events, supporting filters for types and time ranges. Requires `events:read` scope.

```bash
curl -s -X GET 'https://api2.frontapp.com/events?q={"types":["assign","tag"],"after":1700000000}&limit=50' \
  -H "Authorization: Bearer $FRONT_TOKEN" \
  -H "Accept: application/json"
```

--------------------------------

### List Knowledge Base Articles

Source: https://context7.com/frontapp/postman-core-api/llms.txt

Retrieves articles from a specific knowledge base, supporting pagination. Requires the `knowledge_bases:read` scope.

```bash
curl -s -X GET "https://api2.frontapp.com/knowledge_bases/knb_123/articles?limit=25" \
  -H "Authorization: Bearer $FRONT_TOKEN" \
  -H "Accept: application/json"
```

--------------------------------

### Pagination Pattern

Source: https://context7.com/frontapp/postman-core-api/llms.txt

Explains the cursor-based pagination pattern used across list endpoints, utilizing `page_token` and the `_pagination.next` URL.

```APIDOC
## Pagination Pattern

### Description
All list endpoints return cursor-based pagination using `page_token`. Follow the `_pagination.next` URL to retrieve subsequent pages.

### Example Usage
```bash
BASE="https://api2.frontapp.com"
TOKEN="$FRONT_TOKEN"
URL="$BASE/conversations?limit=100"

while [ -n "$URL" ]; do
  RESPONSE=$(curl -s -X GET "$URL" \
    -H "Authorization: Bearer $TOKEN" \
    -H "Accept: application/json")

  # Process results
  echo "$RESPONSE" | jq '._results[].id'

  # Get next page URL
  NEXT=$(echo "$RESPONSE" | jq -r '._pagination.next // empty')
  URL="$NEXT"
done
# Iterates all pages until _pagination.next is null
```
```

--------------------------------

### Create Analytics Report - POST /analytics/reports

Source: https://context7.com/frontapp/postman-core-api/llms.txt

Creates an asynchronous analytics report with computed metrics. Requires `analytics:read` scope. Multiple filters use AND logic; IDs within a filter use OR logic. Specify time range, timezone, filters, and metrics.

```bash
curl -s -X POST https://api2.frontapp.com/analytics/reports \
  -H "Authorization: Bearer $FRONT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ \
    "start": 1696118400, \
    "end": 1698710400, \
    "timezone": "America/Chicago", \
    "filters": { "inbox_ids": ["inb_123", "inb_456"] }, \
    "metrics": ["avg_response_time", "num_messages_received", "num_conversations_open"] \
  }'
```

--------------------------------

### List knowledge bases

Source: https://context7.com/frontapp/postman-core-api/llms.txt

Lists all knowledge bases in the company. Requires `knowledge_bases:read` scope.

```APIDOC
## GET /knowledge_bases — List knowledge bases

### Description
Lists all knowledge bases in the company.

### Method
GET

### Endpoint
https://api2.frontapp.com/knowledge_bases

### Request Headers
- Authorization: Bearer $FRONT_TOKEN
- Accept: application/json

### Response
#### Success Response (200)
- _results (array): An array of knowledge base objects.
  - id (string): The knowledge base's unique identifier.
  - name (string): The name of the knowledge base.
  - _links (object): Links to related resources.
    - self (string): URL to the knowledge base.
    - related (object): Links to related collections.
      - articles (string): URL to list articles in this knowledge base.
      - categories (string): URL to list categories in this knowledge base.

### Request Example
```bash
curl -s -X GET https://api2.frontapp.com/knowledge_bases \
  -H "Authorization: Bearer $FRONT_TOKEN" \
  -H "Accept: application/json"
```

### Response Example
```json
{
  "_results": [
    {
      "id": "knb_123",
      "name": "Product Docs",
      "_links": {
        "self": "...",
        "related": {
          "articles": "...",
          "categories": "..."
        }
      }
    }
  ]
}
```
```

--------------------------------

### Create New Account

Source: https://context7.com/frontapp/postman-core-api/llms.txt

Creates a new company account. The `name` field is required. This operation requires the `accounts:write` scope.

```bash
curl -s -X POST https://api2.frontapp.com/accounts \
  -H "Authorization: Bearer $FRONT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Acme Corp",
    "description": "Global widget manufacturer",
    "domains": ["acmecorp.com"],
    "external_id": "CRM-98765",
    "custom_fields": { "tier": "Enterprise" }
  }'
```

--------------------------------

### Create contact

Source: https://context7.com/frontapp/postman-core-api/llms.txt

Creates a new contact. At least one handle (email, phone, twitter, etc.) is required. Requires `contacts:write` scope.

```APIDOC
## POST /contacts

### Description
Creates a new contact. At least one handle (email, phone, twitter, etc.) is required.

### Method
POST

### Endpoint
/contacts

### Parameters
#### Request Body
- **name** (string) - Optional - The name of the contact.
- **description** (string) - Optional - A description for the contact.
- **handles** (array of objects) - Required - A list of handles for the contact (e.g., email, phone).
  - **handle** (string) - Required - The contact's handle (e.g., email address, phone number).
  - **source** (string) - Required - The source of the handle (e.g., `email`, `phone`, `twitter`).
- **links** (array of strings) - Optional - A list of links associated with the contact.
- **custom_fields** (object) - Optional - Custom fields for the contact.

### Request Example
```json
{
  "name": "Pam Beesly",
  "description": "Office administrator",
  "handles": [
    { "handle": "pam@dundermifflin.com", "source": "email" },
    { "handle": "+15551234567", "source": "phone" }
  ],
  "links": ["https://linkedin.com/in/pambeesly"],
  "custom_fields": { "role": "Admin" }
}
```

### Response
#### Success Response (201 Created)
Returns the full ContactResponse object for the newly created contact.
```

--------------------------------

### Create a new contact

Source: https://context7.com/frontapp/postman-core-api/llms.txt

Creates a new contact. At least one handle (email, phone, twitter, etc.) is required. Requires `contacts:write` scope.

```bash
curl -s -X POST https://api2.frontapp.com/contacts \
  -H "Authorization: Bearer $FRONT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ 
    "name": "Pam Beesly",
    "description": "Office administrator",
    "handles": [
      { "handle": "pam@dundermifflin.com", "source": "email" },
      { "handle": "+15551234567", "source": "phone" }
    ],
    "links": ["https://linkedin.com/in/pambeesly"],
    "custom_fields": { "role": "Admin" }
  }'
# Response: 201 Created — full ContactResponse object
```

--------------------------------

### Create Tag

Source: https://context7.com/frontapp/postman-core-api/llms.txt

Creates a new tag in your Front account. This operation requires the `tags:write` scope.

```APIDOC
## POST /tags — Create tag

Creates a new tag. Requires `tags:write` scope.

### Method
POST

### Endpoint
https://api2.frontapp.com/tags

### Parameters
#### Request Body
- **name** (string) - Required - The name of the tag.
- **highlight** (string) - Optional - The highlight color for the tag.
- **is_visible_in_conversation_lists** (boolean) - Optional - Whether the tag is visible in conversation lists.

### Request Example
```json
{
  "name": "VIP Customer",
  "highlight": "yellow",
  "is_visible_in_conversation_lists": true
}
```

### Response
#### Success Response (201 Created)
- Returns the created tag object, including its `id`.
```

--------------------------------

### List Links

Source: https://context7.com/frontapp/postman-core-api/llms.txt

Fetches all links in the company, with an option to filter by type. Requires the `links:read` scope.

```bash
curl -s -X GET "https://api2.frontapp.com/links?q={\"types\":[\"web\"]}&limit=25" \
  -H "Authorization: Bearer $FRONT_TOKEN" \
  -H "Accept: application/json"
```

--------------------------------

### List KB articles

Source: https://context7.com/frontapp/postman-core-api/llms.txt

Lists articles within a knowledge base with pagination. Requires `knowledge_bases:read` scope.

```APIDOC
## GET /knowledge_bases/{knowledge_base_id}/articles — List KB articles

### Description
Lists articles within a knowledge base with pagination.

### Method
GET

### Endpoint
/knowledge_bases/{knowledge_base_id}/articles

### Parameters
#### Path Parameters
- **knowledge_base_id** (string) - Required - The unique identifier of the knowledge base.

#### Query Parameters
- **limit** (integer) - Optional - The maximum number of articles to return.

### Request Headers
- Authorization: Bearer $FRONT_TOKEN
- Accept: application/json

### Response
#### Success Response (200)
- _pagination (object): Pagination information.
- _results (array): An array of article objects.
  - id (string): The article's unique identifier.
  - subject (string): The article's subject.
  - status (string): The article's status (e.g., "published").
  - locale (string): The article's locale.
  - updated_at (number): Timestamp of the last update.

### Request Example
```bash
curl -s -X GET "https://api2.frontapp.com/knowledge_bases/knb_123/articles?limit=25" \
  -H "Authorization: Bearer $FRONT_TOKEN" \
  -H "Accept: application/json"
```

### Response Example
```json
{
  "_pagination": {...},
  "_results": [
    {
      "id": "kba_abc",
      "subject": "How to reset password",
      "status": "published",
      "locale": "en",
      "updated_at": 1700000000.0
    }
  ]
}
```
```

--------------------------------

### List Message Templates

Source: https://context7.com/frontapp/postman-core-api/llms.txt

Retrieves a list of all available message templates. Requires the `message_templates:read` scope.

```bash
curl -s -X GET "https://api2.frontapp.com/message_templates?limit=25" \
  -H "Authorization: Bearer $FRONT_TOKEN" \
  -H "Accept: application/json"
```

--------------------------------

### Create Analytics Export - POST /analytics/exports

Source: https://context7.com/frontapp/postman-core-api/llms.txt

Creates an asynchronous export of messages or events data. Requires `analytics:read` scope. Specify data type, time range, timezone, filters, and desired columns.

```bash
curl -s -X POST https://api2.frontapp.com/analytics/exports \
  -H "Authorization: Bearer $FRONT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ \
    "type": "messages", \
    "start": 1696118400, \
    "end": 1698710400, \
    "timezone": "America/New_York", \
    "filters": { \
      "inbox_ids": ["inb_123"], \
      "tag_ids": ["tag_urgent"] \
    }, \
    "columns": ["Message ID", "Conversation ID", "From", "Subject", "Message date", "Response time"] \
  }'
```

--------------------------------

### Create message template

Source: https://context7.com/frontapp/postman-core-api/llms.txt

Creates a reusable message template (canned response). HTML with inline CSS is supported. Requires `message_templates:write` scope.

```APIDOC
## POST /message_templates — Create message template

### Description
Creates a reusable message template (canned response). HTML with inline CSS is supported.

### Method
POST

### Endpoint
https://api2.frontapp.com/message_templates

### Request Headers
- Authorization: Bearer $FRONT_TOKEN
- Content-Type: application/json

### Request Body
- **name** (string) - Required - The name of the message template.
- **subject** (string) - Required - The subject line of the message template.
- **body** (string) - Required - The HTML body of the message template.
- **inbox_ids** (array) - Optional - An array of inbox IDs to associate this template with. If omitted, the template is global.
  - inbox_id (string): The ID of an inbox.

### Request Example
```bash
curl -s -X POST https://api2.frontapp.com/message_templates \
  -H "Authorization: Bearer $FRONT_TOKEN" \
  -H "Content-Type: application/json" \
  -d 
    '{ 
      "name": "Refund Approved", 
      "subject": "Your refund has been processed", 
      "body": "<p>Hi there,</p><p>We have processed your refund of <strong>$49.99</strong>. Please allow 3-5 business days.</p>", 
      "inbox_ids": ["inb_123", "inb_456"] 
    }'
```

### Response
#### Success Response (201)
- The created message template object, including its ID and other properties.
```

--------------------------------

### Iterate Through Paginated Results

Source: https://context7.com/frontapp/postman-core-api/llms.txt

This script demonstrates how to paginate through API results by repeatedly fetching the next page URL until no more pages are available. It processes each result using `jq`.

```bash
BASE="https://api2.frontapp.com"
TOKEN="$FRONT_TOKEN"
URL="$BASE/conversations?limit=100"

while [ -n "$URL" ]; do
  RESPONSE=$(curl -s -X GET "$URL" \
    -H "Authorization: Bearer $TOKEN" \
    -H "Accept: application/json")

  # Process results
  echo "$RESPONSE" | jq '._results[].id'

  # Get next page URL
  NEXT=$(echo "$RESPONSE" | jq -r '._pagination.next // empty')
  URL="$NEXT"
done
```

--------------------------------

### Authenticate API Requests

Source: https://context7.com/frontapp/postman-core-api/llms.txt

All API requests require a Bearer token for authentication. API tokens are generated in Front settings and can be scoped to specific resource permissions.

```bash
curl -H "Authorization: Bearer <YOUR_API_TOKEN>" \
     -H "Accept: application/json" \
     https://api2.frontapp.com/me
```

--------------------------------

### Create Message Template

Source: https://context7.com/frontapp/postman-core-api/llms.txt

Creates a new reusable message template, supporting HTML content with inline CSS. Requires the `message_templates:write` scope. Returns the created template object on success.

```bash
curl -s -X POST https://api2.frontapp.com/message_templates \
  -H "Authorization: Bearer $FRONT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Refund Approved",
    "subject": "Your refund has been processed",
    "body": "<p>Hi there,</p><p>We have processed your refund of <strong>$49.99</strong>. Please allow 3-5 business days.</p>",
    "inbox_ids": ["inb_123", "inb_456"]
  }'
```

--------------------------------

### Create Inbox - POST /inboxes

Source: https://context7.com/frontapp/postman-core-api/llms.txt

Creates a new inbox. Requires `inboxes:write` scope. Specify name, teammate IDs, public status, and custom fields.

```bash
curl -s -X POST https://api2.frontapp.com/inboxes \
  -H "Authorization: Bearer $FRONT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ \
    "name": "Billing Support", \
    "teammate_ids": ["tea_abc", "tea_def"], \
    "is_public": true, \
    "custom_fields": {} \
  }'
```

--------------------------------

### Create Link

Source: https://context7.com/frontapp/postman-core-api/llms.txt

Creates a new link to associate conversations with an external resource. Requires the `links:write` scope. Returns the created link object on success.

```bash
curl -s -X POST https://api2.frontapp.com/links \
  -H "Authorization: Bearer $FRONT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Salesforce Opportunity: ACME-2024",
    "external_url": "https://salesforce.com/opportunity/0064x000008uvQx"
  }'
```

--------------------------------

### List rules

Source: https://context7.com/frontapp/postman-core-api/llms.txt

Lists all company-level automation rules. Requires `rules:read` scope.

```APIDOC
## GET /rules — List rules

### Description
Lists all company-level automation rules. Requires `rules:read` scope.

### Method
GET

### Endpoint
/rules

### Request Example
```bash
curl -s -X GET https://api2.frontapp.com/rules \
  -H "Authorization: Bearer $FRONT_TOKEN" \
  -H "Accept: application/json"
```

### Response
#### Success Response (200)
- **_results** (array) - An array of rule objects.
  - **id** (string) - The unique identifier for the rule.
  - **name** (string) - The name of the rule.
  - **is_private** (boolean) - Indicates if the rule is private.
  - **actions** (array) - A list of actions associated with the rule.
```

--------------------------------

### List message templates

Source: https://context7.com/frontapp/postman-core-api/llms.txt

Lists all message templates. Requires `message_templates:read` scope.

```APIDOC
## GET /message_templates — List message templates

### Description
Lists all message templates.

### Method
GET

### Endpoint
https://api2.frontapp.com/message_templates

### Parameters
#### Query Parameters
- **limit** (integer) - Optional - The maximum number of templates to return.

### Request Headers
- Authorization: Bearer $FRONT_TOKEN
- Accept: application/json

### Response
#### Success Response (200)
- _results (array): An array of message template objects.
  - id (string): The template's unique identifier.
  - name (string): The name of the template.
  - subject (string): The subject line of the template.
  - body (string): The HTML body of the template.
  - inbox_ids (array or null): An array of inbox IDs this template is associated with, or null if it's a global template.

### Request Example
```bash
curl -s -X GET "https://api2.frontapp.com/message_templates?limit=25" \
  -H "Authorization: Bearer $FRONT_TOKEN" \
  -H "Accept: application/json"
```

### Response Example
```json
{
  "_results": [
    {
      "id": "rsp_abc",
      "name": "Standard Greeting",
      "subject": "Hello!",
      "body": "<p>Hi {{contact.name}}, thanks for contacting us!</p>",
      "inbox_ids": null
    }
  ]
}
```
```

--------------------------------

### Create a new message (new conversation)

Source: https://context7.com/frontapp/postman-core-api/llms.txt

Initiates a new outbound message from a specified channel, which also creates a new conversation. Requires `messages:send` scope.

```bash
curl -s -X POST https://api2.frontapp.com/channels/cha_123/messages \
  -H "Authorization: Bearer $FRONT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "author_id": "tea_xyz",
    "to": ["newcustomer@example.com"],
    "subject": "Welcome to Acme",
    "body": "<p>Hi there! Welcome aboard.</p>",
    "options": { "archive": false }
  }'
```

--------------------------------

### List contacts

Source: https://context7.com/frontapp/postman-core-api/llms.txt

Lists all contacts in the company. Supports search filtering via the `q` query object (e.g., `updated_after`, `updated_before`). Requires `contacts:read` scope.

```bash
curl -s -X GET "https://api2.frontapp.com/contacts?limit=25&sort_by=updated_at&sort_order=desc" \
  -H "Authorization: Bearer $FRONT_TOKEN" \
  -H "Accept: application/json"
# Response:
# {
#   "_pagination": { "next": "..." },
#   "_results": [
#     { "id": "crd_abc", "name": "Jim Halpert", "handles": [{"handle": "jim@dm.com", "source": "email"}],
#       "custom_fields": {}, "is_private": false }
#   ]
# }
```

--------------------------------

### List Company Accounts

Source: https://context7.com/frontapp/postman-core-api/llms.txt

Lists all company accounts, supporting optional sorting by fields like `updated_at` and cursor-based pagination using `page_token`. Requires the `accounts:read` scope.

```bash
curl -s -X GET "https://api2.frontapp.com/accounts?limit=25&sort_by=updated_at&sort_order=desc" \
  -H "Authorization: Bearer $FRONT_TOKEN" \
  -H "Accept: application/json"
```

--------------------------------

### Create link

Source: https://context7.com/frontapp/postman-core-api/llms.txt

Creates a new link to associate conversations with an external resource. Requires `links:write` scope.

```APIDOC
## POST /links — Create link

### Description
Creates a new link to associate conversations with an external resource.

### Method
POST

### Endpoint
https://api2.frontapp.com/links

### Request Headers
- Authorization: Bearer $FRONT_TOKEN
- Content-Type: application/json

### Request Body
- **name** (string) - Required - The name of the link.
- **external_url** (string) - Required - The URL of the external resource.

### Request Example
```bash
curl -s -X POST https://api2.frontapp.com/links \
  -H "Authorization: Bearer $FRONT_TOKEN" \
  -H "Content-Type: application/json" \
  -d 
    '{ 
      "name": "Salesforce Opportunity: ACME-2024", 
      "external_url": "https://salesforce.com/opportunity/0064x000008uvQx" 
    }'
```

### Response
#### Success Response (201)
- The created link object, including its ID and other properties.
```

--------------------------------

### List Shifts

Source: https://context7.com/frontapp/postman-core-api/llms.txt

Retrieve a list of all company shifts. Requires `shifts:read` scope.

```bash
curl -s -X GET https://api2.frontapp.com/shifts \
  -H "Authorization: Bearer $FRONT_TOKEN" \
  -H "Accept: application/json"
```

--------------------------------

### List Teammates

Source: https://context7.com/frontapp/postman-core-api/llms.txt

Retrieves a list of all teammates in the company. Requires the `teammates:read` scope.

```bash
curl -s -X GET https://api2.frontapp.com/teammates \
  -H "Authorization: Bearer $FRONT_TOKEN" \
  -H "Accept: application/json"
```

--------------------------------

### Add contacts to an account

Source: https://context7.com/frontapp/postman-core-api/llms.txt

Associates one or more existing contacts with an account. Requires `accounts:write` scope.

```bash
curl -s -X POST https://api2.frontapp.com/accounts/acc_76/contacts \
  -H "Authorization: Bearer $FRONT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "contact_ids": ["crd_abc", "crd_def"] }'
# Response: 204 No Content
```

--------------------------------

### List events (activity feed)

Source: https://context7.com/frontapp/postman-core-api/llms.txt

Lists company-wide events in reverse chronological order. Supports `q` filter for types, time ranges, and inbox scope. Requires `events:read` scope.

```APIDOC
## GET /events — List events (activity feed)

### Description
Lists company-wide events in reverse chronological order. Supports `q` filter for types, time ranges, and inbox scope. Requires `events:read` scope.

### Method
GET

### Endpoint
/events

### Query Parameters
- **q** (object) - Optional - Filter for types, time ranges, and inbox scope.
- **limit** (integer) - Optional - The maximum number of results to return.

### Request Example
```bash
curl -s -X GET 'https://api2.frontapp.com/events?q={"types":["assign","tag"],"after":1700000000}&limit=50' \
  -H "Authorization: Bearer $FRONT_TOKEN" \
  -H "Accept: application/json"
```

### Response
#### Success Response (200)
- **_pagination** (object) - Pagination information.
  - **next** (string) - URL for the next page of results.
- **_results** (array) - An array of event objects.
  - **id** (string) - The unique identifier for the event.
  - **type** (string) - The type of event (e.g., 'assign', 'tag').
  - **emitted_at** (number) - The timestamp when the event was emitted.
  - **conversation** (object) - Information about the associated conversation.
  - **source** (object) - Information about the source of the event.
```

--------------------------------

### Create Inbox

Source: https://context7.com/frontapp/postman-core-api/llms.txt

Creates a new inbox in your Front account. This operation requires the `inboxes:write` scope.

```APIDOC
## POST /inboxes — Create inbox

Creates a new inbox. Requires `inboxes:write` scope.

### Method
POST

### Endpoint
https://api2.frontapp.com/inboxes

### Parameters
#### Request Body
- **name** (string) - Required - The name of the inbox.
- **teammate_ids** (array of strings) - Optional - IDs of teammates to assign to the inbox.
- **is_public** (boolean) - Optional - Whether the inbox is public.
- **custom_fields** (object) - Optional - Custom fields for the inbox.

### Request Example
```json
{
  "name": "Billing Support",
  "teammate_ids": ["tea_abc", "tea_def"],
  "is_public": true,
  "custom_fields": {}
}
```

### Response
#### Success Response (201 Created)
- Returns a full InboxResponse object.
```

--------------------------------

### List teammates

Source: https://context7.com/frontapp/postman-core-api/llms.txt

Lists all teammates in the company. Requires `teammates:read` scope.

```APIDOC
## GET /teammates — List teammates

### Description
Lists all teammates in the company.

### Method
GET

### Endpoint
https://api2.frontapp.com/teammates

### Request Headers
- Authorization: Bearer $FRONT_TOKEN
- Accept: application/json

### Response
#### Success Response (200)
- _results (array): An array of teammate objects.
  - id (string): The teammate's unique identifier.
  - email (string): The teammate's email address.
  - first_name (string): The teammate's first name.
  - last_name (string): The teammate's last name.
  - is_admin (boolean): Indicates if the teammate is an administrator.
  - is_available (boolean): Indicates if the teammate is currently available.

### Request Example
```bash
curl -s -X GET https://api2.frontapp.com/teammates \
  -H "Authorization: Bearer $FRONT_TOKEN" \
  -H "Accept: application/json"
```

### Response Example
```json
{
  "_results": [
    {
      "id": "tea_abc",
      "email": "alice@acme.com",
      "first_name": "Alice",
      "last_name": "Smith",
      "is_admin": true,
      "is_available": true
    }
  ]
}
```
```

--------------------------------

### List Account Contacts

Source: https://context7.com/frontapp/postman-core-api/llms.txt

Lists all contacts associated with a specific account. Supports pagination and sorting. Requires the `accounts:read` scope.

```bash
curl -s -X GET "https://api2.frontapp.com/accounts/acc_76/contacts?limit=10&sort_by=created_at&sort_order=asc" \
  -H "Authorization: Bearer $FRONT_TOKEN" \
  -H "Accept: application/json"
```

--------------------------------

### List shifts

Source: https://context7.com/frontapp/postman-core-api/llms.txt

Lists all company shifts. Requires `shifts:read` scope.

```APIDOC
## GET /shifts — List shifts

### Description
Lists all company shifts. Requires `shifts:read` scope.

### Method
GET

### Endpoint
/shifts

### Request Example
```bash
curl -s -X GET https://api2.frontapp.com/shifts \
  -H "Authorization: Bearer $FRONT_TOKEN" \
  -H "Accept: application/json"
```

### Response
#### Success Response (200)
- **_results** (array) - An array of shift objects.
  - **id** (string) - The unique identifier for the shift.
  - **name** (string) - The name of the shift.
  - **timezone** (string) - The timezone for the shift.
  - **times** (object) - The scheduled times for the shift.
    - **mon** (object) - Times for Monday.
      - **start** (string) - The start time for Monday.
      - **end** (string) - The end time for Monday.
  - **color** (string) - The color associated with the shift.
```

--------------------------------

### Receive a custom incoming message

Source: https://context7.com/frontapp/postman-core-api/llms.txt

Injects an incoming message into a custom channel. This endpoint is only available for custom channel types and requires `messages:write` scope.

```bash
curl -s -X POST https://api2.frontapp.com/channels/cha_custom_456/incoming_messages \
  -H "Authorization: Bearer $FRONT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "sender": { "handle": "user123", "name": "John Doe" },
    "subject": "Support request from chat",
    "body": "I need help with my account.",
    "delivered_at": 1700000000,
    "metadata": { "external_id": "chat-msg-789", "thread_ref": "chat-session-001" }
  }'
```

--------------------------------

### List contacts

Source: https://context7.com/frontapp/postman-core-api/llms.txt

Lists all contacts in the company. Supports search filtering via the `q` query object. Requires `contacts:read` scope.

```APIDOC
## GET /contacts

### Description
Lists all contacts in the company. Supports search filtering via the `q` query object (e.g., `updated_after`, `updated_before`).

### Method
GET

### Endpoint
/contacts

### Parameters
#### Query Parameters
- **limit** (integer) - Optional - The maximum number of contacts to return.
- **sort_by** (string) - Optional - The field to sort contacts by (e.g., `updated_at`).
- **sort_order** (string) - Optional - The order to sort contacts by (`asc` or `desc`).
- **q** (object) - Optional - An object for search filtering (e.g., `updated_after`, `updated_before`).

### Response
#### Success Response (200 OK)
Returns a paginated list of contacts.

#### Response Example
```json
{
  "_pagination": { "next": "..." },
  "_results": [
    { "id": "crd_abc", "name": "Jim Halpert", "handles": [{"handle": "jim@dm.com", "source": "email"}],
      "custom_fields": {}, "is_private": false }
  ]
}
```
```

--------------------------------

### Update Existing Account

Source: https://context7.com/frontapp/postman-core-api/llms.txt

Updates an existing account's fields, such as description or custom fields. Requires the `accounts:write` scope. You can use the account's domain or external ID as a resource alias instead of the `account_id`.

```bash
curl -s -X PATCH https://api2.frontapp.com/accounts/acc_76 \
  -H "Authorization: Bearer $FRONT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "description": "Updated description",
    "custom_fields": { "tier": "Enterprise", "region": "US-East" }
  }'
```

--------------------------------

### Create a message reply

Source: https://context7.com/frontapp/postman-core-api/llms.txt

Sends a reply to an existing conversation. Supports email replies with options for tagging. Requires `messages:send` scope.

```bash
curl -s -X POST https://api2.frontapp.com/conversations/cnv_abc/messages \
  -H "Authorization: Bearer $FRONT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "author_id": "tea_xyz",
    "to": ["customer@example.com"],
    "subject": "Re: Order issue",
    "body": "<p>Thank you for reaching out. We are looking into this now.</p>",
    "type": "email",
    "options": { "tag_ids": ["tag_replied"] }
  }'
```

--------------------------------

### List company conversations

Source: https://context7.com/frontapp/postman-core-api/llms.txt

Lists company conversations in reverse chronological order. Accepts `q` filter for statuses. Requires `conversations:read` scope.

```bash
# Filter for unassigned conversations
curl -s -X GET 'https://api2.frontapp.com/conversations?q={"statuses":["unassigned"]}&limit=25' \
  -H "Authorization: Bearer $FRONT_TOKEN" \
  -H "Accept: application/json"
# Response:
# {
#   "_pagination": { "next": "..." },
#   "_results": [
#     { "id": "cnv_abc", "subject": "Help needed", "status": "unassigned",
#       "assignee": null, "recipient": { "handle": "customer@example.com", "role": "from" },
#       "tags": [], "created_at": 1700000000.0, "updated_at": 1700010000.0 }
#   ]
# }
```

--------------------------------

### List links

Source: https://context7.com/frontapp/postman-core-api/llms.txt

Lists all links (external resource connections) in the company with optional type filter. Requires `links:read` scope.

```APIDOC
## GET /links — List links

### Description
Lists all links (external resource connections) in the company with optional type filter.

### Method
GET

### Endpoint
https://api2.frontapp.com/links

### Parameters
#### Query Parameters
- **q** (object) - Optional - A JSON object for filtering. Example: `{"types":["web"]}`
- **limit** (integer) - Optional - The maximum number of links to return.

### Request Headers
- Authorization: Bearer $FRONT_TOKEN
- Accept: application/json

### Response
#### Success Response (200)
- _results (array): An array of link objects.
  - id (string): The link's unique identifier.
  - name (string): The name of the link.
  - external_url (string): The URL of the external resource.
  - type (string): The type of the link (e.g., "web").

### Request Example
```bash
curl -s -X GET "https://api2.frontapp.com/links?q={\"types\":[\"web\"]}&limit=25" \
  -H "Authorization: Bearer $FRONT_TOKEN" \
  -H "Accept: application/json"
```

### Response Example
```json
{
  "_results": [
    {
      "id": "lnk_abc",
      "name": "JIRA-1234",
      "external_url": "https://jira.example.com/browse/JIRA-1234",
      "type": "web"
    }
  ]
}
```
```

--------------------------------

### List Tags

Source: https://context7.com/frontapp/postman-core-api/llms.txt

Retrieves a list of all tags within the company, with support for pagination. Requires the `tags:read` scope.

```APIDOC
## GET /tags — List tags

Lists all tags in the company with pagination. Requires `tags:read` scope.

### Method
GET

### Endpoint
https://api2.frontapp.com/tags

### Parameters
#### Query Parameters
- **limit** (integer) - Optional - The number of tags to return per page.

### Response
#### Success Response
- **_results** (array) - An array of tag objects.
  - **id** (string) - The ID of the tag.
  - **name** (string) - The name of the tag.
  - **highlight** (string) - The highlight color for the tag.
  - **is_private** (boolean) - Whether the tag is private.
```

--------------------------------

### List all company inboxes

Source: https://context7.com/frontapp/postman-core-api/llms.txt

Retrieves a list of all available inboxes within the company. Requires `inboxes:read` scope.

```bash
curl -s -X GET https://api2.frontapp.com/inboxes \
  -H "Authorization: Bearer $FRONT_TOKEN" \
  -H "Accept: application/json"
```

=== COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.