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/hellou-ai:hellou-ai-teams-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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

openapi: 3.2.0
info:
  title: HellouOne Teams 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: Teams
paths:
  /api/v1/accounts/{account_id}/teams:
    parameters:
    - $ref: '#/components/parameters/account_id'
    get:
      tags:
      - Teams
      operationId: list-all-teams
      summary: List all teams
      description: 'List all teams available in the current account


        **Requires feature:** `team_management`'
      x-required-feature: team_management
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: array
                description: Array of teams
                items:
                  $ref: '#/components/schemas/team'
        '401':
          description: Unauthorized
        '403':
          $ref: '#/components/responses/forbidden'
    post:
      tags:
      - Teams
      operationId: create-a-team
      summary: Create a team
      description: 'Create a team in the account


        **Requires feature:** `team_management`'
      x-required-feature: team_management
      parameters:
      - $ref: '#/components/parameters/account_id'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/team'
        '401':
          description: Unauthorized
        '403':
          $ref: '#/components/responses/forbidden'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/team_create_update_payload'
  /api/v1/accounts/{account_id}/teams/{team_id}:
    parameters:
    - $ref: '#/components/parameters/account_id'
    - $ref: '#/components/parameters/team_id'
    get:
      tags:
      - Teams
      operationId: get-details-of-a-single-team
      summary: Get a team details
      description: 'Get the details of a team in the account


        **Requires feature:** `team_management`'
      x-required-feature: team_management
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/team'
        '401':
          description: Unauthorized
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          description: The given team ID does not exist in the account
    patch:
      tags:
      - Teams
      operationId: update-a-team
      summary: Update a team
      description: 'Update a team''s attributes


        **Requires feature:** `team_management`'
      x-required-feature: team_management
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/team'
        '401':
          description: Unauthorized
        '403':
          $ref: '#/components/responses/forbidden'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/team_create_update_payload'
    delete:
      tags:
      - Teams
      operationId: delete-a-team
      summary: Delete a team
      description: 'Delete a team from the account


        **Requires feature:** `team_management`'
      x-required-feature: team_management
      responses:
        '200':
          description: Success
        '401':
          description: Unauthorized
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          description: The team does not exist in the account
  /api/v1/accounts/{account_id}/teams/{team_id}/team_members:
    parameters:
    - $ref: '#/components/parameters/account_id'
    - $ref: '#/components/parameters/team_id'
    get:
      tags:
      - Teams
      operationId: get-team-members
      summary: List Agents in Team
      description: 'Get Details of Agents in an Team


        **Requires feature:** `team_management`'
      x-required-feature: team_management
      security:
      - userApiKey: []
      parameters:
      - $ref: '#/components/parameters/account_id'
      - $ref: '#/components/parameters/team_id'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: array
                description: Array of all agents in the team
                items:
                  $ref: '#/components/schemas/agent'
        '404':
          description: Inbox not found
        '403':
          $ref: '#/components/responses/forbidden'
    post:
      tags:
      - Teams
      operationId: add-new-agent-to-team
      summary: Add a New Agent
      description: 'Add a new Agent to Team


        **Requires feature:** `team_management`'
      x-required-feature: team_management
      security:
      - userApiKey: []
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: array
                description: Array of all active agents
                items:
                  $ref: '#/components/schemas/agent'
        '404':
          description: Team not found
        '403':
          $ref: '#/components/responses/forbidden'
        '422':
          description: User must exist
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - user_ids
              properties:
                user_ids:
                  type: array
                  items:
                    type: integer
                  description: IDs of users to be added to the team
    patch:
      tags:
      - Teams
      operationId: update-agents-in-team
      summary: Update Agents in Team
      description: 'Set the team''s members to exactly the agents in user_ids: agents not in the list are removed from the team, new ones are added


        **Requires feature:** `team_management`'
      x-required-feature: team_management
      security:
      - userApiKey: []
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: array
                description: Array of all agents in the team
                items:
                  $ref: '#/components/schemas/agent'
        '404':
          description: Team not found
        '403':
          $ref: '#/components/responses/forbidden'
        '422':
          description: User must exist
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - user_ids
              properties:
                user_ids:
                  type: array
                  items:
                    type: integer
                  description: IDs of users to be added to the team
    delete:
      tags:
      - Teams
      operationId: delete-agent-in-team
      summary: Remove an Agent from Team
      description: 'Remove an Agent from Team


        **Requires feature:** `team_management`'
      x-required-feature: team_management
      security:
      - userApiKey: []
      responses:
        '200':
          description: Success
        '404':
          description: Team not found
        '403':
          $ref: '#/components/responses/forbidden'
        '422':
          description: User must exist
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - team_id
              - user_ids
              properties:
                user_ids:
                  type: array
                  items:
                    type: integer
                  description: IDs of users to be deleted from the team
