# Core API API

> Core API API on Apizie: 235 endpoints (List Accounts, Create account, List Account's custom fields, Fetch an account, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://apizie.tech/v1/business:front/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `business:front`
- Category: Business
- Status: byok
- Source: https://community.front.com
- Page: https://apizie.tech/api/business/front
- OpenAPI: https://apizie.tech/api/business/front/openapi.json



## Endpoints

### List Accounts
`GET https://apizie.tech/v1/business:front/list-accounts` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| limit | integer | no | Max number of results per [page](https://dev.frontapp.com/docs/pagination) |
| page_token | string | no | Token to use to request the [next page](https://dev.frontapp.com/docs/pagination) |
| sort_by | string | no | Field used to sort the accounts. Either `created_at` or `updated_at`. |
| sort_order | string | no | Order by which results should be sorted |

### Create account
`POST https://apizie.tech/v1/business:front/create-account` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### List Account's custom fields
`GET https://apizie.tech/v1/business:front/list-account-custom-fields` (byok)

### Fetch an account
`GET https://apizie.tech/v1/business:front/fetch-an-account` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| account_id | string | yes | The Account ID. Alternatively, you can supply the account domain or external ID as a [resource… |

### Update account
`POST https://apizie.tech/v1/business:front/update-account` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| account_id | string | yes | The Account ID. Alternatively, you can supply the account domain or external ID as a [resource… |
| body | object | yes | JSON request body |

### Delete an account
`POST https://apizie.tech/v1/business:front/delete-an-account` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| account_id | string | yes | The Account ID. Alternatively, you can supply the account domain or external ID as a [resource… |

### List account contacts
`GET https://apizie.tech/v1/business:front/list-account-contacts` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| account_id | string | yes | The Account ID. Alternatively, you can supply the account domain or external ID as a [resource… |
| page_token | string | no | Token to use to request the [next page](https://dev.frontapp.com/docs/pagination) |
| limit | integer | no | Max number of results per [page](https://dev.frontapp.com/docs/pagination) |
| sort_by | string | no | Field used to sort the contacts. Either `created_at` or `updated_at`. |
| sort_order | string | no | Order by which results should be sorted |

### Add contact to Account
`POST https://apizie.tech/v1/business:front/add-contact-to-account` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| account_id | string | yes | The Account ID. Alternatively, you can supply the account domain or external ID as a [resource… |
| body | object | yes | JSON request body |

### Remove contact from Account
`POST https://apizie.tech/v1/business:front/remove-contact-from-account` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| account_id | string | yes | The Account ID. Alternatively, you can supply the account domain or external ID as a [resource… |
| body | object | no | JSON request body |

### Create a new analytics export
`POST https://apizie.tech/v1/business:front/create-analytics-export` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Fetch an analytics export
`GET https://apizie.tech/v1/business:front/get-analytics-export` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| export_id | string | yes | The export ID. |

### Create a new analytics report
`POST https://apizie.tech/v1/business:front/create-analytics-report` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Fetch an analytics report
`GET https://apizie.tech/v1/business:front/get-analytics-report` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| report_uid | string | yes | The report UID. |

### Trigger application event
`POST https://apizie.tech/v1/business:front/trigger-app-event` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| application_uid | string | yes | The application UID |
| body | object | yes | JSON request body |

### List channels
`GET https://apizie.tech/v1/business:front/list-channels` (byok)

### Get channel
`GET https://apizie.tech/v1/business:front/get-channel` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| channel_id | string | yes | The Channel ID. Alternatively, you can supply the channel address as a [resource alias](https://dev.frontapp.com/docs/resource-aliases-1). |

### Update Channel
`POST https://apizie.tech/v1/business:front/update-channel` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| channel_id | string | yes | The Channel ID. Alternatively, you can supply the channel address as a [resource alias](https://dev.frontapp.com/docs/resource-aliases-1). |
| body | object | yes | JSON request body |

### Create draft
`POST https://apizie.tech/v1/business:front/create-draft` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| channel_id | string | yes | The channel ID. Alternatively, you can supply the channel address as a [resource alias](https://dev.frontapp.com/docs/resource-aliases-1). |
| body | object | yes | JSON request body |

### Receive custom messages
`POST https://apizie.tech/v1/business:front/receive-custom-messages` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| channel_id | string | yes | The channel ID. Alternatively, you can supply the channel address as a [resource alias](https://dev.frontapp.com/docs/resource-aliases-1). |
| body | object | yes | JSON request body |

### Create message
`POST https://apizie.tech/v1/business:front/create-message` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| channel_id | string | yes | The sending channel ID. Alternatively, you can supply the sending channel address as a [resource… |
| body | object | yes | JSON request body |

### Validate channel
`POST https://apizie.tech/v1/business:front/validate-channel` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| channel_id | string | yes | The Channel ID. Alternatively, you can supply the channel address as a [resource alias](https://dev.frontapp.com/docs/resource-aliases-1). |

### Get comment
`GET https://apizie.tech/v1/business:front/get-comment` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| comment_id | string | yes | The Comment ID |

### Update comment
`POST https://apizie.tech/v1/business:front/update-comment` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| comment_id | string | yes | The Comment ID |
| body | object | yes | JSON request body |

### Download attachment for a comment
`GET https://apizie.tech/v1/business:front/download-attachment-for-a-comment` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| comment_id | string | yes | The Comment ID |
| attachment_link_id | string | yes | The Attachment ID |

### List comment mentions
`GET https://apizie.tech/v1/business:front/list-comment-mentions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| comment_id | string | yes | The Comment ID |

### Add comment reply
`POST https://apizie.tech/v1/business:front/add-comment-reply` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| comment_id | string | yes | The comment ID to reply to |
| body | object | yes | JSON request body |

### List all company rules
`GET https://apizie.tech/v1/business:front/list-all-company-rules` (byok)

### List company ticket statuses
`GET https://apizie.tech/v1/business:front/list-company-ticket-statuses` (byok)

### Get ticket status
`GET https://apizie.tech/v1/business:front/get-ticket-status-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| status_id | string | yes | The ticket status ID |

### List company tags
`GET https://apizie.tech/v1/business:front/list-company-tags` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| limit | integer | no | Max number of results per [page](https://dev.frontapp.com/docs/pagination) |
| page_token | string | no | Token to use to request the [next page](https://dev.frontapp.com/docs/pagination) |
| sort_by | string | no | Field used to sort the tags. Only supports `id`. |
| sort_order | string | no | Order by which results should be sorted |

### Create company tag
`POST https://apizie.tech/v1/business:front/create-company-tag` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Remove contacts from group
`POST https://apizie.tech/v1/business:front/remove-contacts-from-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| contact_group_id | string | yes | The contact group ID |
| body | object | no | JSON request body |

### List contact lists
`GET https://apizie.tech/v1/business:front/list-contact-lists` (byok)

### Create contact list
`POST https://apizie.tech/v1/business:front/create-contact-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Delete contact list
`POST https://apizie.tech/v1/business:front/delete-contact-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| contact_list_id | string | yes | The contact list ID |

### List contacts in contact list
`GET https://apizie.tech/v1/business:front/list-contacts-in-contact-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| contact_list_id | string | yes | The contact list ID |
| page_token | string | no | Token to use to request the [next page](https://dev.frontapp.com/docs/pagination) |
| limit | integer | no | Max number of results per [page](https://dev.frontapp.com/docs/pagination) |

### Add contacts to contact list
`POST https://apizie.tech/v1/business:front/add-contacts-to-contact-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| contact_list_id | string | yes | The contact list ID |
| body | object | yes | JSON request body |

### Remove contacts from contact list
`POST https://apizie.tech/v1/business:front/remove-contacts-from-contact-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| contact_list_id | string | yes | The contact list ID |
| body | object | no | JSON request body |

### List contacts
`GET https://apizie.tech/v1/business:front/list-contacts` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| q | string | no | [Search query object](https://dev.frontapp.com/docs/query-object-q) with the optional properties `updated_after` and `updated_before`,… |
| limit | integer | no | Max number of results per [page](https://dev.frontapp.com/docs/pagination) |
| page_token | string | no | Token to use to request the [next page](https://dev.frontapp.com/docs/pagination) |
| sort_by | string | no | Field used to sort the contacts. Either `created_at` or `updated_at`. |
| sort_order | string | no | Order by which results should be sorted |

### Create contact
`POST https://apizie.tech/v1/business:front/create-contact` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### List Contact's custom fields
`GET https://apizie.tech/v1/business:front/list-contact-custom-fields` (byok)

### Merge contacts
`POST https://apizie.tech/v1/business:front/merge-contacts` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Get contact
`GET https://apizie.tech/v1/business:front/get-contact` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| contact_id | string | yes | The contact ID. Alternatively, you can supply the contact's source and handle as a [resource… |

### Update a contact
`POST https://apizie.tech/v1/business:front/update-a-contact` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| contact_id | string | yes | The contact ID. Alternatively, you can supply the contact's source and handle as a [resource… |
| body | object | yes | JSON request body |

### Delete a contact
`POST https://apizie.tech/v1/business:front/delete-a-contact` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| contact_id | string | yes | The contact ID. Alternatively, you can supply the contact's source and handle as a [resource… |

### List contact conversations
`GET https://apizie.tech/v1/business:front/list-contact-conversations` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| contact_id | string | yes | The Contact ID. Alternatively, you can supply the contact's source and handle as a [resource… |
| q | string | no | [Search query object](https://dev.frontapp.com/docs/query-object-q) with a property `statuses`, whose value should be a list of… |
| limit | integer | no | Max number of results per [page](https://dev.frontapp.com/docs/pagination) |
| page_token | string | no | Token to use to request the [next page](https://dev.frontapp.com/docs/pagination) |

### Add contact handle
`POST https://apizie.tech/v1/business:front/add-contact-handle` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| contact_id | string | yes | The contact ID. Alternatively, you can supply the contact's source and handle as a [resource… |
| body | object | yes | JSON request body |

### Delete contact handle
`POST https://apizie.tech/v1/business:front/delete-contact-handle` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| contact_id | string | yes | The contact ID. Alternatively, you can supply the contact's source and handle as a [resource… |
| body | object | no | JSON request body |

### List notes
`GET https://apizie.tech/v1/business:front/list-notes` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| contact_id | string | yes | The contact ID. Alternatively, you can supply the contact's source and handle as a [resource… |

### Add note
`POST https://apizie.tech/v1/business:front/add-note` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| contact_id | string | yes | The contact ID. Alternatively, you can supply the contact's source and handle as a [resource… |
| body | object | yes | JSON request body |

### List conversations
`GET https://apizie.tech/v1/business:front/list-conversations` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| q | string | no | [Search query object](https://dev.frontapp.com/docs/query-object-q) with a property `statuses`, whose value should be a list of… |
| limit | integer | no | Max number of results per [page](https://dev.frontapp.com/docs/pagination) |
| page_token | string | no | Token to use to request the [next page](https://dev.frontapp.com/docs/pagination) |
| sort_by | string | no | Field used to sort the conversations. Only supports `date`. |
| sort_order | string | no | Order by which results should be sorted |

### Create discussion/task conversation
`POST https://apizie.tech/v1/business:front/create-conversation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### List Conversation's custom fields
`GET https://apizie.tech/v1/business:front/list-conversation-custom-fields` (byok)

### Search conversations
`GET https://apizie.tech/v1/business:front/search-conversations` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| query | string | yes | Search query string. See [Search](https://dev.frontapp.com/docs/search-1) topic for usage details. |
| limit | integer | no | Max number of results per [page](https://dev.frontapp.com/docs/pagination) |
| page_token | string | no | Token to use to request the [next page](https://dev.frontapp.com/docs/pagination) |

### Get conversation
`GET https://apizie.tech/v1/business:front/get-conversation-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| conversation_id | string | yes | The conversation ID |

### Update conversation
`POST https://apizie.tech/v1/business:front/update-conversation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| conversation_id | string | yes | The conversation ID |
| body | object | yes | JSON request body |

### Delete conversation
`POST https://apizie.tech/v1/business:front/delete-conversation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| conversation_id | string | yes | The conversation ID |

### Update conversation assignee
`POST https://apizie.tech/v1/business:front/update-conversation-assignee` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| conversation_id | string | yes | The conversation ID |
| body | object | yes | JSON request body |

### List conversation comments
`GET https://apizie.tech/v1/business:front/list-conversation-comments` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| conversation_id | string | yes | The conversation ID |

### Add comment
`POST https://apizie.tech/v1/business:front/add-comment` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| conversation_id | string | yes | The conversation ID |
| body | object | yes | JSON request body |

### List conversation drafts
`GET https://apizie.tech/v1/business:front/list-conversation-drafts` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| conversation_id | string | yes | The conversation ID |

### Create draft reply
`POST https://apizie.tech/v1/business:front/create-draft-reply` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| conversation_id | string | yes | The conversation ID |
| body | object | yes | JSON request body |

### List conversation events
`GET https://apizie.tech/v1/business:front/list-conversation-events` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| conversation_id | string | yes | The conversation ID |
| limit | integer | no | Max number of results per [page](https://dev.frontapp.com/docs/pagination) |
| page_token | string | no | Token to use to request the [next page](https://dev.frontapp.com/docs/pagination) |

### List conversation followers
`GET https://apizie.tech/v1/business:front/list-conversation-followers` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| conversation_id | string | yes | The conversation ID |

### Add conversation followers
`POST https://apizie.tech/v1/business:front/add-conversation-followers` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| conversation_id | string | yes | The conversation ID |
| ignore_errors | boolean | no | Whether to ignore invalid teammate IDs and continue adding valid ones. |
| body | object | yes | JSON request body |

### Delete conversation followers
`POST https://apizie.tech/v1/business:front/delete-conversation-followers` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| conversation_id | string | yes | The conversation ID |
| body | object | no | JSON request body |

### List conversation inboxes
`GET https://apizie.tech/v1/business:front/list-conversation-inboxes` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| conversation_id | string | yes | The conversation ID |

### List linked conversations
`GET https://apizie.tech/v1/business:front/list-linked-conversations` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| conversation_id | string | yes | The conversation ID |
| limit | integer | no | Max number of results per [page](https://dev.frontapp.com/docs/pagination) |
| page_token | string | no | Token to use to request the [next page](https://dev.frontapp.com/docs/pagination) |

### Link conversations
`POST https://apizie.tech/v1/business:front/create-linked-conversations` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| conversation_id | string | yes | The conversation ID |
| body | object | no | JSON request body |

### Add conversation link
`POST https://apizie.tech/v1/business:front/add-conversation-link` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| conversation_id | string | yes | The conversation ID |
| body | object | yes | JSON request body |

### Remove conversation links
`POST https://apizie.tech/v1/business:front/remove-conversation-links` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| conversation_id | string | yes | The conversation ID |
| body | object | no | JSON request body |

### List conversation messages
`GET https://apizie.tech/v1/business:front/list-conversation-messages` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| conversation_id | string | yes | The conversation ID |
| limit | integer | no | Max number of results per [page](https://dev.frontapp.com/docs/pagination) |
| page_token | string | no | Token to use to request the [next page](https://dev.frontapp.com/docs/pagination) |
| sort_by | string | no | Field used to sort the messages. Only supports `created_at`. |
| sort_order | string | no | Order by which results should be sorted |

### Create message reply
`POST https://apizie.tech/v1/business:front/create-message-reply` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| conversation_id | string | yes | The conversation ID |
| body | object | yes | JSON request body |

### Update conversation reminders
`POST https://apizie.tech/v1/business:front/update-conversation-reminders` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| conversation_id | string | yes | The conversation ID |
| body | object | yes | JSON request body |

### Add conversation tag
`POST https://apizie.tech/v1/business:front/add-conversation-tag` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| conversation_id | string | yes | The conversation ID |
| body | object | yes | JSON request body |

### Remove conversation tag
`POST https://apizie.tech/v1/business:front/remove-conversation-tag` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| conversation_id | string | yes | The conversation ID |
| body | object | no | JSON request body |

### Download attachment
`GET https://apizie.tech/v1/business:front/download-attachment` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| attachment_link_id | string | yes | The Attachment ID |

### Delete draft
`POST https://apizie.tech/v1/business:front/delete-draft` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| draft_id | string | yes | The draft ID |
| body | object | no | JSON request body |

### Edit draft
`POST https://apizie.tech/v1/business:front/edit-draft` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| message_id | string | yes | The draft ID |
| body | object | yes | JSON request body |

### List events
`GET https://apizie.tech/v1/business:front/list-events` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| q | string | no | [Search query object](https://dev.frontapp.com/docs/query-object-q) with optional properties `before`, `after`, `types`, or `inboxes`.… |
| limit | integer | no | Max number of results per page (max 15) |
| page_token | string | no | Token to use to request the [next page](https://dev.frontapp.com/docs/pagination) |
| sort_by | string | no | Field used to sort the events. Only supports `created_at`. |
| sort_order | string | no | Order by which results should be sorted |

### Get event
`GET https://apizie.tech/v1/business:front/get-event` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| event_id | string | yes | The event ID |

### List inboxes
`GET https://apizie.tech/v1/business:front/list-inboxes` (byok)

### Create inbox
`POST https://apizie.tech/v1/business:front/create-inbox` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### List Inbox's custom fields
`GET https://apizie.tech/v1/business:front/list-inbox-custom-fields` (byok)

### Get inbox
`GET https://apizie.tech/v1/business:front/get-inbox` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| inbox_id | string | yes | The Inbox ID |

### List inbox channels
`GET https://apizie.tech/v1/business:front/list-inbox-channels` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| inbox_id | string | yes | The Inbox ID |

### Create a channel
`POST https://apizie.tech/v1/business:front/create-a-channel` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| inbox_id | string | yes | The Inbox ID |
| body | object | yes | JSON request body |

### List inbox conversations
`GET https://apizie.tech/v1/business:front/list-inbox-conversations` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| inbox_id | string | yes | The Inbox ID |
| q | string | no | [Search query object](https://dev.frontapp.com/docs/query-object-q) with a property `statuses`, whose value should be a list of… |
| limit | integer | no | Max number of results per [page](https://dev.frontapp.com/docs/pagination) |
| page_token | string | no | Token to use to request the [next page](https://dev.frontapp.com/docs/pagination) |

### Import message
`POST https://apizie.tech/v1/business:front/import-inbox-message` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| inbox_id | string | yes | The Inbox ID |
| body | object | yes | JSON request body |

### List inbox access
`GET https://apizie.tech/v1/business:front/list-inbox-access` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| inbox_id | string | yes | The Inbox ID |

### Add inbox access
`POST https://apizie.tech/v1/business:front/add-inbox-access` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| inbox_id | string | yes | The Inbox ID |
| body | object | yes | JSON request body |

### Removes inbox access
`POST https://apizie.tech/v1/business:front/removes-inbox-access` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| inbox_id | string | yes | The Inbox ID |
| body | object | no | JSON request body |

### Get a knowledge base article
`GET https://apizie.tech/v1/business:front/get-a-knowledge-base-article` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| article_id | string | yes | The ID of the article to fetch |

### Delete an article
`POST https://apizie.tech/v1/business:front/delete-an-article` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| article_id | string | yes | The ID of the article to delete |

### Get knowledge base article with content in default locale
`GET https://apizie.tech/v1/business:front/get-knowledge-base-article-with-content-in-default-locale` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| article_id | string | yes | The ID of the article to fetch |

### Update article content in default locale.
`POST https://apizie.tech/v1/business:front/update-article-content-in-default-locale` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| article_id | string | yes | The ID of the article to update |
| body | object | yes | JSON request body |

### Download attachment from an article
`GET https://apizie.tech/v1/business:front/download-attachment-from-an-article` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| article_id | string | yes | The ID of the article |
| attachment_id | string | yes | The ID of the file to download |

### Get knowledge base article with content in specified locale
`GET https://apizie.tech/v1/business:front/get-knowledge-base-article-with-content-in-specified-locale` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| article_id | string | yes | The ID of the article to fetch |
| locale | string | yes | The [locale](https://dev.frontapp.com/reference/knowledge-bases#locales) of the content to fetch |

### Update article content in specified locale
`POST https://apizie.tech/v1/business:front/update-article-content-in-specified-locale` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| article_id | string | yes | The ID of the article to update |
| locale | string | yes | The [locale](https://dev.frontapp.com/reference/knowledge-bases#locales) of the updated content |
| body | object | yes | JSON request body |

### Get a knowledge base category
`GET https://apizie.tech/v1/business:front/get-a-knowledge-base-category` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| category_id | string | yes | The ID of the category to fetch |

### Delete a knowledge base category
`POST https://apizie.tech/v1/business:front/delete-a-knowledge-base-category` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| category_id | string | yes | The ID of the category to delete |

### List articles in a category
`GET https://apizie.tech/v1/business:front/list-articles-in-a-category` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| category_id | string | yes | The ID of the category |
| limit | integer | no | Max number of results per [page](https://dev.frontapp.com/docs/pagination) |
| page_token | string | no | Token to use to request the [next page](https://dev.frontapp.com/docs/pagination) |

### Get knowledge base category content in default locale
`GET https://apizie.tech/v1/business:front/get-knowledge-base-category-content-in-default-locale` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| category_id | string | yes | The ID of the category to fetch |

### Update knowledge base category in default locale
`POST https://apizie.tech/v1/business:front/update-knowledge-base-category-in-default-locale` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| category_id | string | yes | The ID of the category to update |
| body | object | yes | JSON request body |

### Get knowledge base category with content in specified locale
`GET https://apizie.tech/v1/business:front/get-knowledge-base-category-with-content-in-specified-locale` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| category_id | string | yes | The ID of the category to fetch |
| locale | string | yes | The [locale](https://dev.frontapp.com/reference/knowledge-bases#locales) of the content to fetch |

### Update knowledge base category in specified locale
`POST https://apizie.tech/v1/business:front/update-knowledge-base-category-in-specified-locale` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| category_id | string | yes | The ID of the category to update |
| locale | string | yes | The [locale](https://dev.frontapp.com/reference/knowledge-bases#locales) of the updated content |
| body | object | yes | JSON request body |

### List knowledge bases
`GET https://apizie.tech/v1/business:front/list-knowledge-bases` (byok)

### Create a knowledge base
`POST https://apizie.tech/v1/business:front/create-a-knowledge-base` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Get a knowledge base
`GET https://apizie.tech/v1/business:front/get-a-knowledge-base` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| knowledge_base_id | string | yes | The ID of the knowledge base to fetch |

### List articles in a knowledge base
`GET https://apizie.tech/v1/business:front/list-articles-in-a-knowledge-base` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| knowledge_base_id | string | yes | The ID of the knowledge base |
| limit | integer | no | Max number of results per [page](https://dev.frontapp.com/docs/pagination) |
| page_token | string | no | Token to use to request the [next page](https://dev.frontapp.com/docs/pagination) |

### Create article in a knowledge base in default locale
`POST https://apizie.tech/v1/business:front/create-article-in-a-knowledge-base-in-default-locale` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| knowledge_base_id | string | yes | The ID of the knowledge base to create the article in |
| body | object | yes | JSON request body |

### List categories in a knowledge base
`GET https://apizie.tech/v1/business:front/list-categories-in-a-knowledge-base` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| knowledge_base_id | string | yes | The ID of the knowledge base |
| limit | integer | no | Max number of results per [page](https://dev.frontapp.com/docs/pagination) |
| page_token | string | no | Token to use to request the [next page](https://dev.frontapp.com/docs/pagination) |

### Create knowledge base category in default locale
`POST https://apizie.tech/v1/business:front/create-knowledge-base-category-in-default-locale` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| knowledge_base_id | string | yes | The ID of the knowledge base to create the category in |
| body | object | yes | JSON request body |

### Get a knowledge base with content in default locale
`GET https://apizie.tech/v1/business:front/get-a-knowledge-base-with-content-in-default-locale` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| knowledge_base_id | string | yes | The ID of the knowledge base to fetch |

### Update knowledge base in default locale
`POST https://apizie.tech/v1/business:front/update-knowledge-base-in-default-locale` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| knowledge_base_id | string | yes | The ID of the knowledge base to update |
| body | object | yes | JSON request body |

### Create article in a knowledge base in specified locale
`POST https://apizie.tech/v1/business:front/create-article-in-a-knowledge-base-in-specified-locale` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| knowledge_base_id | string | yes | The ID of the knowledge base to create the article in |
| locale | string | yes | The [locale](https://dev.frontapp.com/reference/knowledge-bases#locales) of the article's content |
| body | object | yes | JSON request body |

### Create knowledge base category in specified locale
`POST https://apizie.tech/v1/business:front/create-knowledge-base-category-in-specified-locale` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| knowledge_base_id | string | yes | The ID of the knowledge base to create the category in |
| locale | string | yes | The [locale](https://dev.frontapp.com/reference/knowledge-bases#locales) of the category's content |
| body | object | yes | JSON request body |

### Get a knowledge base with content in specified locale
`GET https://apizie.tech/v1/business:front/get-a-knowledge-base-with-content-in-specified-locale` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| knowledge_base_id | string | yes | The ID of the knowledge base to fetch |
| locale | string | yes | The [locale](https://dev.frontapp.com/reference/knowledge-bases#locales) of the content to fetch |

### Update knowledge base in specified locale
`POST https://apizie.tech/v1/business:front/update-knowledge-base-in-specified-locale` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| knowledge_base_id | string | yes | The ID of the knowledge base to update |
| locale | string | yes | The [locale](https://dev.frontapp.com/reference/knowledge-bases#locales) of the updated content |
| body | object | yes | JSON request body |

### List links
`GET https://apizie.tech/v1/business:front/list-links` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| q | string | no | [Search query object](https://dev.frontapp.com/docs/query-object-q) with a property `types`, whose value should be a list of link types.… |
| limit | integer | no | Max number of results per [page](https://dev.frontapp.com/docs/pagination) |
| page_token | string | no | Token to use to request the [next page](https://dev.frontapp.com/docs/pagination) |
| sort_by | string | no | Field used to sort the links. Only supports `id`. |
| sort_order | string | no | Order by which results should be sorted |

…and 115 more. See the OpenAPI spec.

## Example
```
curl "https://apizie.tech/v1/business:front/list-accounts" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Core API API?
Create a free Apizie key, then send GET https://apizie.tech/v1/business:front/list-accounts with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Core API API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Core API itself also needs your own key from front.

### Can AI agents use the Core API API?
Yes. Add the Apizie MCP server (https://apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key business:front.

### What is the status of the Core API API?
Needs your own provider key (bring your own key)