> ## Documentation Index > Fetch the complete documentation index at: https://api-docs.voicecheap.ai/docs/llms.txt > Use this file to discover all available pages before exploring further. # List or search projects > List accessible projects with pagination, name search and language/status filters. A team guest only sees API projects they created. List accessible projects with pagination, name search and language/status filters. A team guest only sees API projects they created. ```http theme={null} POST https://api.voicecheap.ai/v1/actions/projects_list ``` ## Authentication and permissions 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 Text value. Minimum length: 1. Maximum length: 200. Integer value. Minimum: 0. Maximum: 100000. Default: 0. Integer value. Minimum: 1. Maximum: 50. Default: 20. 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". 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". Text value. Allowed values: "awaitingProofreading", "translated", "failed". Text value. Allowed values: "newestFirst", "oldestFirst". Default: "newestFirst". 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. ```json theme={null} { "type": "object", "properties": { "query": { "type": "string", "minLength": 1, "maxLength": 200 }, "offset": { "default": 0, "type": "integer", "minimum": 0, "maximum": 100000 }, "limit": { "default": 20, "type": "integer", "minimum": 1, "maximum": 50 }, "targetLanguage": { "type": "string", "enum": [ "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" ] }, "originalLanguage": { "type": "string", "enum": [ "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" ] }, "status": { "type": "string", "enum": ["awaitingProofreading", "translated", "failed"] }, "sort": { "default": "newestFirst", "type": "string", "enum": ["newestFirst", "oldestFirst"] }, "folderId": { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[^/\\\\]+$" } }, "additionalProperties": false } ``` ## 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. ```bash cURL theme={null} curl --request POST 'https://api.voicecheap.ai/v1/actions/projects_list' \ --header "x-api-key: $VOICECHEAP_API_KEY" \ --header 'Content-Type: application/json' \ --data '{"query":"Product","limit":20,"offset":0,"originalLanguage":"fr","targetLanguage":"english","status":"translated","sort":"newestFirst"}' ``` ```javascript JavaScript theme={null} const input = { query: 'Product', limit: 20, offset: 0, originalLanguage: 'fr', targetLanguage: 'english', status: 'translated', sort: 'newestFirst', }; const response = await fetch('https://api.voicecheap.ai/v1/actions/projects_list', { method: 'POST', headers: { 'x-api-key': process.env.VOICECHEAP_API_KEY, 'Content-Type': 'application/json', }, body: JSON.stringify(input), }); const body = await response.json(); if (!response.ok) throw new Error(body.code + ': ' + body.message); console.log(body); ``` ```python Python theme={null} import os import requests response = requests.post( "https://api.voicecheap.ai/v1/actions/projects_list", headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]}, json={"query": "Product", "limit": 20, "offset": 0, "originalLanguage": "fr", "targetLanguage": "english", "status": "translated", "sort": "newestFirst"}, timeout=120, ) body = response.json() if not response.ok: raise RuntimeError(f"{body.get('code')}: {body.get('message')}") print(body) ``` ## 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. ```json HTTP 200 theme={null} { "data": { "projects": [ { "projectId": "project_launch_2026", "projectName": "Product launch", "originalLanguage": "fr", "targetLanguages": [ "english" ], "duration": 75, "createdAt": 1792152000000, "progressStep": "done", "folderId": null } ], "offset": 0, "limit": 20, "nextOffset": null } } ``` ## Result fields | Field | Description | | - | - | | `data.projects` | Page of public project summaries. | | `data.offset` | The requested starting offset. | | `data.limit` | The requested page size. | | `data.nextOffset` | offset + limit when the fetched page is full, otherwise null. | | `data.projects[].duration` | Stored duration in seconds. | | `data.projects[].createdAt` | Project creation time in Unix milliseconds. | | `data.projects[].folderId` | Folder identifier or null. | ## 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 | HTTP status | Code | Meaning or recovery | | - | - | - | | 400 | `CREDENTIAL_IN_QUERY` | Credentials were supplied in an access\_token or api\_key query parameter. Send credentials in headers. | | 400 | `VALIDATION_ERROR` | Correct the input using the schema. Invalid or inconsistent values are rejected before execution. | | 401 | `API_KEY_EXPIRED` | The API key has expired. | | 401 | `INVALID_API_KEY` | Provide a valid, unexpired API key. | | 401 | `INVALID_CREDENTIAL` | The Authorization header is malformed or conflicts with x-api-key. | | 401 | `MISSING_CREDENTIAL` | No usable header credential was supplied, or it exceeded 4096 characters. | | 401 | `USER_NOT_FOUND` | The credential's account no longer exists. | | 403 | `AMBIGUOUS_TEAM_API_KEY` | The credential's user belongs to more than one team, so the billing context is ambiguous. | | 403 | `INSUFFICIENT_SCOPE` | Grant every required permission or choose another credential. | | 403 | `INTEGRATION_PLAN_UNSUPPORTED` | The account's integration limits could not be verified. | | 403 | `SUBSCRIPTION_REQUIRED` | Use an active paid subscription. | | 403 | `TEAM_OWNER_NOT_FOUND` | The effective team owner account could not be found. | | 429 | `INTEGRATION_MONTHLY_LIMIT_REACHED` | Wait for the monthly reset or change plan. | | 429 | `INTEGRATION_RATE_LIMIT_REACHED` | Wait for Retry-After when present and use backoff. | | 500 | `INTERNAL_ERROR` | Check saved request state and resource history before deciding to retry a mutation. | | 503 | `SERVER_RESTARTING` | The server is restarting. Retry shortly and keep the same request identifier for a mutation. | ```json theme={null} { "code": "INSUFFICIENT_SCOPE", "message": "This credential does not permit the requested action.", "status": 403, "details": { "requiredScopes": ["projects:read"] } } ``` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.