AudioFiles
Search AudioFiles
Search and list AudioFile records with filtering, sorting, and pagination.
GET
Search AudioFiles
Represents a valid audio file stored in the Nexudus account. These can be used in document templates, newsletters or custom pages in the Members Portal and app.
Authentication
This endpoint requires OAuth2 authentication. Include a valid bearer token in the
Authorization header.
The authenticated user must be a full unrestricted administrator or have the AudioFile-List role.Query Parameters
Pagination & Sorting
The page number to retrieve.
The number of records per page.
The property name to sort results by (e.g.
Name, CreatedOn).Sort direction.
0 for ascending, 1 for descending.Filters
Filter by iD of the business linked to this record.
Filter by name of the audio file.
Filter by description of the audio file.
Filter by current file name of the audio (read-only; upload via the corresponding URL field).
Filter by uRL of a new file to upload as the audio.
Filter by set to true to remove the current audio file.
Filter by file size in bytes.
Range Filters
Filter by file size in bytes greater than or equal to this value.
Filter by file size in bytes less than or equal to this value.
Filter records created on or after this date. Format:
YYYY-MM-DDTHH:mm.Filter records created on or before this date. Format:
YYYY-MM-DDTHH:mm.Filter records updated on or after this date. Format:
YYYY-MM-DDTHH:mm.Filter records updated on or before this date. Format:
YYYY-MM-DDTHH:mm.Code Examples
Simple listing
Filtering by Name
Range filters
Response
200
The list of AudioFile records matching the query. See the Get one AudioFile endpoint for the full list of properties returned for each record.
Current page number.
Number of records per page.
The field used for sorting.
The sort direction (
0 = ascending, 1 = descending).Index of the first item on the current page.
Index of the last item on the current page.
Total number of matching records across all pages.
Total number of pages.
Whether there is a next page of results.
Whether there is a previous page of results.
Example Response
Search AudioFiles