KNknak
TranslationRequests

List all translation requests

Retrieve all translation requests that the API user has access to based on their brand scopes.

NOTE: Only translation requests created from custom translation integrations will be visible. Steps to set up a custom translation integration can be found here.

get/translation-requests

Request

Query parameters

pageinteger

Page number

per_pageinteger

Number of items per page

filter[status]string
Example:requested

Filter by status. Exact match filter.

filter[asset_id]string
Example:609ca344d1b1b

Filter by asset ID. Exact match filter. (Corresponds to base_asset_id in response)

filter[created_at_before]string
Example:2023-04-01T00:00:00Z

Filter translation requests created before a specific date, formatted in ISO 8601 format. Can be used in conjunction with created_at_after filter

filter[created_at_after]string
Example:2023-04-03T00:00:00Z

Filter translation requests created after a specific date, formatted in ISO 8601 format. Can be used in conjunction with created_at_before filter

sortstring
Example:created_at

Sort by field (created_at, updated_at), use '-' to reverse order of sort (e.g. -created_at).

Response

OK

Example response

{
  "data": [
    {
      "type": "translation-request",
      "id": "609d7ce223411",
      "attributes": {
        "id": "609d7ce223411",
        "language_code": "zh-CN",
        "source_language_code": "en-US",
        "status": "processing",
        "base_asset_id": "609ca344d1b1b",
        "asset_version_id": "67d19607cbb1d4.78284760",
        "integration_id": "609ca344d1caa",
        "creator_id": "609ca344d1b1b",
        "notes": "Need a translation for this asset soon",
        "due_date": "2023-02-08",
        "created_at": "2023-02-08T17:07:12+00:00",
        "updated_at": "2023-02-08T17:07:12+00:00"
      }
    }
  ],
  "links": {
    "first": "https://enterprise.knak.io/api/published/v1/translation-requests?page=1",
    "last": "https://enterprise.knak.io/api/published/v1/translation-requests?page=3",
    "prev": "https://enterprise.knak.io/api/published/v1/translation-requests?page=1",
    "next": "https://enterprise.knak.io/api/published/v1/translation-requests?page=3"
  },
  "meta": {
    "current_page": 2,
    "from": 1,
    "last_page": 3,
    "links": [
      {
        "url": "https://enterprise.knak.io/api/published/v1/translation-requests?page=2",
        "label": "Next",
        "active": true
      }
    ],
    "path": "https://enterprise.knak.io/api/published/v1/translation-requests?page=2",
    "per_page": 10,
    "to": 3,
    "total": 3
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.