Would you like a demo of Localize? Schedule a Demo or Contact Sales

We're hiring— 100% remote

Help Center >CLI >Frontend API >
REST API
Try it FreeLearn MoreYour AccountSupport
Start typing to search…

Export content

get https://api.localizejs.com/v2.0/projects//resources

Export phrase data from a specific project to a file.

Log in to see full request history
timestatususer agent
Retrieving recent requests…
LoadingLoading…

You can create and view your API Private Key here.

Try it

To test this endpoint using the Try It feature:

  1. Copy your Localize API Key into 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.
  4. 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.

📘

Large Downloads

For large downloads, we suggest that you set the deferred parameter to true and download the exported file using the Download completed export endpoint.

📘

Small Downloads

If using Try It with the deferred parameter set to false and your export is successful, you will see the results in the Response panel.

Path Params
string
required
Defaults to YOUR_PROJECT_KEY

The Project Key (this is NOT the Project ID)

Query Params
string
required

The language code of the content you are exporting.

string
required

The format of the resource. Pick one from the list. Note that some formats are for Mobile projects only.

string
Defaults to phrase

What type of content.

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
Defaults to has-active-translations

Optional filters for content. Explanations of the possible values:

  • 'has-active-translations' (= Published translations)
  • 'machine-translations' (=Machine translations)
  • 'human-translations' (= Human translations)
  • 'no-translations' (= No translations)
  • 'no-human-translations' (= Needs human translations)
  • 'needs-review' (= Translation QA: needs review)
  • 'needs-translations' (= Translation QA: needs translations)
  • 'translations-rejected' (= Translation QA: rejected translations)

string

The context field for the phrases. This must exactly match the context in the phrase.

boolean
Defaults to false

When this option is set to true the return value will change. Instead of returning the file contents, it returns an export ID. This export ID will be used to download the exported file using the "Download completed export" endpoint.

Responses

Updated over 1 year ago

Did this page help you?
Language
Credentials
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated over 1 year ago

Did this page help you?