GET /api/v1/agents
Requires the users:manage permission.
Authentication
Use an agent API key and secret.
Responses
200
Agents retrieved successfully
Content type: application/json.
| Field | Type | Required | Description |
|---|---|---|---|
| status | string | No | example: "success" |
| data | array of object | No | |
| data[].id | integer | No | example: 76 |
| data[].type | string | No | example: "agent" |
| data[].first_name | string | No | example: "John" |
| data[].last_name | string | No | example: "Doe" |
| data[].email | string (email) | No | nullable: true example: "[email protected]" |
| data[].enabled | boolean | No | example: true |
| data[].avatar_url | string | No | nullable: true example: null |
| data[].created_at | string (date-time) | No | example: "2025-08-30T15:44:51.110888Z" |
| data[].updated_at | string (date-time) | No | example: "2025-09-14T18:23:36.149041Z" |
| data[].external_user_id | string | No | External identifier for the user in your own system nullable: true |
| data[].availability_status | string (enum) | No | enum: ["online", "away", "away_manual", "offline", "away_and_reassigning"] example: "offline" |
401
Unauthorized
Content type: application/json.
| Field | Type | Required | Description |
|---|---|---|---|
| status | string | No | example: "error" |
| message | string | No | Error message example: "Invalid request" |
| data | unspecified | No | Additional error data nullable: true |
| error_type | string (enum) | No | enum: ["GeneralException", "PermissionException", "InputException", "DataException", "NetworkException", "NotFoundException", "ConflictException", "UnauthorizedException", "RateLimitException"] |
403
Forbidden
Content type: application/json.
| Field | Type | Required | Description |
|---|---|---|---|
| status | string | No | example: "error" |
| message | string | No | Error message example: "Invalid request" |
| data | unspecified | No | Additional error data nullable: true |
| error_type | string (enum) | No | enum: ["GeneralException", "PermissionException", "InputException", "DataException", "NetworkException", "NotFoundException", "ConflictException", "UnauthorizedException", "RateLimitException"] |
500
Internal server error
Content type: application/json.
| Field | Type | Required | Description |
|---|---|---|---|
| status | string | No | example: "error" |
| message | string | No | Error message example: "Invalid request" |
| data | unspecified | No | Additional error data nullable: true |
| error_type | string (enum) | No | enum: ["GeneralException", "PermissionException", "InputException", "DataException", "NetworkException", "NotFoundException", "ConflictException", "UnauthorizedException", "RateLimitException"] |
Specification
Download the complete OpenAPI specification.
OpenAPI definition for this endpoint
openapi: 3.0.0
info:
title: Libredesk API
description: >-
REST API documentation for Libredesk helpdesk system.
## Authentication
The Libredesk API supports two authentication methods:
### 1. Basic Authentication
Use your API key and secret with Basic authentication:
```
Authorization: Basic <base64_encoded_api_key:api_secret>
```
### 2. Token Authentication
Use your API key and secret with token authentication:
```
Authorization: token api_key:api_secret
```
To obtain API credentials, generate them from your agent profile in the
Libredesk dashboard.
version: 1.0.0
servers:
- url: http://localhost:8080
description: Local development server
security:
- basicAuth: []
- tokenAuth: []
paths:
/api/v1/agents:
get:
tags:
- Agents
summary: Get Agents
description: Requires the `users:manage` permission.
operationId: handleGetAgents
responses:
'200':
description: Agents retrieved successfully
content:
application/json:
schema:
$ref: '#/components/schemas/AgentListResponse'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
security:
- basicAuth: []
- tokenAuth: []
components:
schemas:
AgentListResponse:
type: object
properties:
status:
type: string
example: success
data:
type: array
items:
$ref: '#/components/schemas/AgentCompact'
ErrorResponse:
type: object
description: Error response format
properties:
status:
type: string
example: error
message:
type: string
description: Error message
example: Invalid request
data:
nullable: true
description: Additional error data
error_type:
type: string
enum:
- GeneralException
- PermissionException
- InputException
- DataException
- NetworkException
- NotFoundException
- ConflictException
- UnauthorizedException
- RateLimitException
AgentCompact:
type: object
properties:
id:
type: integer
example: 76
type:
type: string
example: agent
first_name:
type: string
example: John
last_name:
type: string
example: Doe
email:
type: string
format: email
example: [email protected]
nullable: true
enabled:
type: boolean
example: true
avatar_url:
type: string
nullable: true
example: null
created_at:
type: string
format: date-time
example: '2025-08-30T15:44:51.110888Z'
updated_at:
type: string
format: date-time
example: '2025-09-14T18:23:36.149041Z'
external_user_id:
type: string
nullable: true
description: External identifier for the user in your own system
availability_status:
type: string
enum:
- online
- away
- away_manual
- offline
- away_and_reassigning
example: offline
securitySchemes:
basicAuth:
type: http
scheme: basic
description: >-
Basic authentication using base64 encoded API key and secret. Format:
`Authorization: Basic <base64(api_key:api_secret)>`
tokenAuth:
type: apiKey
name: Authorization
in: header
description: >-
Token authentication using API key and secret. Format: `Authorization:
token api_key:api_secret`