Phrases

List phrases

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.

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)

Query parameters

projectstring

Project name

keystring

Phrase key (URL-encoded)

languagestring
Example:fr
fieldsstring

Comma-separated projection of fields to return

pagination'cursor'

Set to cursor for a stable page envelope

cursorstring

Opaque nextCursor from the preceding cursor page

limitinteger

Optional bounded page size (maximum 2001; defaults to 100 in cursor mode)

skipinteger

Optional page offset (maximum 10000)

sortField'_id' | 'key' | 'language'
sortDirection'ASC' | 'DESC'

Response

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

OR

Example response

[
  {
    "key": "welcome_message",
    "value": "Welcome",
    "language": "en"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.