SMsmartling
Glossary API

Search glossary entries

Changed on

Search glossary entries endpoint.

post/glossary-api/v3/accounts/{accountUid}/glossaries/{glossaryUid}/entries/search

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

querystring

Keyword search for translation of variants.

localeIdsLocaleId[]

Locales list for translation filtering. Each locale must be one of the glossary locales. Required for the entries search endpoint unless entryUids is passed.

entryUidsstring[]

Glossary entry uids filter.

entryState'ACTIVE' | 'ARCHIVED' | 'BOTH'

State of the glossary entry. ACTIVE is used if omitted, or BOTH if entryUids is passed.

missingTranslationLocaleIdstring

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.

presentTranslationLocaleIdstring

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.

presentTranslationTargetLocaleIdstring

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.

presentTranslationWithTargetLocaleEnabledboolean

Applies only with presentTranslationTargetLocaleId: the translation in that locale must also not be disabled.

targetLocalePresentOrSourceTranslationDNTboolean

Applies only with presentTranslationTargetLocaleId: an entry also qualifies when its presentTranslationLocaleId translation is marked Do Not Translate (a translation for the target locale must still exist).

dntLocaleIdstring

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.

returnFallbackTranslationsboolean

For all translations, if they are missing, appropriate fallback locales will be used.

dntTermSetboolean

Return entries where dnt term is set.

mtCompatibilityStatesstring[]

MT-compatibility filter.

entrySuggestionStatusesstring[]

Suggestion status filter.

Example request

{
  "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"
  }
}

Response

Example response

{
  "response": {
    "data": {
      "items": [
        {
          "entryUid": "bac90990-4be1-4570-81da-b719cddd5352",
          "glossaryUid": "aad90990-4be1-4570-81da-b719cddd5352",
          "partOfSpeech": "NOUN",
          "translations": [
            {
              "localeId": "fr-FR",
              "fallbackLocaleId": "fr-FR",
              "term": "en term",
              "variants": [
                "en variation of the original term"
              ],
              "customFieldValues": [
                {
                  "fieldUid": "c_field_1",
                  "fieldName": "gender",
                  "fieldValue": "unknown",
                  "localeId": "fr-FR"
                }
              ],
              "requestTranslationStatus": {
                "localeId": "fr-FR",
                "requestDateTime": "2026-01-15T10:00:00Z",
                "requestUserUid": "99b0662fbae1"
              },
              "createdByUserUid": "99b0662fbae1",
              "modifiedByUserUid": "99b0662fbae1",
              "createdDate": "2026-01-15T10:00:00Z",
              "modifiedDate": "2026-01-15T10:00:00Z"
            }
          ],
          "customFieldValues": [
            {
              "fieldUid": "c_field_1",
              "fieldName": "gender",
              "fieldValue": "unknown"
            }
          ],
          "mtOptimizedLabel": "MT-Compatibility pending",
          "suggestionStatus": "SUGGESTED",
          "createdByUserUid": "99b0662fbae1",
          "modifiedByUserUid": "99b0662fbae1",
          "createdDate": "2026-01-15T10:00:00Z",
          "modifiedDate": "2026-01-15T10:00:00Z"
        }
      ]
    }
  }
}

Changes

  • 0da6569bfcb7Revision changes
    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • 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

      added the required property to the response with the status

  • 2cd7a8215799Revision changes
    • info

      endpoint added