Skip to navigation
HeyReach APIVoice

GetVoices

View as Markdown

Get the workspace’s voice library: every active predefined voice plus the workspace’s own cloned voices, each with the LinkedIn accounts it is assigned to. An ElevenLabs voice is listed here only while a sender uses it; the whole imported ElevenLabs library is GetElevenLabsVoices.

Errors

  • 403 NO_ACTIVE_SUBSCRIPTION or VOICE_NOTES_NOT_ENABLED.

Headers

X-API-KEYstringOptional

API key header using this scheme. Example: “X-API-KEY: {API_KEY}”

Query parameters

genderenumOptional
Optional gender filter.
Allowed values:

Response

OK
idinteger
kindenum
Allowed values:
namestring
genderenum
Allowed values:
statusenum
Predefined voices are always READY.
Allowed values:
hasPreviewAudioboolean
assignedAccountIdslist of integers
providerenum
Allowed values:
genderKnownboolean

False when ElevenLabs had no gender label for the voice; gender is then a placeholder.

accentstring or nullOptional
languagestring or nullOptional

ISO 639-1 language of the voice. Set only for predefined voices; null for custom voices.

descriptionstring or nullOptional
sourceenum or nullOptional

Set only for custom voices; null for predefined voices.

Allowed values:
sampleDurationMsinteger or nullOptional
cloneFailureReasonstring or nullOptional
Why a FAILED custom voice failed. Null for every other status and for predefined voices.
createdByUserIdinteger or nullOptional
Who cloned the voice. Null for predefined voices and for voices cloned through the API.
createdByFirstNamestring or nullOptional
createdByLastNamestring or nullOptional
providerVoiceIdstring or nullOptional

The ElevenLabs voice id; null for built-in voices.

providerVoiceLabelstring or nullOptional

ElevenLabs voices only: language · accent · category from the last library sync. Null for built-in voices.

unavailableReasonenum or nullOptional

Why an ElevenLabs voice cannot be used right now; null while the voice is usable.

availableUntildatetime or nullOptional

UTC. Set only for an ElevenLabs Voice Library voice whose owner removed it from the ElevenLabs Voice Library: the date ElevenLabs stops serving it. The voice keeps working until then. Null for every other voice. As of the last library sync: about once a day automatically while a sender in the workspace uses an ElevenLabs voice, or at once with RefreshElevenLabsLibrary. When unavailableReason is also set, the voice is already unusable and unavailableReason applies.

Errors

403
Get Voices Voice Request Forbidden Error