v1

latestOpenAPI 3.0.0Proprietary2026-07-26316155742.7 KB

Orders

Get a single order

Get details on a single order.

get/projects/{project_id}/orders/{id}

Path parameters

project_idstring required

Project ID

idstring required

Query parameters

branchstring

specify the branch to use

Headers

X-PhraseApp-OTPstring

Two-Factor-Authentication token (optional)

Response

idstring

namestring

lspstring

amount_in_centsinteger

currencystring

messagestring

statestring

translation_typestring

progress_percentinteger

tag_namestring

Name of the tag whose keys are included in the order.

unverify_translations_upon_deliveryboolean

qualityboolean

priorityboolean

created_atstring date-time

updated_atstring date-time

Example response

{
  "id": "30AB4884",
  "lsp": "gengo",
  "amount_in_cents": 1152,
  "currency": "usd",
  "message": "Please make everything sound really nice :)",
  "state": "confirmed",
  "translation_type": "pro",
  "progress_percent": 50,
  "source_locale": {
    "id": "abcd1234cdef1234abcd1234cdef1234",
    "name": "en",
    "code": "en-GB"
  },
  "target_locales": [
    {
      "id": "abcd1234cdef1234abcd1234cdef1234",
      "name": "de",
      "code": "de-DE"
    },
    {
      "id": "abcd1234cdef1234abcd1234cdef1234",
      "name": "fr",
      "code": "fr-FR"
    }
  ],
  "tag_name": "latest-upload",
  "styleguide": {
    "id": "abcd1234cdef1234abcd1234cdef1234",
    "title": "My Styleguide"
  },
  "unverify_translations_upon_delivery": true,
  "quality": true,
  "priority": true,
  "created_at": "2015-01-28T09:52:53Z",
  "updated_at": "2015-01-28T09:52:53Z"
}