Skip to main content
GET
/
integration
/
orders
curl -X GET "https://api-integration.ollang.com/integration/orders?pageOptions[page]=1&pageOptions[take]=10&pageOptions[search]=sample&pageOptions[orderBy]=createdAt&pageOptions[orderDirection]=desc" \
  -H "X-Api-Key: <your-api-key>"

{
  "data": [
    {
      "id": "60b8d6f1e1b9b1d8c6c0d8e1",
      "name": "Sample Project - Episode 1",
      "sourceLanguage": "en",
      "targetLanguage": "fr",
      "status": "completed",
      "type": "cc",
      "createdAt": "2024-01-15T10:30:00Z",
      "clientId": "client_abc123",
      "projectId": "proj_xyz789"
    },
    {
      "id": "60b8d6f1e1b9b1d8c6c0d8e2",
      "name": "Corporate Training Video",
      "sourceLanguage": "en",
      "targetLanguage": "es",
      "status": "ongoing",
      "type": "aiDubbing",
      "createdAt": "2024-01-14T15:45:00Z",
      "clientId": "client_abc123",
      "projectId": "proj_xyz790"
    }
  ],
  "meta": {
    "page": 1,
    "take": 10,
    "itemCount": 2,
    "pageCount": 1,
    "hasNextPage": false,
    "hasPreviousPage": false
  }
}
Retrieve a list of your translation orders with optional pagination and filtering capabilities. This endpoint allows you to view and manage all your submitted orders. 
curl -X GET "https://api-integration.ollang.com/integration/orders?pageOptions[page]=1&pageOptions[take]=10&pageOptions[search]=sample&pageOptions[orderBy]=createdAt&pageOptions[orderDirection]=desc" \
  -H "X-Api-Key: <your-api-key>"

​
Authorizations

This endpoint requires API key authentication. Include your API key in the request header:
  • Header name: X-Api-Key
  • Header value: Your API key from the Ollang dashboard
  • Format: X-Api-Key: your-api-key-here
You can obtain your API key from your Ollang dashboard.

​
Query Parameters

​
Pagination Parameters

​
pageOptions[page]
number
default:"1"
The page number to retrieve. Must be 1 or greater.
​
pageOptions[take]
number
default:"10"
The number of items per page. Must be between 1 and 50.

​
Sorting Parameters

​
pageOptions[orderBy]
string
default:"id"
The field to sort the results by. Common values: id, createdAt, name, status.
​
pageOptions[orderDirection]
string
default:"desc"
The direction to sort the results. Options: asc, desc.

​
Search Parameters

​
pageOptions[search]
string
A search term to filter the results. Searches across order names and other relevant fields.

​
Filter Parameters

​
filter[type]
string
Filter by order type. Common values are the five creatable types — cc, subtitle, document, aiDubbing, and studioDubbing (see Order Types). Legacy or system-generated values (proofreading, other, revision) are also accepted and may match historical orders that were not created through Create Order.
​
filter[name]
string
Filter by the name of the order.
​
filter[createdAtRange][from]
string
Filter by creation date range - start date (ISO 8601 format).
​
filter[createdAtRange][to]
string
Filter by creation date range - end date (ISO 8601 format).

​
Response

​
data
array
Array of order objects containing order details.
​
meta
object
Pagination metadata.
{
  "data": [
    {
      "id": "60b8d6f1e1b9b1d8c6c0d8e1",
      "name": "Sample Project - Episode 1",
      "sourceLanguage": "en",
      "targetLanguage": "fr",
      "status": "completed",
      "type": "cc",
      "createdAt": "2024-01-15T10:30:00Z",
      "clientId": "client_abc123",
      "projectId": "proj_xyz789"
    },
    {
      "id": "60b8d6f1e1b9b1d8c6c0d8e2",
      "name": "Corporate Training Video",
      "sourceLanguage": "en",
      "targetLanguage": "es",
      "status": "ongoing",
      "type": "aiDubbing",
      "createdAt": "2024-01-14T15:45:00Z",
      "clientId": "client_abc123",
      "projectId": "proj_xyz790"
    }
  ],
  "meta": {
    "page": 1,
    "take": 10,
    "itemCount": 2,
    "pageCount": 1,
    "hasNextPage": false,
    "hasPreviousPage": false
  }
}