> ## Documentation Index
> Fetch the complete documentation index at: https://api-docs.ollang.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Figma Orders

> List all translation orders for a Figma file

Retrieve all translation orders associated with a specific Figma file. Orders are returned sorted by creation date (newest first) and include review info when an order is at a review gate.

<RequestExample>
  ```bash cURL theme={null}
  curl -X GET "https://api-integration.ollang.com/integration/orders/figma?fileKey=UwNAtPYAu5JPIhFc03M71h" \
    -H "X-Api-Key: <your-api-key>"
  ```

  ```javascript JavaScript theme={null}
  const fileKey = "UwNAtPYAu5JPIhFc03M71h";

  const response = await fetch(
    `https://api-integration.ollang.com/integration/orders/figma?fileKey=${fileKey}`,
    {
      headers: {
        "X-Api-Key": "<your-api-key>",
      },
    }
  );

  const orders = await response.json();
  console.log(orders);
  ```

  ```python Python theme={null}
  import requests

  headers = {
      'X-Api-Key': '<your-api-key>'
  }

  response = requests.get(
      'https://api-integration.ollang.com/integration/orders/figma',
      headers=headers,
      params={'fileKey': 'UwNAtPYAu5JPIhFc03M71h'}
  )

  orders = response.json()
  print(orders)
  ```
</RequestExample>

## 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

## Query Parameters

<ParamField query="fileKey" type="string" required>
  The Figma file key to look up orders for. Only orders whose project contains a document with this file key will be returned.
</ParamField>

## Response

Returns an array of order objects.

<ResponseField name="id" type="string">
  The unique order identifier.
</ResponseField>

<ResponseField name="status" type="string">
  Current order status: `ongoing`, `review`, `waitingForApprove`, `completed`, `delivered`, `pending`, `revision`.
</ResponseField>

<ResponseField name="targetLanguage" type="string">
  The target language code for this order.
</ResponseField>

<ResponseField name="createdAt" type="string">
  ISO 8601 timestamp of when the order was created.
</ResponseField>

<ResponseField name="orderName" type="string">
  The display name of the order.
</ResponseField>

<ResponseField name="reviewInfo" type="object">
  Present when the order is currently at a review gate. `null` otherwise.

  <Expandable title="Review info properties">
    <ResponseField name="teamTagName" type="string">
      Name of the team responsible for the review.
    </ResponseField>

    <ResponseField name="teamTagColor" type="string">
      Hex color of the team tag (e.g., `#FF5733`). May be null.
    </ResponseField>

    <ResponseField name="reviewType" type="string">
      Type of review: `assignment` or `comment`.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseExample>
  ```json 200 theme={null}
  [
    {
      "id": "60b8d6f1e1b9b1d8c6c0d8e3",
      "status": "completed",
      "targetLanguage": "fr",
      "createdAt": "2026-08-19T10:30:00.000Z",
      "orderName": "My Design → FR",
      "reviewInfo": null
    },
    {
      "id": "60b8d6f1e1b9b1d8c6c0d8e4",
      "status": "review",
      "targetLanguage": "de",
      "createdAt": "2026-08-19T10:30:00.000Z",
      "orderName": "My Design → DE",
      "reviewInfo": {
        "teamTagName": "Medical Review",
        "teamTagColor": "#FF5733",
        "reviewType": "assignment"
      }
    },
    {
      "id": "60b8d6f1e1b9b1d8c6c0d8e5",
      "status": "ongoing",
      "targetLanguage": "tr",
      "createdAt": "2026-08-19T10:30:00.000Z",
      "orderName": "My Design → TR",
      "reviewInfo": null
    }
  ]
  ```

  ```json 200 (empty) theme={null}
  []
  ```
</ResponseExample>
