Glossaries

List glossaries

OAuth: This endpoint requires one of the following scopes: glossary:manage, glossary:read or glossary:write.

List Glossaries

get

Authorizations

oauth2

OAuth2authorizationCodeRequired

OAuth2 Bearer token authentication

Authorization URL: Token URL: Refresh URL:

Query parameters

filterstring · enumOptional

Possible values:

• all: list both shared and owned glossaries (default).
• share: shared glossaries only.
• owned: owned glossaries only.

Possible values:

pageintegerOptional

Search results are limited to 100 items. Specify page number to read more than the first page.

Responses

200

Lists glossaries

application/json

namestringOptional

language_codesstring[]Optional

created_atstringOptional

file_urlstringOptional

user_idstringOptional

idstringOptional

typestringOptional

401

Unauthorized

application/json

403

Forbidden

application/json

get

/v1/clients/glossaries

HTTPcURLJavaScriptPython

GET /v1/clients/glossaries HTTP/1.1
Host: api.textmaster.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

[
  {
    "name": "some-glossary.xlsx",
    "language_codes": [
      "en-eu",
      "fr-fr"
    ],
    "created_at": "2021-12-25T12:34:45.123Z",
    "file_url": "https://s3-eu-west-1.amazonaws.com/base-textmaster-production/uploads/glossaries/user_abcdefghijklmn0123456789/2e485972-3bbf-41f7-bead-5b328c3ad1d2/some-glossary.xlsx?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=XXX%2F20211225%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20211225T123456Z&X-Amz-Expires=86400&X-Amz-Signature=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX&X-Amz-SignedHeaders=host&response-content-disposition=attachment",
    "user_id": "97e36903-1c7b-4790-9ff3-bf76e0e4c17c",
    "term_count": 123456,
    "id": "2e485972-3bbf-41f7-bead-5b328c3ad1d2",
    "type": "glossaries",
    "links": {
      "self": "http://api.glossary.svc.cluster.local/api/v1/glossaries/2e485972-3bbf-41f7-bead-5b328c3ad1d2"
    },
    "relationships": {
      "glossary_holders": {
        "links": {
          "self": "http://api.glossary.svc.cluster.local/api/v1/glossaries/2e485972-3bbf-41f7-bead-5b328c3ad1d2/relationships/glossary_holders",
          "related": "http://api.glossary.svc.cluster.local/api/v1/glossaries/2e485972-3bbf-41f7-bead-5b328c3ad1d2/glossary_holders"
        }
      }
    }
  }
]

Code samples

curl -G "https://api.textmaster.com/v1/clients/glossaries" \
  --data-urlencode "filter=all" \
  -H "Authorization: Bearer 6aa131e7cd6a037c8e955fa5e3231bd8e201bb4218644aa8a28125769e1b91a1"