---
title: "Export Glossary"
method: POST
path: "/glossaries/{glossaryId}/exports"
tags: ["Glossaries"]
---

# Export Glossary

`POST /glossaries/{glossaryId}/exports`

## Request

- Base URL: `https://api.crowdin.com/api/v2`
- URL: `https://api.crowdin.com/api/v2/glossaries/{glossaryId}/exports`
- Auth: none declared
- TypeScript: <https://skmtc.dev/crowdin/apis/crowdin-api-v2/docs/glossaries/:glossaryId/exports/post.ts> (a function with typed inputs; its response is checked against the schema)

**Required scopes:** `glossary` (Read only).

## Path parameters

- `glossaryId` integer, required

## Request body

- GlossaryExportForm
  - `format` 'tbx' | 'tbx_v3' | 'csv' | 'xlsx': Supported formats: * 'tbx' * 'tbx_v3' * 'csv' * 'xlsx'
  - `exportType` 'concepts' | 'terms': Determines whether the export keeps every term of a matching concept (`concepts`, default) * or only the terms that match the active filters (`terms`).
  - `text` string
  - `caseSensitive` boolean: __Note:__ Must be used together with `text`
  - `searchStrict` boolean: __Note:__ Must be used together with `text`
  - `searchFullMatch` boolean: __Note:__ Must be used together with `text`
  - `status` 'PREFERRED' | 'ADMITTED' | 'NOT_RECOMMENDED' | 'OBSOLETE' | 'DRAFT': __Deprecated:__ use `statuses` instead. Cannot be combined with `statuses`.
  - `statuses` string[]: Filter terms by one or more statuses.
  - `partOfSpeech` 'NOUN' | 'VERB' | 'ADJ' | 'PRON' | 'PROPN' | 'DET' | 'ADV' | 'ADP' | 'CCONJ' | 'SCONJ' | 'NUM' | 'INTJ' | 'AUX' | 'PRT' | 'SYM' | 'X': __Deprecated:__ use `partsOfSpeech` instead. Cannot be combined with `partsOfSpeech`.
  - `partsOfSpeech` string[]: Filter terms by one or more parts of speech.
  - `type` 'FULL_FORM' | 'ACRONYM' | 'ABBREVIATION' | 'SHORT_FORM' | 'PHRASE' | 'VARIANT': __Deprecated:__ use `types` instead. Cannot be combined with `types`.
  - `types` string[]: Filter terms by one or more types.
  - `gender` 'MASCULINE' | 'FEMININE' | 'NEUTER' | 'COMMON' | 'OTHER': __Deprecated:__ use `genders` instead. Cannot be combined with `genders`.
  - `genders` string[]: Filter terms by one or more genders.
  - `authorId` integer: __Deprecated:__ use `authorIds` instead. Cannot be combined with `authorIds`.
  - `authorIds` integer[]: Filter terms by one or more authors. Up to 50 values.
  - `languageIds` string[]: Filter terms by one or more language IDs. Up to 50 values.
  - `dateFrom` string, date-time: Export date from in UTC, ISO 8601
  - `dateTo` string, date-time: Export date to in UTC, ISO 8601
  - `exportFields` string[]: Array fields for export. __Note:__ Used for export CSV or XLSX format only

## Response `202`

Glossary export was successfully started

- GlossaryExportResource: Base schema of resource container. Container is a wrapper object that contains payload in required `data` property and provides space for adding any other metadata.
  - `data` GlossaryExport, required: Class GlossaryExportResponseModel
    - `identifier` string
    - `status` string
    - `progress` integer: in percentages
    - `attributes` object
      - `format` string
      - `exportFields` string[]
      - `text` string
      - `caseSensitive` boolean, nullable
      - `searchFullMatch` boolean, nullable
      - `searchStrict` boolean, nullable
      - `status` string, nullable
      - `partOfSpeech` string, nullable
      - `type` string, nullable
      - `gender` string, nullable
      - `authorId` integer, nullable
      - `dateFrom` string, date-time, nullable
      - `dateTo` string, date-time, nullable
    - `createdAt` string, date-time
    - `updatedAt` string, date-time
    - `startedAt` string, date-time, nullable
    - `finishedAt` string, date-time, nullable

## Other responses

- `400`: Invalid Request Parameters
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Glossary with specified id was not found
- `405`: Method Not Allowed
- `409`: Conflict

---

[API](https://skmtc.dev/crowdin/apis/crowdin-api-v2.md) - [All operations](https://skmtc.dev/crowdin/apis/crowdin-api-v2/llms.txt) - [OpenAPI document](https://skmtc.dev/crowdin/apis/crowdin-api-v2/revisions/27aae7751699?raw)