Skip to navigation
API ReferenceRobots

Get a robot

Returns one robot, in the same shape as a list entry.

Authentication

AuthorizationBearer

Your API key, issued by ParsChat sales. One key per account, spanning every robot you own. Send it as Authorization: Bearer pk_live_….

Path parameters

robot_idstringRequired
The robot's id, as returned by the create call.

Response

The robot.
idstringOptional
ParsChat identifier for the robot.
namestringOptional
Display name, shown in the panel.
external_idstringOptional
Your own identifier for this customer. Returned on every webhook event, so you do not need a lookup table.
channelslist of objectsOptional
Channels attached to this robot, in short form. Empty until you connect one. Call the channels endpoint for the full record.
created_atdatetimeOptional
When the robot was created.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error
500
Internal Server Error
503
Service Unavailable Error