FrontApp

FrontApp Rules API

The Rules API from FrontApp — 5 operation(s) for rules.

GitHub OpenAPI

Operations 5

GET /company/rules List all company rules #
GET /rules List rules #
GET /rules/{rule_id} Get rule #
GET /teammates/{teammate_id}/rules List teammate rules #
GET /teams/{team_id}/rules List team rules #

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/frontapp/refs/heads/main/openapi/frontapp-rules-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/frontapp/refs/heads/main/json-schema/frontapp-outbound-message-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/frontapp/refs/heads/main/json-schema/frontapp-inbound-message-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/frontapp/refs/heads/main/json-schema/frontapp-application-message-template-edit-blob-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/frontapp/refs/heads/main/json-schema/frontapp-create-call-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/frontapp/refs/heads/main/json-schema/frontapp-update-call-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/frontapp/refs/heads/main/json-schema/frontapp-application-message-template-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/frontapp/refs/heads/main/json-schema/frontapp-import-message-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/frontapp/refs/heads/main/json-schema/frontapp-outbound-reply-message-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/frontapp/refs/heads/main/json-schema/frontapp-create-channel-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/frontapp/refs/heads/main/json-schema/frontapp-create-draft-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/frontapp/refs/heads/main/json-schema/frontapp-update-conversation-schema.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/frontapp:frontapp-rules-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

frontapp-rules-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: 1.0.0
  title: Core Rules API
  contact:
    name: Front Platform
    url: https://community.front.com
