SMsmartling
Glossary API

Search glossaries by filter

Changed on

Search glossaries by filter endpoint.

post/glossary-api/v3/accounts/{accountUid}/glossaries/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.

Request body

querystring

Allow to search glossaries by query in scope of glossaryName or description properties. Also supports exact search by glossaryUid: if query is a UUID, it is matched as a glossaryUid and glossaryState is ignored (BOTH is used).

glossaryState'ACTIVE' | 'ARCHIVED' | 'BOTH'

Glossary state. ACTIVE is used if omitted. Ignored (BOTH is used) when glossaryUids is passed.

targetLocaleIdstring

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.

glossaryUidsstring[]

GlossaryUids filter.

includeEntriesCountboolean

Allow to exclude / include glossary entries count, for each glossary that was found by the criteria.

Example request

{
  "query": "some name",
  "glossaryState": "BOTH",
  "targetLocaleId": "fr-FR",
  "glossaryUids": [
    "58966072-6569-4c22-930c-de906b7fb18d",
    "12366072-6569-4c22-930c-de906b7fb18d"
  ],
  "paging": {
    "limit": 50
  }
}

Response

Example response

{
  "response": {
    "data": {
      "items": [
        {
          "glossaryUid": "58966072-6569-4c22-930c-de906b7fb18d",
          "accountUid": "56a0b220",
          "glossaryName": "CF-enabled-glossary-V2",
          "createdByUserUid": "99b0662fbae1",
          "modifiedByUserUid": "99b0662fbae1",
          "createdDate": "2026-01-15T10:00:00Z",
          "modifiedDate": "2026-01-15T10:00:00Z",
          "localeIds": [
            "en",
            "en-US",
            "hi-IN",
            "pl-PL",
            "uk-UA"
          ],
          "fallbackLocales": [
            {
              "fallbackLocaleId": "fr-FR",
              "localeIds": [
                "en-US"
              ]
            }
          ]
        }
      ]
    }
  }
}

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 required property to the response with the status

  • 2cd7a8215799Revision changes
    • info

      endpoint added