SIsimplelocalize
Translations

Get translations

Changed on

Get translations for a project

get/api/v2/translations

Request

Query parameters

keystring

Filter by translation key

namespacestring

Filter by namespace

languagestring

Filter by language key

textstring

Search by translation text (case-insensitive, uses 'contains'). Minimum length: 3 characters. Limits results to 10.

querystring

Search by translation text or translation key (case-insensitive, uses 'contains'). Minimum length: 3 characters. Limits results to 10.

textStatus'EMPTY' | 'NOT_EMPTY' | ''

Filter by translation text status

customerIdstring

Filter by customer id (Business plan only)

baseOnlyboolean

Use true to get translations without customer translations, default value is false (Business plan only)

reviewStatus'REVIEWED' | 'NOT_REVIEWED' | ''

Filter by review status

pageinteger

Page number

sizeinteger

Page size

sortBy'' | 'lastModifiedAt'

Sort by field

sortOrder'asc' | 'desc'

Sort order

version'REVIEWED'

Use REVIEWED to get last reviewed version of translations if exists, otherwise it returns empty text

Response

OK

msgstring
statusinteger

Example response

{
  "data": {
    "content": [
      {
        "key": "hello_world",
        "namespace": "common",
        "language": "en_EN",
        "customerId": "acme",
        "text": "Hello world",
        "reviewStatus": "NOT_REVIEWED",
        "review": {
          "by": "reviewer@example.com",
          "at": "2021-01-01T00:00:00.000Z"
        },
        "lastModifiedAt": "2021-01-01T00:00:00.000Z"
      }
    ]
  }
}

Changes

  • 67a25a25863aRevision changes
    • warning

      added the new NOT_REVIEWED enum value to the /////// response property for the response status

    • warning

      added the new NOT_REVIEWED enum value to the /////// response property for the response status

    • warning

      added the new REVIEWED enum value to the /////// response property for the response status

    • warning

      added the new REVIEWED enum value to the /////// response property for the response status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

  • 0329534cd557Revision changes
    • breaking

      for the query request parameter reviewStatus, default value was added

    • breaking

      for the query request parameter textStatus, default value was added

    • breaking

      the response's body type changed from object to no type for status

    • breaking

      added to the response property oneOf list for the response status

    • breaking

      the response's property type changed from array to no type for status

    • warning

      deleted the header request parameter X-SimpleLocalize-Token

    • warning

      removed the optional property from the response with the status

    • info

      api operation id getTranslationsV2 removed and replaced with getTranslations

    • info

      the endpoint scheme security Project API Key was added to the API

    • info

      the endpoint scheme security apiKey was removed from the API

    • info

      added the new optional query request parameter query

    • info

      added the new optional query request parameter sortBy

    • info

      added the new optional query request parameter sortOrder

    • info

      added the new optional query request parameter version

    • info

      for the query request parameter text, the maxLength was increased from 100 to 2147483647

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      the response's property default value OK was added for the status

    • info

      the response's property default value 200 was added for the status