Skip to content

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

Name
Type
Required
Description
id
string
•
Agent id

Response

Field
Type
Always
Description
id
string
•
Agent id
title
string
•
Job title shown under the name, or null if unset
isActive
boolean
•
A deactivated agent keeps its history but can no longer be put on a thread
avatarUrl
string
•
Avatar image URL, or null if unset
createdAt
string
•
ISO-8601 creation timestamp
updatedAt
string
•
ISO-8601 last-modification timestamp
displayName
string
•
Name shown next to the agent replies
lesslyUserId
string
•
Bound Lepsto 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.

↑↓navigate↵select