Skip to content

Support

support_agent_get

Get one support agent by id, deactivated ones included.

Tool

support_agent_get

Get one support agent by id, deactivated ones included.

Get one support agent by id, deactivated ones included. An agent belonging to another product is reported as not found. Through the public edge the profile comes back without lesslyUserId — the binding never leaves the authenticated plane

Behavior

HTTP
GET /support/agents/:id

Arguments

NameTypeRequiredDescription
idstringAgent id

Response

FieldTypeAlwaysDescription
idstringAgent id
titlestringJob title shown under the name, or null if unset
isActivebooleanA deactivated agent keeps its history but can no longer be put on a thread
avatarUrlstringAvatar image URL, or null if unset
createdAtstringISO-8601 creation timestamp
updatedAtstringISO-8601 last-modification timestamp
displayNamestringName shown next to the agent replies
lesslyUserIdstringBound Lessly identity, stored verbatim and resolved by nobody. Null for an unbound profile — a bot or the client's own backend, which replies just like anyone else

Try it

Get one support agent by id, deactivated ones included.

When to use

Get one support agent by id, deactivated ones included. An agent belonging to another product is reported as not found. Through the public edge the profile comes back without lesslyUserId — the binding never leaves the authenticated plane

Example

Ask your agent something like this:

Get one support agent by id, deactivated ones included.

The agent will invoke support_agent_get with these arguments:

{
  "id": "<id>"
}

Esc

Start typing to search the docs.

navigateselect