Hellou AI Custom Filters API

openapi: 3.2.0
info:
  title: HellouOne Custom Filters API
  version: 1.0.0
  description: 'The HellouOne REST API: everything the dashboard does, available to your

    own systems — CRMs, bots, BI tools and back-office automation.'
  termsOfService: https://hellou.ai/en/legal/terms/
  contact:
    name: HellouOne support
    email: support@hellou.ai
servers:
- url: https://one.hellou.ai
  description: HellouOne cloud
security:
- userApiKey: []
tags:
- name: Custom Filters
paths:
  /api/v1/accounts/{account_id}/custom_filters:
    parameters:
    - $ref: '#/components/parameters/account_id'
    get:
      tags:
      - Custom Filters
      operationId: list-all-filters
      summary: List all custom filters
      description: 'List the saved filters (custom views) of the person making the request, for one kind of list - conversations by default, or contacts or reports with filter_type


        **Requires feature:** `crm` when the filter is a contact filter (`filter_type` = `contact`)'
      parameters:
      - in: query
        name: filter_type
        schema:
          type: string
          enum:
          - conversation
          - contact
          - report
        required: false
        description: The type of custom filter
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: array
                description: Array of custom filters
                items:
                  $ref: '#/components/schemas/custom_filter'
        '401':
          description: Unauthorized
        '403':
          $ref: '#/components/responses/forbidden'
    post:
      tags:
      - Custom Filters
      operationId: create-a-custom-filter
      summary: Create a custom filter
      description: 'Create a custom filter in the account


        **Requires feature:** `crm` when the filter is a contact filter (`filter_type` = `contact`)'
      parameters:
      - $ref: '#/components/parameters/account_id'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/custom_filter'
        '401':
          description: Unauthorized
        '403':
          $ref: '#/components/responses/forbidden'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/custom_filter_create_update_payload'
  /api/v1/accounts/{account_id}/custom_filters/{custom_filter_id}:
    parameters:
    - $ref: '#/components/parameters/account_id'
    - $ref: '#/components/parameters/custom_filter_id'
    get:
      tags:
      - Custom Filters
      operationId: get-details-of-a-single-custom-filter
      summary: Get a custom filter details
      description: 'Get the details of a custom filter in the account


        **Requires feature:** `crm` when the filter is a contact filter (`filter_type` = `contact`)'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/custom_filter'
        '401':
          description: Unauthorized
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          description: The given team ID does not exist in the account
    patch:
      tags:
      - Custom Filters
      operationId: update-a-custom-filter
      summary: Update a custom filter
      description: 'Update a custom filter''s attributes


        **Requires feature:** `crm` when the filter is a contact filter (`filter_type` = `contact`)'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/custom_filter'
        '401':
          description: Unauthorized
        '403':
          $ref: '#/components/responses/forbidden'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/custom_filter_create_update_payload'
    delete:
      tags:
      - Custom Filters
      operationId: delete-a-custom-filter
      summary: Delete a custom filter
      description: 'Delete a custom filter from the account


        **Requires feature:** `crm` when the filter is a contact filter (`filter_type` = `contact`)'
      responses:
        '200':
          description: Success
        '401':
          description: Unauthorized
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          description: The custom filter does not exist in the account
components:
  parameters:
    custom_filter_id:
      in: path
      name: custom_filter_id
      required: true
      description: The numeric ID of the custom filter
      schema:
        type: integer
    account_id:
      in: path
      name: account_id
      required: true
      description: The numeric ID of the account
      schema:
        type: integer
  responses:
    forbidden:
      description: 'Not allowed: the user''s role does not permit it, the feature is not enabled

        for the account (`reason: feature_disabled`), or the account is read-only.

        '
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/error_message'
  schemas:
    custom_filter:
      type: object
      properties:
        id:
          type: number
          description: The ID of the custom filter
        name:
          type: string
          description: The name of the custom filter
        filter_type:
          type: string
          enum:
          - conversation
          - contact
          - report
          description: Which list the filter applies to - conversations, contacts or reports
        query:
          type: object
          description: A query that needs to be saved as a custom filter
        created_at:
          type: string
          format: date-time
          description: The time at which the custom filter was created
        updated_at:
          type: string
          format: date-time
          description: The time at which the custom filter was updated
    error_message:
      type: object
      description: An error with a human-readable message.
      properties:
        error:
          type: string
          description: What went wrong.
        reason:
          type: string
          description: Machine-readable cause, when there is one (for example `feature_disabled`).
      required:
      - error
    custom_filter_create_update_payload:
      type: object
      properties:
        name:
          type: string
          description: The name of the custom filter
        filter_type:
          type: string
          enum:
          - conversation
          - contact
          - report
          description: Which list the filter applies to - conversations (the default), contacts or reports
        query:
          type: object
          description: A query that needs to be saved as a custom filter
  securitySchemes:
    userApiKey:
      type: apiKey
      in: header
      name: api_access_token
      description: 'A user''s access token, from **Profile settings → Access token** in the dashboard.

        Requests act with that user''s role: administrators reach everything in their

        account, agents only what their role and visibility settings allow.

        '
    agentBotApiKey:
      type: apiKey
      in: header
      name: api_access_token
      description: 'An agent bot''s access token, shown to administrators on the bot''s settings page.

        Bot tokens reach a limited set of conversation and message endpoints.

        '
    platformAppApiKey:
      type: apiKey
      in: header
      name: api_access_token
      description: 'A platform app token, issued by the installation operator. Used to provision

        accounts, users, account memberships and agent bots.

        '
    connectorInvokeToken:
      type: http
      scheme: bearer
      description: 'A connector''s invoke token (`hci_…`), sent as `Authorization: Bearer <token>`.

        Each connector install has its own; it is rotated whenever the connector is

        reconnected or disconnected, so a stale copy stops working.

        '
x-tagGroups:
- name: Guides
  tags:
  - Introduction
  - Authentication
  - Errors
  - Pagination
  - Rate limits
  - Webhook events
- name: Webhook payloads
  tags:
  - Event payloads
- name: Platform
  tags:
  - Accounts
  - Account Users
  - AgentBots
  - Users
- name: Application
  tags:
  - Account AgentBots
  - Agents
  - Automation Rule
  - Campaigns
  - Canned Responses
  - Contacts
  - Contact Labels
  - Conversation Assignment
  - Conversation Labels
  - Conversations
  - Custom Attributes
  - Custom Filters
  - Help Center
  - Inboxes
  - Integrations
  - Macros
  - Messages
  - Profile
  - Reports
  - Security Settings
  - Teams
  - Webhooks
- name: Business tools
  tags:
  - AI Classifications
  - Assignment Settings
  - Calls
  - AI Phone Lines
  - Connectors
  - ElevenLabs Integration
  - Facebook Marketing
  - HellouAI Integration
  - Knowledge Base
  - Marketing Consent
  - Plan Upgrades
  - Voice Campaigns
  - WhatsApp Campaigns
  - WhatsApp Flows
  - WhatsApp Templates
- name: Client
  tags:
  - Inbox API
  - Contacts API
  - Conversations API
  - Messages API
- name: Others
  tags:
  - CSAT Survey Page