Hootsuite

Hootsuite Queue Rest API

When calling the Queue API, the client needs to be authenticated. The [REST API authentication](#tag/rest-api-authentication) section contains more details on how to authenticate your client.

Documentation GitHub OpenAPI

Operations 1

GET /inbox/v1/queue/lock Conversations locked by an agent #

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/hootsuite-queue-rest-api-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

openapi: 3.2.0
info:
  title: Inbox 2.0 API Reference Queue Rest API
  description: Inbox 2.0 API Reference
  version: v1
  x-logo:
    url: static/hootsuite-logo.png
  contact:
    email: dev.support@hootsuite.com
  license:
    name: Hootsuite Developer Terms and API License Agreement
    url: https://hootsuite.com/legal/dev-api-terms
servers:
- url: https://platform.hootsuite.com
  description: Inbox 2.0 production server
security:
- bearer-token: []
tags:
- name: queue_rest_api
  x-displayName: REST API
  description: 'When calling the Queue API, the client needs to be authenticated.


    The REST API authentication section contains more details on how to authenticate your client.'
paths:
  /inbox/v1/queue/lock:
    get:
      tags:
      - queue_rest_api
      summary: Conversations locked by an agent
      operationId: lock
      description: An overview of conversations with the agent that locked the conversation.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LockResponse'
              example:
                locks:
                - conversationId: 9dee60dc-cbbf-11ec-95ef-8e8b58e7d3d8
                  userId: 57fc9dc2-2b6f-11ec-aed1-66640cff431f
                  lockedAt: '2022-05-14T14:15:33.437Z'
        '401':
          description: 'Unauthorized: when using an invalid or expired access token.

            '
components:
  schemas:
    LockResponse:
      type: object
      properties:
        locks:
          type: array
          items:
            type: object
            properties:
              conversationId:
                type: string
                example: 9dee60dc-cbbf-11ec-95ef-8e8b58e7d3d8
                description: 'The id of the conversation.

                  '
              userId:
                type: string
                example: 57fc9dc2-2b6f-11ec-aed1-66640cff431f
                description: 'The user id of the agent.

                  '
              lockedAt:
                type: string
                description: 'The timestamp since when the agent has locked the conversation.

                  '
                format: date-time
                example: '2022-05-14T14:15:33.437Z'
  securitySchemes:
    bearer-token:
      type: http
      scheme: bearer
    basic-auth:
      type: http
      scheme: basic
    Oauth2ClientCredentials:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: TO_BE_CONFIGURED_IN_INBOX_2_0
          scopes:
            some_scope: TO_BE_CONFIGURED_IN_INBOX_2_0
    SharedSecret:
      type: apiKey
      in: header
      name: X-Hootsuite-Signature
x-tagGroups:
- name: General
  tags:
  - rest-api-authentication
- name: CRM API
  tags:
  - crm_introduction
  - crm_webhooks
  - crm_rest_api
- name: Virtual Agent API
  tags:
  - vai_introduction
  - vai_webhooks
  - vai_rest_api
- name: Real-time metrics API
  tags:
  - real_time_metrics_introduction
  - real_time_metrics_rest_api
- name: User Presence API
  tags:
  - user_presence_introduction
  - user_presence_rest_api
- name: Queue API
  tags:
  - queue_introduction
  - queue_rest_api
- name: Proactive messaging API
  tags:
  - proactive_messaging_introduction
  - proactive_messaging_rest_api
- name: Messenger SDK
  tags:
  - messenger_introduction
  - messenger_web_sdk