Inquirly
  1. Inboxes
Inquirly
  • Accounts
    • Create an Account
      POST
    • Get an account details
      GET
    • Update an account
      PATCH
    • Delete an Account
      DELETE
  • Account Users
    • List all Account Users
      GET
    • Create an Account User
      POST
    • Delete an Account User
      DELETE
  • AgentBots
    • List all AgentBots
      GET
    • Create an Agent Bot
      POST
    • Get an agent bot details
      GET
    • Update an agent bot
      PATCH
    • Delete an AgentBot
      DELETE
  • Users
    • Create a User
      POST
    • Get an user details
      GET
    • Update a user
      PATCH
    • Delete a User
      DELETE
    • Get User SSO Link
      GET
  • Inbox API
    • Inbox details
  • Contacts API
    • Create a contact
    • Get a contact
    • Update a contact
  • Conversations API
    • Create a conversation
    • List all conversations
    • Get a single conversation
    • Resolve a conversation
    • Toggle typing status
    • Update last seen
  • Messages API
    • Create a message
    • List all messages
    • Update a message
  • Contact Labels
    • List Labels
    • Add Labels
  • CSAT Survey Page
    • Get CSAT survey page
  • Account AgentBots
    • List all AgentBots
    • Create an Agent Bot
    • Get an agent bot details
    • Update an agent bot
    • Delete an AgentBot
  • Agents
    • List Agents in Account
    • Add a New Agent
    • Update Agent in Account
    • Remove an Agent from Account
  • Canned Responses
    • List all Canned Responses in an Account
    • Add a New Canned Response
    • Remove a Canned Response from Account
  • Canned Response
    • Update Canned Response in Account
  • Custom Attributes
    • List all custom attributes in an account
    • Add a new custom attribute
    • Get a custom attribute details
    • Update custom attribute in Account
    • Remove a custom attribute from account
  • Contacts
    • List Contacts
    • Create Contact
    • Show Contact
    • Update Contact
    • Delete Contact
    • Contact Conversations
    • Search Contacts
    • Contact Filter
  • Contact
    • Create contact inbox
    • Get Contactable Inboxes
  • Automation Rule
    • List all automation rules in an account
    • Add a new automation rule
    • Get a automation rule details
    • Update automation rule in Account
    • Remove a automation rule from account
  • Help Center
    • Add a new portal
    • List all portals in an account
    • update a new portal
    • Add a new category
    • Add a new article
  • Conversations
    • Get Conversation Counts
    • Conversations List
    • Create New Conversation
    • Conversations Filter
    • Conversation Details
    • Update Conversation
    • Toggle Status
    • Toggle Priority
  • Conversation Assignment
    • Assign Conversation
  • Conversation Labels
    • List Labels
    • Add Labels
  • Inboxes
    • List all inboxes
      GET
    • Get an inbox
      GET
    • Create an inbox
      POST
    • Update Inbox
      PATCH
    • Show Inbox Agent Bot
      GET
    • Add or remove agent bot
      POST
    • List Agents in Inbox
      GET
    • Add a New Agent
      POST
    • Update Agents in Inbox
      PATCH
    • Remove an Agent from Inbox
      DELETE
  • Messages
    • Get messages
    • Create New Message
    • Delete a message
  • Integrations
    • List all the Integrations
    • Create an integration hook
    • Update an Integration Hook
    • Delete an Integration Hook
  • Profile
    • Fetch user profile
  • Teams
    • List all teams
    • Create a team
    • Get a team details
    • Update a team
    • Delete a team
    • List Agents in Team
    • Add a New Agent
    • Update Agents in Team
    • Remove an Agent from Team
  • Custom Filters
    • List all custom filters
    • Create a custom filter
    • Get a custom filter details
    • Update a custom filter
    • Delete a custom filter
  • Webhooks
    • List all webhooks
    • Add a webhook
    • Update a webhook object
    • Delete a webhook
  • Reports
    • Get Account reports
    • Get Account reports summary
    • Account Conversation Metrics
    • Agent Conversation Metrics
  1. Inboxes

List all inboxes

GET
/api/v1/accounts/{account_id}/inboxes
Inboxes
List all inboxes available in the current account
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/api/v1/accounts//inboxes'
Response Response Example
200 - Example 1
[
    {
        "id": 0,
        "name": "string",
        "website_url": "string",
        "channel_type": "string",
        "avatar_url": "string",
        "widget_color": "string",
        "website_token": "string",
        "enable_auto_assignment": true,
        "web_widget_script": "string",
        "welcome_title": "string",
        "welcome_tagline": "string",
        "greeting_enabled": true,
        "greeting_message": "string"
    }
]

Request

Path Params
account_id
integer 
required
The numeric ID of the account

Responses

🟢200OK
application/json; charset=utf-8
Success
Body
Array of inboxes
array of:
id
number 
optional
ID of the inbox
name
string 
optional
The name of the inbox
website_url
string 
optional
Website URL
channel_type
string 
optional
The type of the inbox
avatar_url
string 
optional
The avatar image of the inbox
widget_color
string 
optional
Widget Color used for customization of the widget
website_token
string 
optional
Website Token
enable_auto_assignment
boolean 
optional
The flag which shows whether Auto Assignment is enabled or not
web_widget_script
string 
optional
Script used to load the website widget
welcome_title
string 
optional
Welcome title to be displayed on the widget
welcome_tagline
string 
optional
Welcome tagline to be displayed on the widget
greeting_enabled
boolean 
optional
The flag which shows whether greeting is enabled
greeting_message
string 
optional
A greeting message when the user starts the conversation
🟠403Forbidden
🟠404Record Not Found
Previous
Add Labels
Next
Get an inbox
Built with