components:
  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'
  parameters:
    account_id:
      in: path
      name: account_id
      required: true
      description: The numeric ID of the account
      schema:
        type: integer
    team_id:
      in: path
      name: team_id
      required: true
      description: The ID of the team to be updated
      schema:
        type: integer
  schemas:
    team_create_update_payload:
      type: object
      properties:
        name:
          type: string
          description: The name of the team
        description:
          type: string
          description: The description of the team
        allow_auto_assign:
          type: boolean
          description: If this setting is turned on, the system would automatically assign the conversation to an agent in the team while assigning the conversation to a team
        icon:
          type:
          - string
          - 'null'
          enum:
          - null
          - people-team
          - headphones-sound-wave
          - chat
          - call
          - mail
          - tag
          - credit-card-person
          - content-settings
          - lock-shield
          - star-emphasis
          - heart-handshake
          - building-bank
          - globe
          - flash-on
          - book
          - wand
          - settings
          - alert
          - calendar
          - briefcase
          description: Icon shown beside the team in the sidebar and assignment menus (bare icon name). Null means no icon
        icon_color:
          type:
          - string
          - 'null'
          enum:
          - null
          - slate
          - blue
          - green
          - amber
          - red
          - violet
          - teal
          - pink
          description: Colour of the team icon. Null means the default colour
    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
    team:
      type: object
      properties:
        id:
          type: number
          description: The ID of the team
        name:
          type: string
          description: The name of the team
        description:
          type:
          - string
          - 'null'
          description: The description about the team
        allow_auto_assign:
          type: boolean
          description: If this setting is turned on, the system would automatically assign the conversation to an agent in the team while assigning the conversation to a team
        icon:
          type:
          - string
          - 'null'
          enum:
          - null
          - people-team
          - headphones-sound-wave
          - chat
          - call
          - mail
          - tag
          - credit-card-person
          - content-settings
          - lock-shield
          - star-emphasis
          - heart-handshake
          - building-bank
          - globe
          - flash-on
          - book
          - wand
          - settings
          - alert
          - calendar
          - briefcase
          description: Icon shown beside the team in the sidebar and assignment menus (bare icon name). Null means no icon
        icon_color:
          type:
          - string
          - 'null'
          enum:
          - null
          - slate
          - blue
          - green
          - amber
          - red
          - violet
          - teal
          - pink
          description: Colour of the team icon. Null means the default colour
        account_id:
          type: number
          description: The ID of the account with the team is a part of
        is_member:
          type: boolean
          description: This field shows whether the current user is a part of the team
    agent:
      type: object
      properties:
        id:
          type: integer
        uid:
          type: string
        name:
          type: string
        available_name:
          type: string
        display_name:
          type: string
        email:
          type: string
        account_id:
          type: integer
        role:
          type: string
          enum:
          - agent
          - administrator
        confirmed:
          type: boolean
        availability_status:
          type: string
          enum:
          - available
          - busy
          - offline
          description: The availability status of the agent computed by HellouOne.
        auto_offline:
          type: boolean
          description: Whether the availability status of agent is configured to go offline automatically when away.
        custom_attributes:
          type: object
          description: Available for users who are created through platform APIs and has custom attributes associated.
  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