This API is based on {json:api}.

{json:api} is a specification that follows shared conventions and standards. This specification enables API discoverability and partial self-descriptiveness through conventions. The Json Api specification exposes resources and their relationships representations with unique uris and all CRUD operations are performed on those endpoints. With it's simplified approach it assists the API uniformity.

Read more: https://jsonapi.org/

Additionally, this API is defined using OpenAPI (ex Swagger). This means that you can easily:

• Generate clients in your preferred: https://swagger.io/tools/swagger-codegen/
• Download the specification file (see above) and use it in clients like Postman etc

All list endpoints include pagination to guarantee performant responses. Those endpoints will return next and previous links in the response payload (links section). The client does not have to construct any pagination specific URLs or headers, just follow those links.

Page size is fixed to 150 items per page.

The basic media type for the API is application/vnd.api+json. If you want to execute a request that includes data (POST, PATCH, DELETE) you should include this media type in the Content-Type header. The only case where a different Content-Type header will be accepted is for endpoints that can accept file like objects where the media type used should be multipart/form-data.

The base media type this API responds is application/vnd.api+json. To retrieve the data in this media type you should include it in the Accept header. The only case where the server will return another media type is for endpoint that return file like objects. In this case the media type used should be */* and the server will prioritize the negotiation to the media type dictated from the file. Note that application/vnd.api+json will be also available for accept header in these cases and will return a JSON serialized representation of the file.

Read more here: https://jsonapi.org/format/#content-negotiation

There are three different methods for uploading file content to Transifex:

• Using Content-Type application/vnd.api+json the content must be JSON serializable.
  • For content that is directly JSON serializable you can dump the content of the file directly and set the content_encoding attribute to text.
  • For any content, even if it's not JSON serializable (eg .xlsx, .idml or .docx file extensions), you can encode the file using the base64 encoding and set the content_encoding attribute to base64.
• Using Content-Type multipart/form-data the content can be any raw file, and can be send without further processing.

Asynchronous operations are triggered via a POST request. The response status in such cases is 202 Accepted, with a link in the Content-Location header. To check the status of the operation, a client can send a request to the location given earlier. An optional callback_url can be provided when the asynchronous operation is triggered. If such url is provided, upon completion a HTTP POST request is executed containing all information required to identify the specific operation:

Example request:

POST callback_url HTTP/1.1
Content-Type: application/json

{
  "data": {
    "type": resource_strings_async_downloads",
    "id": "xxxxxxxxx",
    "attributes": {
      "location": "https://rest.api.transifex.com/resource_strings_async_downloads/xxxxxxxxx",
      "status": "succeeded"
    }
  }
}

The following Plan based restrictions apply:

• Activity Reports are available to Premium and up
• XLIFF export is available to Premium and up.
• Screenshots are available to Premium and up

To maintain optimal performance and availability of the API, we limit the request rate to 500 requests/min or 30,000 requests / 5 minutes / IP. Polling endpoints like resource_translations_async_downloads/{resource_translations_async_download_id} and resource_strings_async_downloads/{resource_strings_async_download_id} have a rate limit of 1,200 requests/min. Once past the respective limit, requests will be throttled and you will get a 429 Throttled response.

Example response:

{
  "errors": [
    {
      "code": "Throttled",
      "detail": "Request was throttled. Expected available in 60 seconds.",
      "status": "429",
      "title": "Throttled"
    }
  ]
}

Represents Transifex's users.

Represents Transifex's organizations. Every user can be a member of one or multiple organizations. Only the organizations the authenticated user belongs to will appear here.

Languages objects represent each available language in Transifex.

Represents projects, as used within Transifex. Each project belongs to an organization.

Project Webhooks lets you specify actions which will trigger some notification event. When that event occurs, Transfex application will make a HTTP request to the URL configured for the webhook (callback_url). The request is done as a HTTP POST request. For example a callback url will be triggered whenever a target language of a resource has fully been translated, enabling the client to implement a custom workflow to pull translations as soon as they are ready, without having to constantly check Transifex for updates.