Reference

Guide

/api/translations

List all translations

GET: /api/translations

Query parameters

Parameter Example Description
limit ?limit=5 Limits the number of returned translations.
offset ?offset=10 Sets a manual offset. Use the page option together with limit for easier pagination.
page ?page=2 Starts the collection at the given page. Only works when the limit is set.
pretty ?pretty=true Pretty prints the result. Only useful for debugging.
select ?select=id,title Defines the fields that will be returned for each translation.

Translation fields

The following fields are available in the translation model and can be fetched with the select parameter:

  • author
  • data
  • direction
  • id
  • name

Example response

GET: /api/translations
{
    "code": 200,
    "data": [
        {
            "direction": "ltr",
            "id": "de",
            "name": "Deutsch"
        },
        {
            "direction": "ltr",
            "id": "en",
            "name": "English"
        }
    ],
    "pagination": {
        "page": 1,
        "total": 2,
        "offset": 0,
        "limit": 100
    },
    "status": "ok",
    "type": "collection"
}