---
title: "List phrases"
method: GET
path: "/api/v1/phrases"
tags: ["Phrases"]
---

# List phrases

`GET /api/v1/phrases`

## Request

- Base URL: `https://api.multilocale.com`
- URL: `https://api.multilocale.com/api/v1/phrases`
- Auth: one of:
  - HTTP basic
  - API key in header `Authorization`
  - OAuth 2 (authorization code, authorization URL `https://app.multilocale.com/oauth/authorize`, token URL `https://api.authrice.com/api/oauth/token`, scopes: `phrases:read`)

Lists the phrases of your organization. A phrase is one `{key, value, language}` triple belonging to one or more projects. Filter with `project`, `key` and `language`. Requires the `phrases:read` scope. A key scoped to a project only ever sees that project's phrases. For stable traversal, set `pagination=cursor`; the response becomes `{items, nextCursor}` and is ordered by `_id`. Pass `nextCursor` back as `cursor` until it is null. Existing array responses and offset pagination remain available when cursor pagination is not requested.

## Query parameters

- `project` string
- `key` string
- `language` string
- `fields` string
- `pagination` 'cursor'
- `cursor` string
- `limit` integer
- `skip` integer
- `sortField` '_id' | 'key' | 'language'
- `sortDirection` 'ASC' | 'DESC'

## Response `200`

Array of phrases, or `{items, nextCursor}` in cursor mode

- union
  - Phrase[]
    - `key` string
    - `value` string
    - `language` string
    - `projects` string[]: Project names this phrase belongs to
  - PhrasePage
    - `items` Phrase[], required
      - `key` string
      - `value` string
      - `language` string
      - `projects` string[]: Project names this phrase belongs to
    - `nextCursor` string, nullable, required: Opaque cursor for the next page, or null after the final page

## Other responses

- `401`: Missing or invalid credentials
- `403`: API key is missing the `phrases:read` scope
- `429`: API key rate limit exceeded

---

[API](https://skmtc.dev/multilocale/apis/multilocale-api.md) · [All operations](https://skmtc.dev/multilocale/apis/multilocale-api/llms.txt) · [OpenAPI document](https://skmtc.dev/multilocale/apis/multilocale-api/revisions/9701f774e6c9?raw)