Get Archived Departments

Prev Next
Get
/api/v1/livechat/departments/archived

Get the list of archived departments in the workspace. Any of the following permissions is required:

  • view-livechat-departments
  • view-l-room
Header parameters
X-Auth-Token
stringRequired

The authToken of the authenticated user.

ExampleRScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f
X-User-Id
stringRequired

The userId of the authenticated user.

ExamplerbAXPnMktTFbNpwtJ
Responses
200

OK

Example 1
{
  "departments": [
    {
      "_id": "66fa9f5d6ea9eba859b650b6",
      "enabled": false,
      "showOnRegistration": true,
      "name": "gfyh88",
      "email": "john@doe.com",
      "showOnOfflineForm": true,
      "type": "d",
      "_updatedAt": "2025-03-28T11:17:22.654Z",
      "abandonedRoomsCloseCustomMessage": "",
      "allowReceiveForwardOffline": true,
      "chatClosingTags": [],
      "departmentsAllowedToForward": [],
      "description": "",
      "fallbackForwardDepartment": "",
      "offlineMessageChannelName": "",
      "requestTagBeforeClosingChat": false,
      "waitingQueueMessage": "",
      "numAgents": 0,
      "ancestors": [
        "67b84af9382738a951e6f3b8"
      ],
      "parentId": "67b84af9382738a951e6f3b8",
      "archived": true
    },
    {
      "_id": "66a7680360ab9acca6a57fad",
      "enabled": false,
      "name": "test-dept",
      "description": "",
      "showOnRegistration": false,
      "showOnOfflineForm": false,
      "requestTagBeforeClosingChat": false,
      "email": "test-dept@example.com",
      "chatClosingTags": [],
      "offlineMessageChannelName": "",
      "abandonedRoomsCloseCustomMessage": "",
      "waitingQueueMessage": "",
      "departmentsAllowedToForward": [],
      "fallbackForwardDepartment": "",
      "allowReceiveForwardOffline": false,
      "type": "d",
      "_updatedAt": "2025-04-02T11:28:31.651Z",
      "numAgents": 0,
      "archived": true
    }
  ],
  "count": 2,
  "offset": 0,
  "total": 2,
  "success": true
}
Expand All
object
departments
Array of object
object
_id
string
enabled
boolean
showOnRegistration
boolean
name
string
email
string
showOnOfflineForm
boolean
type
string
_updatedAt
string
abandonedRoomsCloseCustomMessage
string
allowReceiveForwardOffline
boolean
chatClosingTags
Array of object
object
departmentsAllowedToForward
Array of object
object
description
string
fallbackForwardDepartment
string
offlineMessageChannelName
string
requestTagBeforeClosingChat
boolean
waitingQueueMessage
string
numAgents
integer
ancestors
Array of string
string
parentId
string
archived
boolean
count
integer
offset
integer
total
integer
success
boolean
401

Unauthorized

Authorization Error
{
  "status": "error",
  "message": "You must be logged in to do this."
}
object
status
string
message
string