Sign in

v1

latestOpenAPI 3.0.32026-07-13401683.8 KB
Spots

Returns the spots matching the query parameters.

get/api/v2/spots

Query parameters

pageStartinteger

The start page of the spot to return. The first item is indexed at 0.

pageSizeinteger

The number of items to return. Must be between 0 and 500, inclusive.

orderById'asc' | 'desc'

The sort order of the list of spots, based on spot ID. If unspecified, the spots are returned in random order. If using paging to iterate through the results, sort order should be specified.

Response

The spots matching the query parameters

idinteger

The unique ID of the spot. Generated at creation.

namestring

The unique name of the spot

notesstring

Miscellaneous notes about the spot

durationinteger

The length (duration) of the spot in seconds.

lastModifiedDatestring date-time

The date the spot was last modified/updated in ISO 8601 format. Automatically updated on any write operation.

createdDatestring date-time

The date the spot was created in ISO 8601 format. Generated at creation.

lastUploadedDatestring date-time

The date the spot audio file was uploaded in ISO 8601 format. Automatically updated on upload.

fileSizeinteger

The size of the audio content file in bytes. Generated at creation.

fileNamestring

The name of the audio content file. Generated at creation.

originalFileNamestring

The original name of the audio content file.