Get a Unit

Prev Next
Get
/api/v1/livechat/units/{id}
Premium tag

Get details of a specific unit.
Permission required: manage-livechat-units

Header parameters
X-Auth-Token
stringRequired

The authToken of the authenticated user.

ExampleRScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f
X-User-Id
stringRequired

The userId of the authenticated user.

ExamplerbAXPnMktTFbNpwtJ
Path parameters
id
stringRequired

The unit ID.

Responses
200
Success Example
{
  "_id": "LnM2rzbknjYSkkd5p",
  "name": "Sales Unit",
  "visibility": "public",
  "type": "u",
  "numMonitors": 1,
  "numDepartments": 2,
  "_updatedAt": "2022-09-15T11:44:15.721Z",
  "success": true
}
object
_id
string
name
string
visibility
string
type
string
numMonitors
integer
numDepartments
integer
_updatedAt
string
success
boolean
401

Unauthorized

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

Forbidden

Permission Error
{
  "success": false,
  "error": "User does not have the permissions required for this action [error-unauthorized]"
}
Unauthorized
{
  "success": false,
  "error": "unauthorized"
}
object
success
boolean
error
string