Get phrases

get

https://api.localizejs.com/v2.0/projects/{projectKey}/phrases

Get a collection of phrases and their translations

Recipes

Get a List of Phrases Filtered by Labels

Open Recipe

Get a List of Phrases Filtered by SEO Labels

Open Recipe

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

You can create and view your API Private Key here.

Try it

To test this endpoint using the Try It feature:

Copy your Localize API Key into the Header field in the AUTHENTICATION section on the right.
Fill in all required fields below, and any optional fields as needed.
Click the Try it button.
View the results and any error returns on the right side of the screen.

Feel free to copy the sample code provided on the right side of the screen into your source code project to get a start on using this endpoint.

Note that using the Try It feature will affect the data in your Localize dashboard!

You can find the language codes here in your dashboard.

Path Params

projectKey

string

required

Defaults to YOUR_PROJECT_KEY

The Project Key (this is NOT the Project ID)

Query Params

limit

int32

Defaults to 1000

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

skip

int32

Defaults to 0

Skip a certain number of phrases (optional).

state

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.

type

string

enum

required

Defaults to phrase

Type can be phrase or glossary, defaults to phrase.

Allowed:

languageCode

string

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

ids

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.

phraseKeys

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.

labels

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.

context

string

Optional filter for phrase context

phraseHistory

boolean

Defaults to false

Set to true to return the phrase history.

translationState

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.

string

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

exactMatch

boolean

Defaults to false

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

Response

Try it

200200