CRcrowdin
Glossaries

List Terms

Required scopes: glossary (Read only).

Returns a list of terms in the glossary, ordered by id unless orderBy says otherwise. Without a filter the terms of every language are returned.

get/glossaries/{glossaryId}/terms

Request

Path parameters

glossaryIdinteger required

Glossary Identifier. Get via List Glossaries

Query parameters

orderBy'id' | 'text' | 'description' | 'partOfSpeech' | 'status' | 'type' | 'gender' | 'note' | 'lemma' | 'createdAt' | 'updatedAt'

Read more about sorting rules

userIdinteger

User Identifier. Get via List Users

languageIdstring

Term Language Identifier. Get via List Supported Languages

conceptIdinteger

Filter terms by conceptId

Note: Use for terms that have translations. Get via List Concepts

translationOfTermIdinteger

Filter terms by termId

Note: Use for terms that have translations

croqlstring

Filter strings by CroQL

Note: Can be used only with orderBy, offset and limit in same request

limitinteger

A maximum number of items to retrieve

offsetinteger

A starting offset in the collection

Response

Terms list

Example response

{
  "data": [
    {
      "data": {
        "id": 2,
        "userId": 6,
        "glossaryId": 6,
        "languageId": "fr",
        "text": "Voir",
        "description": "use for pages only (check screenshots)",
        "partOfSpeech": "verb",
        "status": "preferred",
        "type": "abbreviation",
        "gender": "masculine",
        "note": "Any kind of note, such as a usage note, explanation, or instruction",
        "url": "Base URL",
        "conceptId": 6,
        "lemma": "voir",
        "createdAt": "2019-09-23T07:19:47+00:00",
        "updatedAt": "2019-09-23T07:19:47+00:00",
        "fields": {
          "some-field-1": "some value 1",
          "some-field-2": 12,
          "some-field-3": true,
          "some-field-4": [
            "en",
            "ja"
          ]
        }
      }
    }
  ],
  "pagination": {
    "limit": 25
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.