Skip to main content
POST
List accessible projects with pagination, name search and language/status filters. A team guest only sees API projects they created.

​
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: projects:read. An active paid subscription is required. Permissions do not change team roles, resource ownership, media credits, or plan limits.

​
Parameters

​
string
Text value.Minimum length: 1. Maximum length: 200.
​
integer
Integer value.Minimum: 0. Maximum: 100000. Default: 0.
​
integer
Integer value.Minimum: 1. Maximum: 50. Default: 20.
​
string
Text value.Allowed values: “afrikaans”, “albanian”, “amharic”, “arabic”, “armenian”, “assamese”, “azerbaijani”, “basque”, “belarusian”, “bengali”, “bosnian”, “bulgarian”, “catalan”, “croatian”, “czech”, “danish”, “dutch”, “english”, “british english”, “estonian”, “finnish”, “french”, “french canadian”, “galician”, “german”, “greek”, “gujarati”, “hebrew”, “hindi”, “hungarian”, “icelandic”, “indonesian”, “irish”, “italian”, “japanese”, “kannada”, “kazakh”, “khmer”, “korean”, “lao”, “latvian”, “lithuanian”, “macedonian”, “malay”, “malayalam”, “mandarin”, “marathi”, “mongolian”, “nepali”, “norwegian”, “persian”, “polish”, “portuguese”, “brazilian portuguese”, “pt_brazil”, “punjabi”, “romanian”, “russian”, “serbian”, “slovak”, “slovenian”, “spanish”, “swahili”, “swedish”, “tagalog”, “tamil”, “telugu”, “thai”, “turkish”, “ukrainian”, “urdu”, “vietnamese”, “welsh”, “yoruba”, “zulu”.
​
string
Text value.Allowed values: “af”, “sq”, “am”, “ar”, “hy”, “as”, “ast”, “az”, “ba”, “eu”, “be”, “bn”, “bs”, “br”, “bg”, “my”, “ca”, “ceb”, “zh”, “hr”, “cs”, “da”, “nl”, “en”, “eo”, “at”, “et”, “fil”, “fo”, “fi”, “fr”, “fr-CA”, “fy”, “ff”, “gd”, “gl”, “lg”, “ka”, “de”, “el”, “gu”, “ht”, “ha”, “haw”, “he”, “hi”, “hu”, “is”, “ig”, “ilo”, “id”, “ia”, “ga”, “it”, “ja”, “jv”, “kea”, “kn”, “kk”, “km”, “kur”, “kir”, “ko”, “lo”, “la”, “luo”, “lv”, “lb”, “ln”, “lt”, “mk”, “mg”, “ms”, “ml”, “mt”, “mi”, “mr”, “mo”, “mn”, “ne”, “no”, “nn”, “nso”, “nya”, “oc”, “or”, “pa”, “ps”, “fa”, “pl”, “pt”, “ro”, “ru”, “sa”, “sr”, “sn”, “sd”, “si”, “sk”, “sl”, “so”, “es”, “su”, “sw”, “ss”, “sv”, “tl”, “tg”, “ta”, “tt”, “te”, “th”, “bo”, “tn”, “tr”, “tk”, “ug”, “uk”, “umb”, “ur”, “uz”, “vi”, “cy”, “wo”, “xh”, “yi”, “yo”, “zu”, “cmn”, “yue”, “en-GB”, “en-US”, “en-AU”, “auto-detect”.
​
string
Text value.Allowed values: “awaitingProofreading”, “translated”, “failed”.
​
string
Text value.Allowed values: “newestFirst”, “oldestFirst”. Default: “newestFirst”.
​
string
Text value.Minimum length: 1. Maximum length: 200. Pattern: ^[^/\\]+$.
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 a page of accessible project summaries and offset pagination metadata.

​
Result fields

​
Operation notes

  • offset defaults to 0, limit to 20 (maximum 50), and sort to newestFirst. query searches by project name; folderId, source language, target language, and status filter the list.
  • The returned project fields are projectId, projectName, originalLanguage, targetLanguages, duration, createdAt, progressStep, and folderId. Optional unstored fields may be omitted; targetLanguages defaults to [], duration to 0, and folderId to null.
  • nextOffset is set when the underlying fetched page contains limit items; it is not a total count or proof that another accessible result exists.
  • Team guests see only projects created through the API by that same member in the same team. Filtering can produce a shorter projects array even when nextOffset is present.
  • originalLanguage uses source-language codes such as fr or en (or auto-detect where accepted); targetLanguage uses supported target-language names such as english.

​
Usage

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

​
Errors