Get phrases

Get a collection of phrases and their translations

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

You can find the language codes here in your dashboard.

You can create and view your private API Key here.

Try it

⚠️ This uses your production account

The Try It feature sends real API requests directly to your production Localize account. There is no sandbox, demo, or test environment. Requests are authenticated using your Localize API Key and operate directly on your production data.

To use the Try It feature:

  1. Enter your production Localize API Key in the Header field in the AUTHENTICATION section on the right.
  2. Fill in all required fields below, and any optional fields as needed.
  3. Click the Try it button to send the request.
  4. View the API response and any errors on the right side of the screen.

🚨 Changes are applied to production

Any changes made by the API request will affect your production Localize account. Use this feature with the same care as you would when making the request from your own application.

You can also copy the sample code provided on the right side of the screen and use it as a starting point for making requests from your own application.

Path Params
string
required
Defaults to YOUR_PROJECT_KEY

The Project Key (this is NOT the Project ID)

Query Params
int32
Defaults to 1000

The number of phrases to return (optional). The max is 5000. Default is 1000.

int32
Defaults to 0

Skip a certain number of phrases (optional).

string
Defaults to active

An optional array of phrase states (or a single state). Possible values are active, pending, spam, outdated, blocked, and inactive. Defaults to active if not specified.
- Corresponding bins for the various phrase states:

  • active = Published and all In-Progress bins
  • pending = Needs Approval
  • spam = Spam
  • outdated = Deprecated
  • blocked = Blocked
  • inactive = Trash
- When using the Try It feature, separate states with a comma with NO space in between.

string
enum
required
Defaults to phrase

Type can be phrase or glossary, defaults to phrase.

Allowed:
string

The language code of the desired translations. If empty, translations for all languages will be returned.

string

An optional array of phrase IDs (or a single ID) - only phrases with these IDs will be returned.
- Can be used in combination with phraseKeys
- When using the Try It feature, separate IDs with a comma with NO space in between.

string

An optional array of phraseKeys (or a single key) - only phrases with these keys will be returned.
- Can be used in combination with IDs
- When using the Try It feature, separate phraseKeys with a comma with NO space in between.

string

An optional array of labels (or a single label) which are OR'd together.
- When using the Try It feature, separate labels with a comma with NO space in between.

string

Optional filter for phrase context

boolean
Defaults to false

Set to true to return the phrase history.

string
Defaults to active

An optional array of translation states (or a single state). Possible values are active, inactive, review, and rejected. Defaults to active if not specified.
- When using the Try It feature, separate states with a comma with NO space in between.

An HTML-encoded string with the content you are searching for. You can use this in conjunction with the exactMatch parameter.

boolean
Defaults to false

Set to true if you want to exactly match the search term you are searching for.

Response

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json