github.com/phrase/openapi@v0.0.0-20240514140800-49e8a106740e/paths/translations/index.yaml (about) 1 --- 2 summary: List all translations 3 description: List translations for the given project. If you want to download all translations for one locale we recommend to use the <code>locales#download</code> endpoint. 4 operationId: translations/list 5 tags: 6 - Translations 7 parameters: 8 - "$ref": "../../parameters.yaml#/X-PhraseApp-OTP" 9 - "$ref": "../../parameters.yaml#/If-Modified-Since" 10 - "$ref": "../../parameters.yaml#/If-None-Match" 11 - "$ref": "../../parameters.yaml#/project_id" 12 - "$ref": "../../parameters.yaml#/page" 13 - "$ref": "../../parameters.yaml#/per_page" 14 - description: specify the branch to use 15 example: my-feature-branch 16 name: branch 17 in: query 18 schema: 19 type: string 20 - description: 'Sort criteria. Can be one of: key_name, created_at, updated_at.' 21 example: updated_at 22 name: sort 23 in: query 24 schema: 25 type: string 26 - description: 'Order direction. Can be one of: asc, desc.' 27 example: desc 28 name: order 29 in: query 30 schema: 31 type: string 32 - description: | 33 Specify a query to find translations by content (including wildcards).<br><br> 34 <i>Note: Search is limited to 10000 results and may not include recently updated data (depending on the project size).</i><br> 35 The following qualifiers are supported in the query:<br> 36 <ul> 37 <li><code>id:translation_id,...</code> for queries on a comma-separated list of ids</li> 38 <li><code>tags:XYZ</code> for tags on the translation</li> 39 <li><code>unverified:{true|false}</code> for verification status</li> 40 <li><code>excluded:{true|false}</code> for exclusion status</li> 41 <li><code>updated_at:{>=|<=}2013-02-21T00:00:00Z</code> for date range queries</li> 42 <li><code>reviewed_after:2013-02-21T00:00:00Z</code> for fetching translations that were reviewed after the given timestamp</li> 43 </ul> 44 Find more examples <a href="#overview--usage-examples">here</a>. 45 example: PhraseApp*%20unverified:true%20excluded:true%20tags:feature,center 46 name: q 47 in: query 48 schema: 49 type: string 50 responses: 51 '200': 52 description: OK 53 content: 54 application/json: 55 schema: 56 type: array 57 items: 58 "$ref": "../../schemas/translation.yaml#/translation" 59 headers: 60 X-Rate-Limit-Limit: 61 "$ref": "../../headers.yaml#/X-Rate-Limit-Limit" 62 X-Rate-Limit-Remaining: 63 "$ref": "../../headers.yaml#/X-Rate-Limit-Remaining" 64 X-Rate-Limit-Reset: 65 "$ref": "../../headers.yaml#/X-Rate-Limit-Reset" 66 Link: 67 "$ref": "../../headers.yaml#/Link" 68 Pagination: 69 "$ref": "../../headers.yaml#/Pagination" 70 '400': 71 "$ref": "../../responses.yaml#/400" 72 '404': 73 "$ref": "../../responses.yaml#/404" 74 '429': 75 "$ref": "../../responses.yaml#/429" 76 x-code-samples: 77 - lang: Curl 78 source: |- 79 curl "https://api.phrase.com/v2/projects/:project_id/translations?branch=my-feature-branch&sort=updated_at&order=desc&q=PhraseApp*%2520unverified:true%2520excluded:true%2520tags:feature,center" \ 80 -u USERNAME_OR_ACCESS_TOKEN 81 - lang: CLI v2 82 source: |- 83 phrase translations list \ 84 --project_id <project_id> \ 85 --branch my-feature-branch \ 86 --sort updated_at \ 87 --order desc \ 88 --query 'PhraseApp*%20unverified:true%20excluded:true%20tags:feature,center' \ 89 --access_token <token> 90 x-cli-version: '2.6.4'