GET /api/v1/tags
Returns tags sorted by name.
Authentication
Use an agent API key and secret.
Parameters
All parameters are query parameters. All parameters are optional.
| Name | Type | Description |
|---|---|---|
| q | string | Return only tags whose name contains this text (case-insensitive). |
| ids | string | Comma-separated tag IDs, at most 200. When set, returns those tags and ignores q, page and page_size. |
| page | integer | Page number, used with page_size. default: 1 minimum: 1 |
| page_size | integer | Number of tags per page, max 500. Omit or send 0 to return all matching tags. minimum: 0 maximum: 500 |
Responses
200
Tags retrieved successfully
Content type: application/json.
All fields are optional.
| Field | Type | Description |
|---|---|---|
| status | string | example: "success" |
| data | array of object | |
| data[].id | integer | example: 1 |
| data[].created_at | string (date-time) | example: "2025-08-28T10:00:00Z" |
| data[].updated_at | string (date-time) | example: "2025-08-28T10:00:00Z" |
| data[].name | string | example: "billing" |
401
Unauthorized
Content type: application/json.
All fields are optional.
| Field | Type | Description |
|---|---|---|
| status | string | example: "error" |
| message | string | Error message example: "Invalid request" |
| data | unspecified | Additional error data nullable: true |
| error_type | string (enum) | enum: ["GeneralException", "PermissionException", "InputException", "DataException", "NetworkException", "NotFoundException", "ConflictException", "UnauthorizedException", "RateLimitException"] |
500
Internal server error
Content type: application/json.
Response fields match the 401 response.
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/tags:
get:
tags:
- Tags
summary: List Tags
description: Returns tags sorted by name.
operationId: handleGetTags
parameters:
- name: q
in: query
required: false
schema:
type: string
description: Return only tags whose name contains this text (case-insensitive).
- name: ids
in: query
required: false
schema:
type: string
description: >-
Comma-separated tag IDs, at most 200. When set, returns those tags
and ignores `q`, `page` and `page_size`.
- name: page
in: query
required: false
schema:
type: integer
minimum: 1
default: 1
description: Page number, used with `page_size`.
- name: page_size
in: query
required: false
schema:
type: integer
minimum: 0
maximum: 500
description: >-
Number of tags per page, max 500. Omit or send 0 to return all
matching tags.
responses:
'200':
description: Tags retrieved successfully
content:
application/json:
schema:
$ref: '#/components/schemas/TagListResponse'
'401':
description: Unauthorized
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:
TagListResponse:
type: object
properties:
status:
type: string
example: success
data:
type: array
items:
$ref: '#/components/schemas/Tag'
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
Tag:
type: object
properties:
id:
type: integer
example: 1
created_at:
type: string
format: date-time
example: '2025-08-28T10:00:00Z'
updated_at:
type: string
format: date-time
example: '2025-08-28T10:00:00Z'
name:
type: string
example: billing
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`
