Inquirly
  1. Agents
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
      GET
  • Contacts API
    • Create a contact
      POST
    • Get a contact
      GET
    • Update a contact
      PATCH
  • 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
      GET
    • Add a New Agent
      POST
    • Update Agent in Account
      PATCH
    • Remove an Agent from Account
      DELETE
  • 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 an inbox
    • Create an inbox
    • Update Inbox
    • Show Inbox Agent Bot
    • Add or remove agent bot
    • List Agents in Inbox
    • Add a New Agent
    • Update Agents in Inbox
    • Remove an Agent from Inbox
  • 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. Agents

List Agents in Account

GET
/api/v1/accounts/{account_id}/agents
Agents
Get Details of Agents in an Account
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/api/v1/accounts//agents'
Response Response Example
200 - Example 1
[
    {
        "id": 0,
        "uid": "string",
        "name": "string",
        "available_name": "string",
        "display_name": "string",
        "email": "string",
        "account_id": 0,
        "role": "agent",
        "confirmed": true,
        "availability_status": "available",
        "auto_offline": true,
        "custom_attributes": {}
    }
]

Request

Path Params
account_id
string 
required

Responses

🟢200OK
application/json; charset=utf-8
Success
Body
Array of all active agents
array of:
id
integer 
optional
uid
string 
optional
name
string 
optional
available_name
string 
optional
display_name
string 
optional
email
string 
optional
account_id
integer 
optional
role
enum<string> 
optional
Allowed values:
agentadministrator
confirmed
boolean 
optional
availability_status
enum<string> 
optional
The availability status of the agent computed by Chatwoot.
Allowed values:
availablebusyoffline
auto_offline
boolean 
optional
Whether the availability status of agent is configured to go offline automatically when away.
custom_attributes
object 
optional
Available for users who are created through platform APIs and has custom attributes associated.
🟠403Forbidden
Previous
Delete an AgentBot
Next
Add a New Agent
Built with