Skip to main content
POST
Get saved vocabulary, translation instructions, voice and language presets, favorite templates, and personal interface preferences.

Authentication and permissions

string
required
Send a VoiceCheap API key in this header. Authorization: Bearer with the same API key is also supported. OAuth access tokens are accepted only by MCP, not by this REST endpoint.
Required permissions: settings:read. An active paid subscription is required. Permissions do not change team roles, resource ownership, media credits, or plan limits.

Parameters

Send an empty JSON object. This action has no input fields.
The JSON Schema below preserves the exact field names, nested types, defaults, bounds, and accepted values exposed by discovery. Additional cross-field rules are listed in the operation notes.

Request examples

Replace example resource identifiers and media keys with values returned for your account. Keep the request identifier stable when retrying the same mutation.

Response

A successful first execution returns HTTP 200 with the operation result under data. A replay may return saved request state instead. The example shows one supported response, not every optional field. Returns the caller’s personal preferences and the active workspace owner’s shared vocabulary and translation instructions.

Result fields

Operation notes

  • When the account is a team member, shared settings come from the team owner while interface preferences remain personal.

Usage

Each successful invocation consumes one monthly API/MCP call. Media credits and the operation’s own generation allowances also apply.

Errors