Employees API

Create, update, and manage AI employees programmatically.

List Employees

GET /employees

curl -X GET "https://your-instance.elestio.app/api/v1/employees" \
  -H "Authorization: Bearer YOUR_API_KEY"

Response:

JSON Response

{
  "success": true,
  "data": [
    {
      "id": "emp_abc123",
      "name": "Sarah",
      "role": "Customer Support",
      "status": "active",
      "created_at": "2024-01-15T10:30:00Z"
    }
  ],
  "meta": { "page": 1, "total": 5 }
}

Get Employee

GET /employees/:id

curl -X GET "https://your-instance.elestio.app/api/v1/employees/emp_abc123" \
  -H "Authorization: Bearer YOUR_API_KEY"

Create Employee

POST /employees

curl -X POST "https://your-instance.elestio.app/api/v1/employees" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Alex",
    "role": "Sales Representative",
    "personality": "friendly",
    "skills": ["product_knowledge", "objection_handling"]
  }'

Update Employee

PATCH /employees/:id

curl -X PATCH "https://your-instance.elestio.app/api/v1/employees/emp_abc123" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "status": "inactive"
  }'

Delete Employee

DELETE /employees/:id

curl -X DELETE "https://your-instance.elestio.app/api/v1/employees/emp_abc123" \
  -H "Authorization: Bearer YOUR_API_KEY"

Employee Object

Field	Type	Description
`id`	string	Unique identifier
`name`	string	Employee name
`role`	string	Job title/role
`personality`	string	Personality type
`skills`	array	Assigned skill IDs
`status`	string	active, inactive, or archived
`avatar_url`	string	Profile image URL
`created_at`	datetime	Creation timestamp

PreviousAuthentication

NextConversations API