Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

Enter your token in the format token TOKEN

Headers

X-PhraseApp-OTP
string

Two-Factor-Authentication token (optional)

Path Parameters

project_id
string
required

Project ID

id
string
required

ID

Query Parameters

branch
string

specify the branch to use

Response

OK

id
string
filename
string
format
string
state
string

Processing state of the upload: initialized, processing, success, or error. error means processing failed — for example the file could not be parsed, or a provided file_format didn't match the file's actual content. Poll this field until it leaves initialized/processing to get the final outcome.

error_message
string | null

A user-facing message explaining why the upload failed, or null if the upload did not fail.

This message is intended for display only. Its wording may change at any time and it should not be parsed or relied upon programmatically.

tag
string

Unique tag of the upload

tags
string[]

List of tags that were assigned to the uploaded keys

url
string

The URL to the upload in Phrase Strings app.

user
user_preview · object
Example:
summary
object
created_at
string<date-time>
updated_at
string<date-time>