Skip to main content
GET
/
api
/
audio-management
/
audios
List all audio files
curl --request GET \
  --url http://localhost:3000/api/audio-management/audios
{
  "data": [
    {
      "id": "<string>",
      "title": "<string>",
      "usageType": "welcome",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "file": "<string>",
      "description": "<string>",
      "tags": [
        "<string>"
      ],
      "durationSeconds": 123,
      "sampleRate": 123,
      "channels": [
        "<string>"
      ],
      "bitDepth": 123,
      "organizationId": "<string>",
      "originalFileName": "<string>"
    }
  ],
  "meta": {
    "page": 1,
    "limit": 20,
    "total": 150,
    "totalPages": 8,
    "hasNextPage": true,
    "hasPreviousPage": false
  }
}

Query Parameters

page
number
default:1

Page number (1-based)

Required range: x >= 1
Example:

1

limit
number
default:20

Number of items per page

Required range: 1 <= x <= 100
Example:

20

Search term to filter results

Maximum string length: 100
Example:

"john"

sortBy
string

Field to sort by

Example:

"createdAt"

sortOrder
enum<string>
default:desc

Sort order

Available options:
asc,
desc
Example:

"desc"

organizationId
string

Filter by organization ID

Example:

"550e8400-e29b-41d4-a716-446655440000"

usageType
enum<string>

Filter by usage type

Available options:
welcome,
goodbye,
question,
prompt,
hold_music,
notification,
other
Example:

"welcome"

tags
string[]

Filter by tags (comma-separated or array)

Response

200 - application/json

Paginated list of audio files

data
object[]
required

Array of items

meta
object
required

Pagination metadata