servers:
- url: https://api2.frontapp.com
security:
- http: []
tags:
- name: Rules
paths:
  /company/rules:
    get:
      summary: List all company rules
      operationId: list-all-company-rules
      description: 'List the company rules.


        Required scope: `rules:read`'
      tags:
      - Rules
      responses:
        '200':
          $ref: '#/components/responses/listOfRules'
      x-required-scopes:
      - rules:read
  /rules:
    get:
      summary: List rules
      operationId: list-rules
      description: 'List the rules of the company.


        Required scope: `rules:read`'
      tags:
      - Rules
      responses:
        '200':
          $ref: '#/components/responses/listOfRules'
      x-required-scopes:
      - rules:read
  /rules/{rule_id}:
    get:
      summary: Get rule
      operationId: get-rule
      description: 'Fetch a rule.


        Required scope: `rules:read`'
      tags:
      - Rules
      parameters:
      - in: path
        name: rule_id
        required: true
        description: The Rule ID
        schema:
          type: string
          default: rul_123
      responses:
        '200':
          $ref: '#/components/responses/rule'
      x-required-scopes:
      - rules:read
  /teammates/{teammate_id}/rules:
    get:
      summary: List teammate rules
      operationId: list-teammate-rules
      description: 'List the rules of a teammate.


        Required scope: `rules:read`'
      tags:
      - Rules
      parameters:
      - in: path
        name: teammate_id
        required: true
        description: The teammate ID. Alternatively, you can supply an email as a [resource alias](https://dev.frontapp.com/docs/resource-aliases-1).
        schema:
          type: string
          default: tea_123
      responses:
        '200':
          $ref: '#/components/responses/listOfRules'
      x-required-scopes:
      - rules:read
  /teams/{team_id}/rules:
    get:
      summary: List team rules
      operationId: list-team-rules
      description: 'List the rules of a team (workspace).


        Required scope: `rules:read`'
      tags:
      - Rules
      parameters:
      - in: path
        name: team_id
        required: true
        description: The team ID
        schema:
          type: string
          default: tim_123
      responses:
        '200':
          $ref: '#/components/responses/listOfRules'
      x-required-scopes:
      - rules:read
components:
  schemas:
    RuleResponse:
      type: object
      required:
      - _links
      - id
      - name
      - actions
      - is_private
      properties:
        _links:
          type: object
          properties:
            self:
              type: string
              description: Link to resource
              example: https://yourCompany.api.frontapp.com/rules/rul_58xhq
            related:
              type: object
              properties:
                owner:
                  type:
                  - string
                  - 'null'
                  description: Link to rule owner
                  example: null
        id:
          type: string
          description: Unique identifier of the rule
          example: rul_58xhq
        name:
          type: string
          description: Name of the rule
          example: Scranton new account workflow
        actions:
          type: array
          description: List of the rule's actions description
          example:
          - Assign to Pam
          - Unassign from Michael
          - Tag with Scranton is the Best Branch
          - Tag with Michael is the Best Boss
          items:
            type: string
        is_private:
          type: boolean
          description: Whether or not the rule is individual
          example: false
  responses:
    rule:
      description: A rule
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/RuleResponse'
    listOfRules:
      description: Array of Rules
      content:
        application/json:
          schema:
            type: object
            properties:
              _links:
                type: object
                properties:
                  self:
                    type: string
                    description: Link to resource
                    example: https://yourCompany.api.frontapp.com/rules
              _results:
                type: array
                items:
                  $ref: '#/components/schemas/RuleResponse'
  securitySchemes:
    http:
      type: http
      scheme: bearer
      bearerFormat: JWT
x-api-id: front
x-explorer-enabled: false
x-proxy-enabled: true
x-samples-enabled: true
x-provenance:
  method: searched
  source: https://dev.frontapp.com/reference
  harvested: '2026-10-14'
  tool: harvest-readme-openapi.py
  note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
  assembled_from:
  - https://dev.frontapp.com/reference/add-comment-reply.md
  - https://dev.frontapp.com/reference/add-comment.md
  - https://dev.frontapp.com/reference/add-company-teammate-group-team-inboxes.md
  - https://dev.frontapp.com/reference/add-company-teammate-group-teammates.md
  - https://dev.frontapp.com/reference/add-company-teammate-group-teams.md
  - https://dev.frontapp.com/reference/add-contact-handle.md
  - https://dev.frontapp.com/reference/add-contact-to-account.md
  - https://dev.frontapp.com/reference/add-contacts-to-contact-list.md
  - https://dev.frontapp.com/reference/add-contacts-to-group.md
  - https://dev.frontapp.com/reference/add-conversation-followers.md
  - https://dev.frontapp.com/reference/add-conversation-link.md
  - https://dev.frontapp.com/reference/add-conversation-tag.md
  - https://dev.frontapp.com/reference/add-inbox-access.md
  - https://dev.frontapp.com/reference/add-note.md
  - https://dev.frontapp.com/reference/add-teammates-to-shift.md
  - https://dev.frontapp.com/reference/add-teammates-to-team.md
  - https://dev.frontapp.com/reference/add-view-teammates.md
  - https://dev.frontapp.com/reference/api-token-details.md
  - https://dev.frontapp.com/reference/create-a-channel.md
  - https://dev.frontapp.com/reference/create-a-knowledge-base.md
  - https://dev.frontapp.com/reference/create-account.md
  - https://dev.frontapp.com/reference/create-analytics-export.md
  - https://dev.frontapp.com/reference/create-analytics-report.md
  - https://dev.frontapp.com/reference/create-article-in-a-knowledge-base-in-default-locale.md
  - https://dev.frontapp.com/reference/create-article-in-a-knowledge-base-in-specified-locale.md
  - https://dev.frontapp.com/reference/create-child-folder.md
  - https://dev.frontapp.com/reference/create-child-tag.md
  - https://dev.frontapp.com/reference/create-child-template.md
  - https://dev.frontapp.com/reference/create-company-tag.md
  - https://dev.frontapp.com/reference/create-company-teammate-group.md
  - https://dev.frontapp.com/reference/create-contact-list.md
  - https://dev.frontapp.com/reference/create-contact.md
  - https://dev.frontapp.com/reference/create-conversation.md
  - https://dev.frontapp.com/reference/create-draft-reply.md
  - https://dev.frontapp.com/reference/create-draft.md
  - https://dev.frontapp.com/reference/create-folder.md
  - https://dev.frontapp.com/reference/create-group.md
  - https://dev.frontapp.com/reference/create-inbox.md
  - https://dev.frontapp.com/reference/create-knowledge-base-category-in-default-locale.md
  - https://dev.frontapp.com/reference/create-knowledge-base-category-in-specified-locale.md
  - https://dev.frontapp.com/reference/create-link.md
  - https://dev.frontapp.com/reference/create-linked-conversations.md
  - https://dev.frontapp.com/reference/create-message-reply.md
  - https://dev.frontapp.com/reference/create-message-template.md
  - https://dev.frontapp.com/reference/create-message.md
  - https://dev.frontapp.com/reference/create-shift.md
  - https://dev.frontapp.com/reference/create-tag.md
  - https://dev.frontapp.com/reference/create-team-contact-list.md
  - https://dev.frontapp.com/reference/create-team-contact.md
  - https://dev.frontapp.com/reference/create-team-folder.md
  - https://dev.frontapp.com/reference/create-team-group.md
  - https://dev.frontapp.com/reference/create-team-inbox.md
  - https://dev.frontapp.com/reference/create-team-message-template.md
  - https://dev.frontapp.com/reference/create-team-shift.md
  - https://dev.frontapp.com/reference/create-team-signature.md
  - https://dev.frontapp.com/reference/create-team-tag.md
  - https://dev.frontapp.com/reference/create-team-view.md
  - https://dev.frontapp.com/reference/create-teammate-contact-list.md
  - https://dev.frontapp.com/reference/create-teammate-contact.md
  - https://dev.frontapp.com/reference/create-teammate-folder.md
  - https://dev.frontapp.com/reference/create-teammate-group.md
  - https://dev.frontapp.com/reference/create-teammate-message-template.md
  - https://dev.frontapp.com/reference/create-teammate-private-inbox.md
  - https://dev.frontapp.com/reference/create-teammate-signature.md
  - https://dev.frontapp.com/reference/create-teammate-tag.md
  - https://dev.frontapp.com/reference/create-time-off.md
  - https://dev.frontapp.com/reference/delete-a-contact.md
  - https://dev.frontapp.com/reference/delete-a-knowledge-base-category.md
  - https://dev.frontapp.com/reference/delete-an-account.md
  - https://dev.frontapp.com/reference/delete-an-article.md
  - https://dev.frontapp.com/reference/delete-company-teammate-group.md
  - https://dev.frontapp.com/reference/delete-contact-handle.md
  - https://dev.frontapp.com/reference/delete-contact-list.md
  - https://dev.frontapp.com/reference/delete-conversation-followers.md
  - https://dev.frontapp.com/reference/delete-conversation.md
  - https://dev.frontapp.com/reference/delete-draft.md
  - https://dev.frontapp.com/reference/delete-folder.md
  - https://dev.frontapp.com/reference/delete-group.md
  - https://dev.frontapp.com/reference/delete-message-template.md
  - https://dev.frontapp.com/reference/delete-signature.md
  - https://dev.frontapp.com/reference/delete-tag.md
  - https://dev.frontapp.com/reference/delete-time-off.md
  - https://dev.frontapp.com/reference/download-attachment-for-a-comment.md
  - https://dev.frontapp.com/reference/download-attachment-for-a-message-template.md
  - https://dev.frontapp.com/reference/download-attachment-for-a-message.md
  - https://dev.frontapp.com/reference/download-attachment-from-an-article.md
  - https://dev.frontapp.com/reference/download-attachment.md
  - https://dev.frontapp.com/reference/edit-draft.md
  - https://dev.frontapp.com/reference/fetch-an-account.md
  - https://dev.frontapp.com/reference/get-a-knowledge-base-article.md
  - https://dev.frontapp.com/reference/get-a-knowledge-base-category.md
  - https://dev.frontapp.com/reference/get-a-knowledge-base-with-content-in-default-locale.md
  - https://dev.frontapp.com/reference/get-a-knowledge-base-with-content-in-specified-locale.md
  - https://dev.frontapp.com/reference/get-a-knowledge-base.md
  - https://dev.frontapp.com/reference/get-analytics-export.md
  - https://dev.frontapp.com/reference/get-analytics-report.md
  - https://dev.frontapp.com/reference/get-channel.md
  - https://dev.frontapp.com/reference/get-child-folders.md
  - https://dev.frontapp.com/reference/get-child-templates.md
  - https://dev.frontapp.com/reference/get-comment.md
  - https://dev.frontapp.com/reference/get-company-teammate-group.md
  - https://dev.frontapp.com/reference/get-contact.md
  - https://dev.frontapp.com/reference/get-conversation-by-id.md
  - https://dev.frontapp.com/reference/get-event.md
  - https://dev.frontapp.com/reference/get-folder.md
  - https://dev.frontapp.com/reference/get-inbox.md
  - https://dev.frontapp.com/reference/get-knowledge-base-article-with-content-in-default-locale.md
  - https://dev.frontapp.com/reference/get-knowledge-base-article-with-content-in-specified-locale.md
  - https://dev.frontapp.com/reference/get-knowledge-base-category-content-in-default-locale.md
  - https://dev.frontapp.com/reference/get-knowledge-base-category-with-content-in-specified-locale.md
  - https://dev.frontapp.com/reference/get-link.md
  - https://dev.frontapp.com/reference/get-message-seen-status.md
  - https://dev.frontapp.com/reference/get-message-template.md
  - https://dev.frontapp.com/reference/get-message.md
  - https://dev.frontapp.com/reference/get-rule.md
  - https://dev.frontapp.com/reference/get-shift.md
  - https://dev.frontapp.com/reference/get-signatures.md
  - https://dev.frontapp.com/reference/get-tag.md
  - https://dev.frontapp.com/reference/get-team.md
  - https://dev.frontapp.com/reference/get-teammate.md
  - https://dev.frontapp.com/reference/get-ticket-status-by-id.md
  - https://dev.frontapp.com/reference/get-time-off.md
  - https://dev.frontapp.com/reference/get-view.md
  - https://dev.frontapp.com/reference/import-inbox-message.md
  - https://dev.frontapp.com/reference/list-account-contacts.md
  - https://dev.frontapp.com/reference/list-account-custom-fields.md
  - https://dev.frontapp.com/reference/list-accounts.md
  - https://dev.frontapp.com/reference/list-all-company-rules.md
  - https://dev.frontapp.com/reference/list-articles-in-a-category.md
  - https://dev.frontapp.com/reference/list-articles-in-a-knowledge-base.md
  - https://dev.frontapp.com/reference/list-assigned-conversations.md
  - https://dev.frontapp.com/reference/list-categories-in-a-knowledge-base.md
  - https://dev.frontapp.com/reference/list-channels.md
  - https://dev.frontapp.com/reference/list-comment-mentions.md
  - https://dev.frontapp.com/reference/list-company-tags.md
  - https://dev.frontapp.com/reference/list-company-teammate-group-team-inboxes.md
  - https://dev.frontapp.com/reference/list-company-teammate-group-teammates.md
  - https://dev.frontapp.com/reference/list-company-teammate-group-teams.md
  - https://dev.frontapp.com/reference/list-company-teammate-groups.md
  - https://dev.frontapp.com/reference/list-company-ticket-statuses.md
  - https://dev.frontapp.com/reference/list-contact-conversations.md
  - https://dev.frontapp.com/reference/list-contact-custom-fields.md
  - https://dev.frontapp.com/reference/list-contact-lists.md
  - https://dev.frontapp.com/reference/list-contacts-in-contact-list.md
  - https://dev.frontapp.com/reference/list-contacts-in-group.md
  - https://dev.frontapp.com/reference/list-contacts.md
  - https://dev.frontapp.com/reference/list-conversation-comments.md
  - https://dev.frontapp.com/reference/list-conversation-custom-fields.md
  - https://dev.frontapp.com/reference/list-conversation-drafts.md
  - https://dev.frontapp.com/reference/list-conversation-events.md
  - https://dev.frontapp.com/reference/list-conversation-followers.md
  - https://dev.frontapp.com/reference/list-conversation-inboxes.md
  - https://dev.frontapp.com/reference/list-conversation-messages.md
  - https://dev.frontapp.com/reference/list-conversations.md
  - https://dev.frontapp.com/reference/list-custom-fields.md
  - https://dev.frontapp.com/reference/list-events.md
  - https://dev.frontapp.com/reference/list-folders.md
  - https://dev.frontapp.com/reference/list-groups.md
  - https://dev.frontapp.com/reference/list-inbox-access.md
  - https://dev.frontapp.com/reference/list-inbox-channels.md
  - https://dev.frontapp.com/reference/list-inbox-conversations.md
  - https://dev.frontapp.com/reference/list-inbox-custom-fields.md
  - https://dev.frontapp.com/reference/list-inboxes.md
  - https://dev.frontapp.com/reference/list-knowledge-bases.md
  - https://dev.frontapp.com/reference/list-link-conversations.md
  - https://dev.frontapp.com/reference/list-link-custom-fields.md
  - https://dev.frontapp.com/reference/list-linked-conversations.md
  - https://dev.frontapp.com/reference/list-links.md
  - https://dev.frontapp.com/reference/list-message-templates.md
  - https://dev.frontapp.com/reference/list-notes.md
  - https://dev.frontapp.com/reference/list-rules.md
  - https://dev.frontapp.com/reference/list-shifts-teammates.md
  - https://dev.frontapp.com/reference/list-shifts.md
  - https://dev.frontapp.com/reference/list-tag-children.md
  - https://dev.frontapp.com/reference/list-tagged-conversations.md
  - https://dev.frontapp.com/reference/list-tags.md
  - https://dev.frontapp.com/reference/list-team-channels.md
  - https://dev.frontapp.com/reference/list-team-contact-lists.md
  - https://dev.frontapp.com/reference/list-team-contacts.md
  - https://dev.frontapp.com/reference/list-team-folders.md
  - https://dev.frontapp.com/reference/list-team-groups.md
  - https://dev.frontapp.com/reference/list-team-inboxes.md
  - https://dev.frontapp.com/reference/list-team-message-templates.md
  - https://dev.frontapp.com/reference/list-team-rules.md
  - https://dev.frontapp.com/reference/list-team-shifts.md
  - https://dev.frontapp.com/reference/list-team-signatures.md
  - https://dev.frontapp.com/reference/list-team-tags.md
  - https://dev.frontapp.com/reference/list-team-time-offs.md
  - https://dev.frontapp.com/reference/list-team-views.md
  - https://dev.frontapp.com/reference/list-teammate-channels.md
  - https://dev.frontapp.com/reference/list-teammate-contact-lists.md
  - https://dev.frontapp.com/reference/list-teammate-contacts.md
  - https://dev.frontapp.com/reference/list-teammate-custom-fields.md
  - https://dev.frontapp.com/reference/list-teammate-folders.md
  - https://dev.frontapp.com/reference/list-teammate-groups.md
  - https://dev.frontapp.com/reference/list-teammate-inboxes.md
  - https://dev.frontapp.com/reference/list-teammate-message-templates.md
  - https://dev.frontapp.com/reference/list-teammate-private-inboxes.md
  - https://dev.frontapp.com/reference/list-teammate-rules.md
  - https://dev.frontapp.com/reference/list-teammate-shifts.md
  - https://dev.frontapp.com/reference/list-teammate-signatures.md
  - https://dev.frontapp.com/reference/list-teammate-tags.md
  - https://dev.frontapp.com/reference/list-teammate-time-offs.md
  - https://dev.frontapp.com/reference/list-teammates.md
  - https://dev.frontapp.com/reference/list-teams.md
  - https://dev.frontapp.com/reference/list-views.md
  - https://dev.frontapp.com/reference/mark-message-seen.md
  - https://dev.frontapp.com/reference/merge-contacts.md
  - https://dev.frontapp.com/reference/receive-custom-messages.md
  - https://dev.frontapp.com/reference/remove-company-teammate-group-team-inboxes.md
  - https://dev.frontapp.com/reference/remove-company-teammate-group-teammates.md
  - https://dev.frontapp.com/reference/remove-company-teammate-group-teams.md
  - https://dev.frontapp.com/reference/remove-contact-from-account.md
  - https://dev.frontapp.com/reference/remove-contacts-from-contact-list.md
  - https://dev.frontapp.com/reference/remove-contacts-from-group.md
  - https://dev.frontapp.com/reference/remove-conversation-links.md
  - https://dev.frontapp.com/reference/remove-conversation-tag.md
  - https://dev.frontapp.com/reference/remove-teammates-from-shift.md
  - https://dev.frontapp.com/reference/remove-teammates-from-team.md
  - https://dev.frontapp.com/reference/removes-inbox-access.md
  - https://dev.frontapp.com/reference/search-conversations.md
  - https://dev.frontapp.com/reference/trigger-app-event.md
  - https://dev.frontapp.com/reference/update-a-company-teammate-group.md
  - https://dev.frontapp.com/reference/update-a-contact.md
  - https://dev.frontapp.com/reference/update-a-link.md
  - https://dev.frontapp.com/reference/update-a-tag.md
  - https://dev.frontapp.com/reference/update-account.md
  - https://dev.frontapp.com/reference/update-article-content-in-default-locale.md
  - https://dev.frontapp.com/reference/update-article-content-in-specified-locale.md
  - https://dev.frontapp.com/reference/update-channel.md
  - https://dev.frontapp.com/reference/update-comment.md
  - https://dev.frontapp.com/reference/update-conversation-assignee.md
  - https://dev.frontapp.com/reference/update-conversation-reminders.md
  - https://dev.frontapp.com/reference/update-conversation.md
  - https://dev.frontapp.com/reference/update-folder.md
  - https://dev.frontapp.com/reference/update-knowledge-base-category-in-default-locale.md
  - https://dev.frontapp.com/reference/update-knowledge-base-category-in-specified-locale.md
  - https://dev.frontapp.com/reference/update-knowledge-base-in-default-locale.md
  - https://dev.frontapp.com/reference/update-knowledge-base-in-specified-locale.md
  - https://dev.frontapp.com/reference/update-message-template.md
  - https://dev.frontapp.com/reference/update-shift.md
  - https://dev.frontapp.com/reference/update-signature.md
  - https://dev.frontapp.com/reference/update-teammate.md
  - https://dev.frontapp.com/reference/update-time-off.md
  - https://dev.frontapp.com/reference/update-view.md
  - https://dev.frontapp.com/reference/validate-channel.md
  merge:
    pages: 246
    deduped: 928
    conflicts_kept_first: 0