Skip to main content

Gets the filtered audio clip list

POST /v1/audioclip/list

Summary​

Gets the filtered audio clip list.

Details​

Request body: JSON object.

Supports an optional alldevices=true query parameter.

Authentication​

No operation-level security requirement is documented here.

Parameters​

None documented here.

Request Body​

Required: Yes

application/json​

  • deviceID (integer (int64), optional)
  • startEpoch (integer (int64), optional)
  • endEpoch (integer (int64), optional)
  • count (integer (int64), optional)
  • order (string, optional)
  • audioClipTypeID (integer (int64), optional)
  • tagList (array<integer (int64)>, optional)
    • array of integer (int64)
      • integer (int64)

Example

{
  "deviceID": 201,
  "startEpoch": 1711800000,
  "endEpoch": 1711800000,
  "count": 25,
  "order": "Example value",
  "audioClipTypeID": 1,
  "tagList": [
    1
  ]
}

Responses​

200​

Success

application/json​

  • array of AudioClipWithNames
    • deviceName (string, optional)
    • tagList (array<Tag>, optional)
      • array of Tag
        • key (integer (int64), optional)
        • tagName (string, optional)
        • creationDate (string (date-time), optional)
    • key (integer (int64), optional)
    • deviceID (integer (int64), optional)
    • fileID (integer (int64), optional)
    • audioClipStatus (integer (int64), optional)
    • audioClipTypeID (integer (int64), optional)
    • audioClipParameters (string, optional)
    • localFilePath (string, optional)
    • fileSize (integer (int64), optional)
    • bitrate (integer (int64), optional)
    • startTime (integer (int64), optional)
    • startTimeMs (integer (int64), optional)
    • endTime (integer (int64), optional)
    • endTimeMs (integer (int64), optional)
    • clipLengthInSeconds (number (double), optional)
    • tagListID (integer (int64), optional)
    • creationDate (string (date-time), optional)

Example

[
  {
    "key": 1,
    "deviceID": 201,
    "fileID": 1,
    "audioClipStatus": 1,
    "audioClipTypeID": 1,
    "audioClipParameters": "Example value",
    "localFilePath": "Example value",
    "fileSize": 1,
    "bitrate": 1,
    "startTime": 1,
    "startTimeMs": 1,
    "endTime": 1,
    "endTimeMs": 1,
    "clipLengthInSeconds": 1,
    "tagListID": 1,
    "creationDate": "2026-03-30T12:00:00.0000000Z",
    "deviceName": "WearableDevice",
    "tagList": [
      {
        "key": null,
        "tagName": null,
        "creationDate": null
      }
    ]
  }
]