> ## Documentation Index > Fetch the complete documentation index at: https://developers.phrase.com/llms.txt > Use this file to discover all available pages before exploring further. # List locales > List all locales for the given project. ## OpenAPI ````yaml /openapi/phrase-strings.json get /projects/{project_id}/locales openapi: 3.0.3 info: title: Phrase Strings API Reference version: 2.0.0 description: >- Phrase Strings is a translation management platform for software projects. You can collaborate on language file translation with your team or order translations through our platform. The API allows you to import locale files, download locale files, tag keys or interact in other ways with the localization data stored in Phrase Strings for your account. contact: name: Phrase Support url: https://developers.phrase.com/api/ email: support@phrase.com x-logo: url: https://developers.phrase.com/images/phrase-logo.svg backgroundColor: '#03eab3' altText: Phrase Strings termsOfService: https://phrase.com/terms/ license: name: MIT url: https://choosealicense.com/licenses/mit/ servers: - url: https://api.phrase.com/v2 description: EU production server - url: https://api.us.app.phrase.com/v2 description: US production server security: - Token: [] - Basic: [] tags: - name: Accounts - name: Authorizations description: > The endpoints provided by the Authorizations API are **only accessible via Basic authentication with email and password**. When creating a new authorization, the new access token for this authorization will be returned in the immediate response but not later, due to security reasons. When accessing authorizations later, you will only see the last eight chars of the token in plain text (`token_last_eight`) and the SHA256 digest of the token for reference (`hashed_token`). For instructions on how authorization in general works, see our [Auth Guide](#overview--authentication). ### Scopes When creating or updating an OAuth authorization, you can define a list of scopes to limit the access that can be performed by that authorization. #### Available Scopes
Scope Description
read Read projects, locales, keys, translations, orders
write Write projects, locales, keys, translations but not orders
orders.create Create and confirm orders
team.manage Manage invitations and members
- name: Blacklisted Keys - name: Branches description: > ### Branch creation Branches will be created asynchronously. State of branch creation is returned as state. #### Available States
State Description
initialized Data received.
processing Branch is currently creating.
success Branch was created successfully
error Branch creation failed.
- name: Comments - name: Comment Reactions - name: Comment Replies - name: Custom Metadata - name: Distributions - name: Documents - name: Figma Attachments - name: Formats - name: Glossaries - name: Glossary Terms - name: Glossary Term Translations - name: ICU - name: Invitations description: > With the invitation endpoint you can [manage and invite users](https://support.phrase.com/hc/en-us/articles/5709742418716) to Phrase Strings via API. A user can have the role Manager, Developer or Translator each with its own access rights. Developers and translators need resources like projects and locales assigned in order to access them. - name: Job Annotations description: > The job annotations endpoints allow you to create, update and delete annotations for jobs and job locales. Annotations are used to add metadata to a job or job locale. - name: Job Comments - name: Job Locales - name: Job Template Locales - name: Job Templates - name: Jobs - name: Keys - name: Linked Keys - name: Locales - name: Locale Downloads - name: Members description: > With the members endpoints you can do basic [team and user management](https://support.phrase.com/hc/en-us/articles/5709742418716) via API. A user can have the role Manager, Developer or Translator each with its own access rights. Developers and translators need resources like projects and locales assigned in order to access them. - name: Notifications - name: Notification Groups - name: Orders description: > ### List of categories [TextMaster] When ordering translations from TextMaster, you need to specify a category ID along with your order. See this list for information on the category ID and their equivalent description.
Category ID Description
C001Agriculture
C002Aerospace
C003Animals/Pets/Plants
C004Arts/Culture/Literature
C005Automotive/Transportation
C006Computers/Technology/Software
C007Telecom
C008Real Estate/Construction/Building
C009Consumer Goods
C010Education
C011Entertainment
C012Ecology/Environment
C013Health/Biotechnology/Pharma
C014Internet
C015Policy/Government/Public
C016Publishing/Media/Communication
C017Religion
C018Food/Beverages
C019Retail
C020Fashion/Luxury/Textiles
C021Travel/Tourism
C022Natural Resources/Energy
C023Banking/Financial Services/Insurance
C024Legal Affairs/Tax/Law
C025Raw Materials/Industrial Goods
C026Lifestyle/Leisure/Hobbies
C027Sports
C028Home/Family/Friends/Children
C029Economy/Financial Markets
C030Science
C031Human Resources/Employment
C032Adult (Pornography, Violence, etc.)
- name: Organization Job Template Locales - name: Organization Job Templates - name: Projects - name: Quality - name: Releases - name: Release Triggers - name: Repo Syncs description: > The Repo Syncs API allows you to synchronize your Phrase projects with your code repositories. You can import translations from your repository to Phrase and export translations from Phrase to your repository. - name: Repo Sync Events - name: Reports - name: Search - name: Screenshot Markers - name: Screenshots - name: Spaces - name: Style guides - name: Tags - name: Teams - name: Translations - name: Uploads description: > ### Formats We support all common localization file formats. For a detailed overview, see our [Format Guide](https://support.phrase.com/hc/en-us/sections/6111343326364). ### Processing Uploads will be processed asynchronously and thus the data might not be imported yet although the upload is completed. Therefore we recommend to evaluate the returned state field for information on the import progress. #### Available States
State Description
initialized Data received.
waiting_for_preview Upload is waiting for preview to be finished.
waiting Upload is waiting for processing.
processing Upload is being processed, data is currently imported.
success Upload is complete and all data is imported.
error Upload or import process failed.
- name: Users - name: Variables - name: Versions / History - name: Webhooks - name: Webhook Deliveries paths: /projects/{project_id}/locales: get: tags: - Locales summary: List locales description: List all locales for the given project. operationId: locales/list parameters: - $ref: '#/components/parameters/X-PhraseApp-OTP' - $ref: '#/components/parameters/project_id' - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/per_page' - description: >- Sort locales. Valid options are "name_asc", "name_desc", "default_asc", "default_desc". example: null name: sort_by in: query schema: type: string - description: specify the branch to use example: my-feature-branch name: branch in: query schema: type: string - description: >- Specify a query to filter locales. Currently supports `name` argument, filtering only locales with names starting with the given string. example: name:en name: q in: query schema: type: string responses: '200': description: OK content: application/json: schema: type: array items: $ref: '#/components/schemas/locale' headers: X-Rate-Limit-Limit: $ref: '#/components/headers/X-Rate-Limit-Limit' X-Rate-Limit-Remaining: $ref: '#/components/headers/X-Rate-Limit-Remaining' X-Rate-Limit-Reset: $ref: '#/components/headers/X-Rate-Limit-Reset' Link: $ref: '#/components/headers/Link' Pagination: $ref: '#/components/headers/Pagination' '400': $ref: '#/components/responses/400' '404': $ref: '#/components/responses/404' '429': $ref: '#/components/responses/429' x-code-samples: - lang: Curl source: >- curl "https://api.phrase.com/v2/projects/:project_id/locales?branch=my-feature-branch" \ -u USERNAME_OR_ACCESS_TOKEN - lang: CLI v2 source: |- phrase locales list \ --project_id \ --branch my-feature-branch \ --access_token components: parameters: X-PhraseApp-OTP: in: header name: X-PhraseApp-OTP description: Two-Factor-Authentication token (optional) required: false allowEmptyValue: false schema: type: string project_id: in: path name: project_id description: Project ID required: true schema: type: string page: in: query name: page description: Page number required: false allowEmptyValue: false schema: type: integer example: 1 per_page: in: query name: per_page description: >- Limit on the number of objects to be returned, between 1 and 100. 25 by default required: false allowEmptyValue: false schema: type: integer example: 25 schemas: locale: type: object title: locale properties: id: type: string name: type: string code: type: string default: type: boolean main: type: boolean rtl: type: boolean plural_forms: type: array items: type: string ordinal_plural_forms: type: array items: type: string source_locale: $ref: '#/components/schemas/locale_preview' fallback_locale: $ref: '#/components/schemas/locale_preview' created_at: type: string format: date-time updated_at: type: string format: date-time example: id: abcd1234cdef1234abcd1234cdef1234 name: de code: de-DE default: true main: false rtl: false plural_forms: - zero - one - other ordinal_plural_forms: - zero - other source_locale: id: abcd1234cdef1234abcd1234cdef1234 name: en code: en-GB fallback_locale: id: abcd1234cdef1234abcd1234cdef1234 name: en code: en-GB created_at: '2015-01-28T09:52:53Z' updated_at: '2015-01-28T09:52:53Z' locale_preview: type: object title: locale_preview properties: id: type: string name: type: string code: type: string example: id: abcd1234cdef1234abcd1234cdef1234 name: English code: en-GB headers: X-Rate-Limit-Limit: description: The number of allowed requests in the current period schema: type: integer X-Rate-Limit-Remaining: description: The number of remaining requests in the current period schema: type: integer X-Rate-Limit-Reset: description: >- Timestamp of end of current time period as UNIX timestamp, see [Rate Limiting](/en/api/strings/pagination#rate-limiting) schema: type: integer Link: description: |- Links to related resources, in the format defined by [RFC 5988](https://tools.ietf.org/html/rfc5988#section-5). This will include a link with relation type `next` to the next page, if there is a next page. schema: type: string Pagination: description: >- Pagination details for navigating through a collection of resources, provided in JSON format. schema: type: object properties: total_count: description: Total count of items in the collection. type: integer example: 10 total_pages_count: description: Total number of pages available for the collection. type: integer example: 2 current_page: description: The current page number. type: integer example: 1 current_per_page: description: Number of items currently displayed per page. type: integer example: 5 previous_page: description: Page number of the previous page, if available. type: integer next_page: description: Page number of the next page, if available. type: integer example: 2 responses: '400': description: Bad request headers: X-Rate-Limit-Limit: $ref: '#/components/headers/X-Rate-Limit-Limit' X-Rate-Limit-Remaining: $ref: '#/components/headers/X-Rate-Limit-Remaining' X-Rate-Limit-Reset: $ref: '#/components/headers/X-Rate-Limit-Reset' '404': description: Not Found headers: X-Rate-Limit-Limit: $ref: '#/components/headers/X-Rate-Limit-Limit' X-Rate-Limit-Remaining: $ref: '#/components/headers/X-Rate-Limit-Remaining' X-Rate-Limit-Reset: $ref: '#/components/headers/X-Rate-Limit-Reset' '429': description: Rate Limiting headers: X-Rate-Limit-Limit: $ref: '#/components/headers/X-Rate-Limit-Limit' X-Rate-Limit-Remaining: $ref: '#/components/headers/X-Rate-Limit-Remaining' X-Rate-Limit-Reset: $ref: '#/components/headers/X-Rate-Limit-Reset' securitySchemes: Token: type: apiKey in: header name: Authorization description: Enter your token in the format `token TOKEN` Basic: type: http scheme: basic ````