Get
/api/v1/custom-sounds.getOne
Returns one custom sound record for the workspace. You must pass the sound’s
_idas a query parameter.Authentication is required. The response includes the sound’s metadata (
name,extension,_updatedAt), not the binary file.
Changelog
| Version | Description |
|---|---|
| 8.3.0 | Added |
Header parameters
X-Auth-Token
stringRequired
The authToken of the authenticated user.
ExampleRScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f
X-User-Id
stringRequired
The userId of the authenticated user.
ExamplerbAXPnMktTFbNpwtJ
Query parameters
_id
stringRequired
ID of the custom sound
Example65462caea2f73c7460e18f83
Responses
200
OK
Request succeeded; returns the sound metadata.
{
"success": true,
"sound": {
"_id": "65462caea2f73c7460e18f83",
"name": "doremi",
"extension": "mp3",
"_updatedAt": "2023-11-04T11:36:14.171Z"
}
}object
success
boolean
sound
object
_id
string
name
string
extension
string
_updatedAt
string
400
Bad Request
Invalid or missing _id
{
"success": false,
"error": "[The required \"_id\" query param is missing.]",
"errorType": "The required \"_id\" query param is missing."
}object
success
boolean
error
string
errorType
string
401
Unauthorized
Unauthorized login attempt
{
"status": "error",
"message": "You must be logged in to do this."
}object
status
string
message
string
403
Forbidden
No permission
{
"success": false,
"error": "User does not have the permissions required for this action [error-unauthorized]"
}object
success
boolean
error
string