Skip to main content
GET
List employees

Authorizations

X-API-Key
string
header
required

API key for external access. Format: tp_live_<32-hex-chars>. Create keys in the TalkPilot Dashboard under Settings > API.

Path Parameters

agentId
string<uuid>
required

Agent UUID

Query Parameters

page
integer
default:1

Page number

Required range: x >= 1
limit
integer
default:20

Items per page

Required range: 1 <= x <= 100
status
enum<string>

Filter by employee status Employee availability status:

  • anwesend — Present / available
  • urlaub — On vacation
  • krank — Sick leave
  • weiterbildung — In training
  • notdienst — Emergency duty
  • im_termin — In a meeting
  • ausser_haus — Out of office
Available options:
anwesend,
urlaub,
krank,
weiterbildung,
notdienst,
im_termin,
ausser_haus
active
boolean

Filter by active state

Response

List of employees

data
object[]
pagination
object