--- title: "Search glossary entries" method: POST path: "/glossary-api/v3/accounts/{accountUid}/glossaries/{glossaryUid}/entries/search" tags: ["Glossary API"] --- # Search glossary entries `POST /glossary-api/v3/accounts/{accountUid}/glossaries/{glossaryUid}/entries/search` ## Request - Base URL: `https://api.smartling.com` - URL: `https://api.smartling.com/glossary-api/v3/accounts/{accountUid}/glossaries/{glossaryUid}/entries/search` - Auth: HTTP bearer Search glossary entries endpoint. ## Path parameters - `accountUid` string, required - `glossaryUid` string, uuid, required ## Request body - GetGlossaryEntriesByFilterCommandPTO: Glossary entries filter command. - `query` string: Keyword search for translation of variants. - `localeIds` LocaleId[]: Locales list for translation filtering. Each locale must be one of the glossary locales. Required for the entries search endpoint unless `entryUids` is passed. - `entryUids` string[]: Glossary entry uids filter. - `entryState` 'ACTIVE' | 'ARCHIVED' | 'BOTH': State of the glossary entry. ACTIVE is used if omitted, or BOTH if `entryUids` is passed. - `missingTranslationLocaleId` string: 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. - `presentTranslationLocaleId` string: 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. - `presentTranslationTargetLocaleId` string: 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. - `presentTranslationWithTargetLocaleEnabled` boolean: Applies only with `presentTranslationTargetLocaleId`: the translation in that locale must also not be disabled. - `targetLocalePresentOrSourceTranslationDNT` boolean: 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). - `dntLocaleId` string: 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. - `returnFallbackTranslations` boolean: For all translations, if they are missing, appropriate fallback locales will be used. - `labels` union: Labels filter on glossary entry level. There are 3 subTypes : - empty - allow to search for entries where no labels are assigned, as example - '{"type":"empty"}'; - any - allow to search for entries where ant labels are assigned, as example - '{"type":"any"}'; - associated - allow to search for entries where pre-selected labels are assigned, as example - '{"type":"associated", "labelUids":[""16ed66cc-accc-4bb5-9822-bc84e93429f8""]}'. - object: No labels filter / labels are missing filter. Use 'empty' as type property value. - `type` string, required - object: Any labels filter / labels - present filter. Use 'any' as type property value. - `type` string, required - object: Associated labels filter. Use 'associated' as type property value. - `type` string, required - `labelUids` string[], required: Label uuids collection for the filtering. - `dntTermSet` boolean: Return entries where dnt term is set. - `created` union: Audition date-time filter. Possible values : - after - after date-time filter, as example : '{ "type": "after", "level":"ANY", "date":"2023-02-01T11:45:00.000Z" }'; - before - before date-time filter, as example : '{ "type": "before", "level":"ANY", "date":"2023-02-01T11:45:00.000Z" }'; - date_range - date time in-range filter, as example : '{ "type": "date_range", "level":"ANY", "from":"2023-02-01T11:45:00.000Z", "to":"2023-03-01T11:45:00.000Z" }'; - exact - exact date time filter, as example : '{ "type": "exact", "level":"ANY", "date":"2023-02-01T11:45:00.000Z" }'. `level` is optional, ANY is used if omitted. Dates are ISO-8601 (e.g. '2023-02-01T11:45:00Z' or '2023-02-01T11:45:00+02:00'). - object: After date filter. - `level` 'ENTRY' | 'LOCALE' | 'ANY': Level on which filtering should be performed ( glossary entry / glossary translation / or any ). ANY is default. - `date` string, date-time, required: ISO 8601 UTC timestamp. - `type` string, required - object: Before date filter. - `level` 'ENTRY' | 'LOCALE' | 'ANY': Level on which filtering should be performed ( glossary entry / glossary translation / or any ). ANY is default. - `date` string, date-time, required: ISO 8601 UTC timestamp. - `type` string, required - object: Date range filter. - `level` 'ENTRY' | 'LOCALE' | 'ANY': Level on which filtering should be performed ( glossary entry / glossary translation / or any ). ANY is default. - `from` string, date-time, required: ISO 8601 UTC timestamp. - `to` string, date-time, required: ISO 8601 UTC timestamp. - `type` string, required - object: Exact date filter. - `level` 'ENTRY' | 'LOCALE' | 'ANY': Level on which filtering should be performed ( glossary entry / glossary translation / or any ). ANY is default. - `date` string, date-time, required: ISO 8601 UTC timestamp. - `type` string, required - `lastModified` union: Audition date-time filter. Possible values : - after - after date-time filter, as example : '{ "type": "after", "level":"ANY", "date":"2023-02-01T11:45:00.000Z" }'; - before - before date-time filter, as example : '{ "type": "before", "level":"ANY", "date":"2023-02-01T11:45:00.000Z" }'; - date_range - date time in-range filter, as example : '{ "type": "date_range", "level":"ANY", "from":"2023-02-01T11:45:00.000Z", "to":"2023-03-01T11:45:00.000Z" }'; - exact - exact date time filter, as example : '{ "type": "exact", "level":"ANY", "date":"2023-02-01T11:45:00.000Z" }'. `level` is optional, ANY is used if omitted. Dates are ISO-8601 (e.g. '2023-02-01T11:45:00Z' or '2023-02-01T11:45:00+02:00'). - object: After date filter. - `level` 'ENTRY' | 'LOCALE' | 'ANY': Level on which filtering should be performed ( glossary entry / glossary translation / or any ). ANY is default. - `date` string, date-time, required: ISO 8601 UTC timestamp. - `type` string, required - object: Before date filter. - `level` 'ENTRY' | 'LOCALE' | 'ANY': Level on which filtering should be performed ( glossary entry / glossary translation / or any ). ANY is default. - `date` string, date-time, required: ISO 8601 UTC timestamp. - `type` string, required - object: Date range filter. - `level` 'ENTRY' | 'LOCALE' | 'ANY': Level on which filtering should be performed ( glossary entry / glossary translation / or any ). ANY is default. - `from` string, date-time, required: ISO 8601 UTC timestamp. - `to` string, date-time, required: ISO 8601 UTC timestamp. - `type` string, required - object: Exact date filter. - `level` 'ENTRY' | 'LOCALE' | 'ANY': Level on which filtering should be performed ( glossary entry / glossary translation / or any ). ANY is default. - `date` string, date-time, required: ISO 8601 UTC timestamp. - `type` string, required - `createdBy` AuditorCommandPTO: Auditor user filter. - `level` 'ENTRY' | 'LOCALE' | 'ANY': Level on which filtering should be performed ( glossary entry / glossary translation / or any ). - `userIds` string[], required: User identifiers. - `lastModifiedBy` AuditorCommandPTO: Auditor user filter. - `level` 'ENTRY' | 'LOCALE' | 'ANY': Level on which filtering should be performed ( glossary entry / glossary translation / or any ). - `userIds` string[], required: User identifiers. - `mtCompatibilityStates` string[]: MT-compatibility filter. - `entrySuggestionStatuses` string[]: Suggestion status filter. - `customFields` CustomFieldFilterCommandPTO[]: Custom fields filter. Items are AND-ed, values within an item are OR-ed. `fieldUid` must be unique and assigned to the glossary. Text fields accept up to 10 values; select values must be valid options; checkbox values are "true" or "false". - `fieldUid` string, required: Uid of the custom field. - `fieldValues` string[], required: Values to match (OR-ed). - `paging` PaginationCommandPTO: Pagination options. If `paging` is omitted, offset 0 and limit 500 are used. If `paging` is passed, set `limit` explicitly: an omitted `limit` returns a single item. - `offset` integer: Amount of items to skip. Negative values are treated as 0. - `limit` integer: Amount of items to fetch. Values below 1 are raised to 1, and values above 500 are reduced to 500. - `sorting` GlossaryEntriesSortCommandPTO: Sorting options. If `sorting` is omitted, entries are sorted by lastModifiedDate DESC. An unknown `field` falls back to lastModifiedDate; an unknown `direction` falls back to ASC. - `field` 'term' | 'createdDate' | 'lastModifiedDate': Sort field, select one of - term | createdDate | lastModifiedDate. - `direction` 'ASC' | 'DESC': Sort direction. - `localeId` string: 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. ## Response `200` - EntriesSearchSuccessResponse - `response` object, required - `code` 'SUCCESS', required: Indicates whether the response was successful or what error has occurred. - `data` object - `totalCount` integer: total entries amount - `items` GlossaryEntryResponsePTO[] - `entryUid` string: Glossary entry uid. - `glossaryUid` string: Glossary uid. - `definition` string: Glossary entry definition. - `partOfSpeech` string: Glossary entry part of speech value. - `labelUids` string[]: Assigned label uuids. - `translations` GlossaryEntryTranslationPTO[]: Translations collection. - `localeId` string: 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. - `fallbackLocaleId` string: 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. - `term` string: Glossary translation term. - `notes` string: Glossary translation notes. - `caseSensitive` boolean: Glossary entry translation caseSensitive property. - `exactMatch` boolean: Glossary entry translation exactMatch property. - `doNotTranslate` boolean: Glossary entry translation doNotTranslate property. - `disabled` boolean: Glossary entry translation disabled property. - `variants` string[]: Term variants/synonyms. - `customFieldValues` EntryTranslationCustomFieldValuePTO[]: Translation level, assigned custom fields values. - `fieldUid` string: Custom field uid. - `fieldName` string: Custom field name. - `fieldValue` string: Custom field value. - `localeId` string: 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. - `requestTranslationStatus` EntryTranslationInProgressPTO: Holds meta-information about translation that is in progress. - `localeId` string: 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. - `requestDateTime` string, date-time: ISO 8601 UTC timestamp. - `requestUserUid` string: Unique identifier of a user — 12 lowercase alphanumeric characters. - `createdByUserUid` string: Unique identifier of a user — 12 lowercase alphanumeric characters. - `modifiedByUserUid` string: Unique identifier of a user — 12 lowercase alphanumeric characters. - `createdDate` string, date-time: ISO 8601 UTC timestamp. - `modifiedDate` string, date-time: ISO 8601 UTC timestamp. - `customFieldValues` EntryCustomFieldValuePTO[]: Assigned custom field values. - `fieldUid` string: Custom field uid. - `fieldName` string: Custom field name. - `fieldValue` string: Custom field value. - `archived` boolean: Archived flag. - `mtOptimizedLabel` 'Not MT-Compatible' | 'MT-Compatible' | 'MT-Compatibility pending': MT-compatibility state of the entry. - `suggestionStatus` 'SUGGESTED' | 'APPROVED': Suggestion status of the entry. Omitted for standard (non-suggested) entries. - `createdByUserUid` string: Unique identifier of a user — 12 lowercase alphanumeric characters. - `modifiedByUserUid` string: Unique identifier of a user — 12 lowercase alphanumeric characters. - `createdDate` string, date-time: ISO 8601 UTC timestamp. - `modifiedDate` string, date-time: ISO 8601 UTC timestamp. - `requestTranslationStatuses` object: Request translation details in min form. Please note that translation locale id will be used as a key. ## Other responses - `400`: Provided request parameters are invalid. - `401`: Provided credentials are not valid. - `403`: Access denied. - `404`: Resource not found. - `429`: Too many simultaneous API requests. - `500`: Unexpected error. ## Changes - **2026-10-26** `0da6569bfcb7`: 2 warning, 7 info - removed the optional property `items` from the response with the `200` status - removed the optional property `totalCount` from the response with the `200` status - added the new optional request property `customFields` - added the new optional request property `entrySuggestionStatuses` - …5 more - **2026-10-17** `2cd7a8215799`: 1 info - endpoint added [Operation history](https://skmtc.dev/smartling/apis/smartling-rest-api-reference/changes/glossary-api/v3/accounts/:accountUid/glossaries/:glossaryUid/entries/search/post.md) --- [API](https://skmtc.dev/smartling/apis/smartling-rest-api-reference.md) - [All operations](https://skmtc.dev/smartling/apis/smartling-rest-api-reference/llms.txt) - [OpenAPI document](https://skmtc.dev/smartling/apis/smartling-rest-api-reference/revisions/e63066e7f5e9?raw)