SMsmartling
Glossary API

Export glossary entries

Changed on

This request export glossary entries into file with preselected format. For now next formats are allowed:

  • CSV,
  • XLSX,
  • TBX.

For TBX files - 2 version-names / versions supported:

  • TBXcoreStructV02,
  • TBXcoreStructV03.
post/glossary-api/v3/accounts/{accountUid}/glossaries/{glossaryUid}/entries/download

Request

  • Base URL
    https://api.smartling.com
  • Auth
    HTTP bearer

Path parameters

accountUidstring required

The account’s unique identifier. This can be found in the Smartling Dashboard under Account Settings > API.

glossaryUidstring uuid required

Unique identifier of the glossary.

Request body

format'CSV' | 'XLSX' | 'TBX' required

Export format (case-insensitive).

tbxVersion'TBXcoreStructV02' | 'TBXcoreStructV03'

TBX version-name, used only for the TBX format. The aliases V_2_CORE / V_3_CORE are also accepted.

focusLocaleIdstring

Locale identifier. Either a 2-letter language code (en) or a language-region pair (en-US). The language part is always lowercase; the region part is always uppercase.

localeIdsLocaleId[]

Locales ids for the export. Each locale must be one of the glossary locales. If omitted, CSV and XLSX exports contain no translations, and TBX exports the glossary's first locale.

skipEntriesboolean

Skip entries export if true; exports only headers ( template ).

Example request

{
  "filter": {
    "query": "P&G term",
    "localeIds": [
      "uk-UA",
      "en",
      "en-US"
    ],
    "entryUids": [
      "16ed66cc-accc-4bb5-9822-bc84e93429f8",
      "69dae398-96c2-45f6-9f0d-91470c3464bd"
    ],
    "entryState": "ACTIVE",
    "missingTranslationLocaleId": "fr-FR",
    "presentTranslationLocaleId": "fr-FR",
    "presentTranslationTargetLocaleId": "fr-FR",
    "dntLocaleId": "fr-FR",
    "labels": {
      "type": "empty"
    },
    "created": {
      "level": "ANY",
      "date": "2026-01-15T10:00:00Z",
      "type": "after"
    },
    "lastModified": {
      "level": "ANY",
      "date": "2026-01-15T10:00:00Z",
      "type": "after"
    },
    "createdBy": {
      "level": "ANY",
      "userIds": [
        "user1",
        "user2"
      ]
    },
    "lastModifiedBy": {
      "level": "ANY",
      "userIds": [
        "user1",
        "user2"
      ]
    },
    "mtCompatibilityStates": [
      "OPTIMIZED"
    ],
    "entrySuggestionStatuses": [
      "STANDARD",
      "APPROVED"
    ],
    "customFields": [
      {
        "fieldUid": "4a1f7c2e-3b5d-4e6f-8a9b-0c1d2e3f4a5b",
        "fieldValues": [
          "value 1",
          "value 2"
        ]
      }
    ],
    "paging": {
      "limit": 50
    },
    "sorting": {
      "field": "term",
      "direction": "DESC",
      "localeId": "fr-FR"
    }
  },
  "focusLocaleId": "fr-FR",
  "localeIds": [
    "fr-FR"
  ]
}

Response

OK

Changes

  • 0da6569bfcb7Revision changes
    • info

      added the new optional request property /////

    • info

      added the new optional request property /////

    • info

      added the new optional request property /////

    • info

      added the new optional request property /////

    • info

      added the new optional request property /////

    • info

      added the new optional request property /////

    • info

      the request property became optional

    • info

      the request property default value TBXcoreStructV02 was added

  • 2cd7a8215799Revision changes
    • info

      endpoint added