v2.md

Crowdin API v2

Operations

• projects.branches.getMany(projectId, [options])
• projects.branches.createOne(projectId)
• projects.branches.getOne(projectId, branchId)
• projects.branches.deleteOne(projectId, branchId)
• projects.branches.patchOne(projectId, branchId)
• projects.directories.getMany(projectId, [options])
• projects.directories.createOne(projectId)
• projects.directories.getOne(projectId, directoryId)
• projects.directories.deleteOne(projectId, directoryId)
• projects.directories.patchOne(projectId, directoryId)
• projects.files.getMany(projectId, [options])
• projects.files.createOne(projectId, [options])
• projects.files.getOne(projectId, fileId)
• projects.files.deleteOne(projectId, fileId)
• projects.files.patchOne(projectId, fileId)
• projects.files.downloadLink(projectId, fileId)
• glossaries.getMany([options])
• glossaries.createOne()
• glossaries.getOne(glossaryId)
• glossaries.deleteOne(glossaryId)
• glossaries.patchOne(glossaryId)
• glossaries.export.exportOne(glossaryId)
• glossaries.export.getDownloadLink(glossaryId, [options])
• glossaries.export.getExportStatus(glossaryId, exportId)
• glossaries.import.importOne(glossaryId)
• glossaries.import.getImportOne(glossaryId, importId)
• groups.getMany([options])
• groups.createOne()
• groups.getOne(groupId)
• groups.deleteOne(groupId)
• groups.patchOne(groupId)
• projects.images.background.uploadOne(projectId)
• projects.images.background.deleteOne(projectId)
• projects.images.logo.uploadOne(projectId)
• projects.images.logo.deleteOne(projectId)
• issues.getMany(projectId, [options])
• projects.issues.statistics.getMany(projectId, [options])
• languages.getMany([options])
• languages.getOne(languageId)
• projects.preTranslates.preTranslate(projectId)
• projects.preTranslates.getTranslation(projectId, preTranslationId)
• storages.preview.getOne(storageId)
• projects.branches.languages.progress.getMany(projectId, branchId)
• projects.directories.languages.progress.getMany(projectId, directoryId)
• projects.exportReadyProgress.getMany(projectId, [options])
• projects.files.languages.progress.getMany(projectId, fileId)
• projects.languages.progress.getMany(projectId)
• projects.getMany([options])
• projects.createOne()
• projects.getOne(projectId)
• projects.deleteOne(projectId)
• projects.patchOne(projectId)
• projects.pseudo.builds.getOne(projectId)
• projects.pseudo.builds.getStatus(projectId, pseudoTranslationBuildId)
• projects.pseudo.getDownloadLink(projectId)
• projects.getQACheck(projectId, [options])
• reportTypes.getMany(projectId, [options])
• projects.reports.createOne(projectId)
• projects.reports.raw.exportOne(projectId, reportId)
• projects.files.revisions.getMany(projectId, fileId, [options])
• projects.files.revisions.createOne(projectId, fileId)
• projects.files.revisions.getOne(projectId, fileId, revision)
• projects.screenshots.getMany(projectId, [options])
• projects.screenshots.createOne(projectId)
• projects.screenshots.getOne(projectId, screenshotId)
• projects.screenshots.replaceOne(projectId, screenshotId)
• projects.screenshots.deleteOne(projectId, screenshotId)
• projects.screenshots.patchOne(projectId, screenshotId)
• projects.screenshots.tags.getMany(projectId, screenshotId, [options])
• projects.screenshots.tags.replaceAll(projectId, screenshotId)
• projects.screenshots.tags.createOne(projectId, screenshotId)
• projects.screenshots.tags.deleteAll(projectId, screenshotId)
• projects.screenshots.tags.getOne(projectId, screenshotId, tagId)
• projects.screenshots.tags.deleteOne(projectId, screenshotId, tagId)
• projects.screenshots.tags.patchOne(projectId, screenshotId, tagId)
• projects.settings.getOne(projectId)
• projects.settings.patchOne(projectId)
• storages.getAll(storageId)
• storages.uploadOne()
• storages.getOne(storageId)
• storages.deleteOne(storageId)
• projects.pseudo.listProjectStrings(projectId, [options])
• projects.strings.createOne(projectId)
• projects.strings.getOne(projectId, stringId)
• projects.strings.deleteOne(projectId, stringId)
• projects.strings.patchOne(projectId, stringId)
• projects.tasks.getMany(projectId, [options])
• projects.tasks.createOne(projectId)
• projects.tasks.getOne(projectId, taskId)
• projects.tasks.deleteOne(projectId, taskId)
• projects.tasks.patchOne(projectId, taskId)
• projects.tasks.statistics.getMany(projectId, [options])
• glossaries.terms.getMany(glossaryId, [options])
• glossary.terms.createOne(glossaryId)
• glossaries.terms.getOne(glossaryId, termId)
• glossaries.terms.deleteOne(glossaryId, termId)
• glossaries.terms.patchOne(glossaryId, termId)
• tms.getList([options])
• tms.uploadOne()
• tms.getOne(tmId)
• tms.deleteOne(tmId)
• tms.patchOne(tmId)
• tms.downloadOne(tmId, [options])
• tms.exportOne(tmId)
• tms.export.getOne(tmId, exportId)
• tms.upload(tmId)
• tms.upload.jobByTm(tmId, importId)
• projects.translations.builds.getList([options])
• projects.translations.builds.init(projectId)
• projects.translations.builds.getDownloadLink(projectId, buildId)
• projects.translations.builds.getOne(projectId, buildId)
• projects.translations.builds.cancel(projectId, buildId)
• projects.translations.initByLanguage(projectId, languageId)
• projects.webhooks.getMany(projectId, [options])
• projects.webhooks.createOne(projectId)
• projects.webhooks.getOne(projectId, webhookId)
• projects.webhooks.deleteOne(projectId, webhookId)
• projects.webhooks.patchOne(projectId, webhookId)

projects.branches.getMany(projectId, [options])

List project branches

Parameters

name	in	description	required	schema
projectId	path	Project Identifier.	true	[object Object]
name	query	Filter branch by name.		[object Object]
limit	query	Maximum number of items to retrieve.		[object Object]
offset	query	Starting offset in the collection.		[object Object]

projects.branches.createOne(projectId)

Create a branch

Parameters

name	in	description	required	schema
projectId	path	Project Identifier.	true	[object Object]

projects.branches.getOne(projectId, branchId)

Get a branch

Parameters

name	in	description	required	schema
projectId	path	Project Identifier.	true	[object Object]
branchId	path	Branch Identifier.	true	[object Object]

projects.branches.deleteOne(projectId, branchId)

Delete a branch

Parameters

name	in	description	required	schema
projectId	path	Project Identifier.	true	[object Object]
branchId	path	Branch Identifier.	true	[object Object]

projects.branches.patchOne(projectId, branchId)

Update a branch

Parameters

name	in	description	required	schema
projectId	path	Project Identifier.	true	[object Object]
branchId	path	Branch Identifier.	true	[object Object]

projects.directories.getMany(projectId, [options])

List project directories

Parameters

name	in	description	required	schema
projectId	path	Project Identifier.	true	[object Object]
branchId	query	Filter directories by branchId		[object Object]
directoryId	query	Filter directories by directoryId		[object Object]
limit	query	Maximum number of items to retrieve.		[object Object]
offset	query	Starting offset in the collection.		[object Object]

projects.directories.createOne(projectId)

Create a directory

Parameters

name	in	description	required	schema
projectId	path	Project Identifier.	true	[object Object]

projects.directories.getOne(projectId, directoryId)

Get a directory

Parameters

name	in	description	required	schema
projectId	path	Project Identifier.	true	[object Object]
directoryId	path	Directory Identifier.	true	[object Object]

projects.directories.deleteOne(projectId, directoryId)

Delete a directory

Parameters

name	in	description	required	schema
projectId	path	Project Identifier.	true	[object Object]
directoryId	path	Directory Identifier.	true	[object Object]

projects.directories.patchOne(projectId, directoryId)

Update a directory

Parameters

name	in	description	required	schema
projectId	path	Project Identifier.	true	[object Object]
directoryId	path	Directory Identifier.	true	[object Object]

projects.files.getMany(projectId, [options])

List project files

Parameters

name	in	description	required	schema
projectId	path	Project Identifier.	true	[object Object]
branchId	query	List branch files.

Note! You can either list files for the specified branch (branchId) in the same request. | | [object Object] | | directoryId | query | List directory files.

Note! You can either list files for the specified directory (directoryId) in the same request. | | [object Object] | | limit | query | Maximum number of items to retrieve. | | [object Object] | | offset | query | Starting offset in the collection. | | [object Object] |

projects.files.createOne(projectId, [options])

Create a file

Parameters

name	in	description	required	schema
projectId	path	Project Identifier.	true	[object Object]
branchId	query	Get files of branch. You can set branchId or directoryId, not both		[object Object]
directoryId	query	Get files of directory. You can set branchId or directoryId, not both		[object Object]

projects.files.getOne(projectId, fileId)

Get a file

Parameters

name	in	description	required	schema
projectId	path	Project Identifier.	true	[object Object]
fileId	path	File Identifier.	true	[object Object]

projects.files.deleteOne(projectId, fileId)

Delete a file

Parameters

name	in	description	required	schema
projectId	path	Project Identifier.	true	[object Object]
fileId	path	File Identifier.	true	[object Object]

projects.files.patchOne(projectId, fileId)

Update a file

Parameters

name	in	description	required	schema
projectId	path	Project Identifier.	true	[object Object]
fileId	path	File Identifier.	true	[object Object]

projects.files.downloadLink(projectId, fileId)

Export file raw

Parameters

name	in	description	required	schema
projectId	path	Project Identifier.	true	[object Object]
fileId	path	File Identifier.	true	[object Object]

glossaries.getMany([options])

List Glossaries

Parameters

name	in	description	required	schema
groupId	query	A unique identifier for the group, this glossary is associated with.	true	[object Object]
limit	query	Maximum number of items to retrieve.		[object Object]
offset	query	Starting offset in the collection.		[object Object]

glossaries.createOne()

Create a Glossary

Parameters

| | | |

glossaries.getOne(glossaryId)

Get a Glossary

Parameters

name	in	description	required	schema
glossaryId	path	Glossary Identifier.	true	[object Object]

glossaries.deleteOne(glossaryId)

Delete a Glossary

Parameters

name	in	description	required	schema
glossaryId	path	Glossary Identifier.	true	[object Object]

glossaries.patchOne(glossaryId)

Update a Glossary

Parameters

name	in	description	required	schema
glossaryId	path	Glossary Identifier.	true	[object Object]

glossaries.export.exportOne(glossaryId)

Start Glossary export

Parameters

name	in	description	required	schema
glossaryId	path	Glossary Identifier.	true	[object Object]

glossaries.export.getDownloadLink(glossaryId, [options])

Get a Glossary download link

Parameters

name	in	description	required	schema
glossaryId	path	Glossary Identifier.	true	[object Object]
format	query	Defines download format. Default is tbx.		[object Object]

glossaries.export.getExportStatus(glossaryId, exportId)

Get Glossary export status

Parameters

name	in	description	required	schema
glossaryId	path	Glossary Identifier.	true	[object Object]
exportId	path	Export Identifier, consists of 36 characters.	true	[object Object]

glossaries.import.importOne(glossaryId)

Import a Glossary file

Parameters

name	in	description	required	schema
glossaryId	path	Glossary Identifier.	true	[object Object]

glossaries.import.getImportOne(glossaryId, importId)

Get Glossary import status

Parameters

name	in	description	required	schema
glossaryId	path	Glossary Identifier.	true	[object Object]
importId	path	Import Identifier, consists of 36 characters.	true	[object Object]

groups.getMany([options])

List groups

Parameters

name	in	description	schema
parentId	query	Parent group Identifier	[object Object]
limit	query	Maximum number of items to retrieve.	[object Object]
offset	query	Starting offset in the collection.	[object Object]

groups.createOne()

Create group

Parameters

| | | |

groups.getOne(groupId)

Get group

Parameters

name	in	description	required	schema
groupId	path	A unique identifier for the group.	true	[object Object]

groups.deleteOne(groupId)

Delete Group

Parameters

name	in	description	required	schema
groupId	path	A unique identifier for the group.	true	[object Object]

groups.patchOne(groupId)

Update group

Parameters

name	in	description	required	schema
groupId	path	A unique identifier for the group.	true	[object Object]

projects.images.background.uploadOne(projectId)

Upload project background

Parameters

name	in	description	required	schema
projectId	path	Project Identifier.	true	[object Object]

projects.images.background.deleteOne(projectId)

Delete project background

Parameters

name	in	description	required	schema
projectId	path	Project Identifier.	true	[object Object]

projects.images.logo.uploadOne(projectId)

Upload project logo

Parameters

name	in	description	required	schema
projectId	path	Project Identifier.	true	[object Object]

projects.images.logo.deleteOne(projectId)

Delete project logo

Parameters

name	in	description	required	schema
projectId	path	Project Identifier.	true	[object Object]

issues.getMany(projectId, [options])

List issues

Parameters

name	in	description	required	schema
projectId	path	Project Identifier.	true	[object Object]
limit	query	Maximum number of items to retrieve.		[object Object]
offset	query	Starting offset in the collection.		[object Object]
type	query	Defines the issue type.		[object Object]
status	query	Defines the issue resolution status.		[object Object]

projects.issues.statistics.getMany(projectId, [options])

List issue statistics

Parameters

name	in	description	required	schema
projectId	path	Project Identifier.	true	[object Object]
limit	query	Maximum number of items to retrieve.		[object Object]
offset	query	Starting offset in the collection.		[object Object]
status	query	Defines the issue resolution status.		[object Object]
languageIds	query	Language identifier for filter.		[object Object]

languages.getMany([options])

List supported languages

Parameters

name	in	description	schema
limit	query	Maximum number of items to retrieve.	[object Object]
offset	query	Starting offset in the collection.	[object Object]

languages.getOne(languageId)

Get language

Parameters

name	in	description	required	schema
languageId	path	Language Identifier.	true	[object Object]

projects.preTranslates.preTranslate(projectId)

Pre-translate project files

Parameters

name	in	description	required	schema
projectId	path	Project Identifier.	true	[object Object]

projects.preTranslates.getTranslation(projectId, preTranslationId)

Get status of pre-translation

Parameters

name	in	description	required	schema
projectId	path	Project Identifier.	true	[object Object]
preTranslationId	path	Pre Translate Identifier.	true	[object Object]

storages.preview.getOne(storageId)

Get preview

Parameters

parameter	name	in	description	required	schema
StorageId	storageId	path	A unique identifier for the storage.	true	[object Object]

projects.branches.languages.progress.getMany(projectId, branchId)

Get branch translation progress

Parameters

name	in	description	required	schema
projectId	path	Project Identifier.	true	[object Object]
branchId	path	Branch Identifier.	true	[object Object]

projects.directories.languages.progress.getMany(projectId, directoryId)

Get directory translation progress

Parameters

name	in	description	required	schema
projectId	path	Project Identifier.	true	[object Object]
directoryId	path	Directory Identifier.	true	[object Object]

projects.exportReadyProgress.getMany(projectId, [options])

Get project translations export status

Parameters

name	in	description	required	schema
projectId	path	Project Identifier.	true	[object Object]
languageIds	query	Language identifier for filter.		[object Object]
limit	query	Maximum number of items to retrieve.		[object Object]
offset	query	Starting offset in the collection.		[object Object]

projects.files.languages.progress.getMany(projectId, fileId)

Get file translation progress

Parameters

name	in	description	required	schema
projectId	path	Project Identifier.	true	[object Object]
fileId	path	File Identifier.	true	[object Object]

projects.languages.progress.getMany(projectId)

Get project translation progress

Parameters

name	in	description	required	schema
projectId	path	Project Identifier.	true	[object Object]

projects.getMany([options])

List projects

Parameters

name	in	description	schema
groupId	query	Group Identifier	[object Object]
hasManagerAccess	query	Projects with Manager Access

•      0 - false
  

•      1 - true | [object Object] |
  

| limit | query | Maximum number of items to retrieve. | [object Object] | | offset | query | Starting offset in the collection. | [object Object] |

projects.createOne()

Create project

Parameters

| | | |

projects.getOne(projectId)

Get project

Parameters

name	in	description	required	schema
projectId	path	Project Identifier.	true	[object Object]

projects.deleteOne(projectId)

Delete project

Parameters

name	in	description	required	schema
projectId	path	Project Identifier.	true	[object Object]

projects.patchOne(projectId)

Update project

Parameters

name	in	description	required	schema
projectId	path	Project Identifier.	true	[object Object]

projects.pseudo.builds.getOne(projectId)

Build pseudo-translation files

Parameters

name	in	description	required	schema
projectId	path	Project Identifier.	true	[object Object]

projects.pseudo.builds.getStatus(projectId, pseudoTranslationBuildId)

View pseudo-translation build status

Parameters

name	in	description	required	schema
projectId	path	Project Identifier.	true	[object Object]
pseudoTranslationBuildId	path	Pseudo Translation Build Identifier, consists of 36 characters.	true	[object Object]

projects.pseudo.getDownloadLink(projectId)

Get pseudo-translation last build download link

Parameters

name	in	description	required	schema
projectId	path	Project Identifier.	true	[object Object]

projects.getQACheck(projectId, [options])

List QA check statistics

Parameters

name	in	description	required	schema
projectId	path	Project Identifier.	true	[object Object]
limit	query	Maximum number of items to retrieve.		[object Object]
offset	query	Starting offset in the collection.		[object Object]
languageIds	query	Language identifier for filter.		[object Object]

reportTypes.getMany(projectId, [options])

List supported reports

Parameters

name	in	description	required	schema
projectId	path	Project Identifier.	true	[object Object]
limit	query	Maximum number of items to retrieve.		[object Object]
offset	query	Starting offset in the collection.		[object Object]

projects.reports.createOne(projectId)

Generate a report

Parameters

name	in	description	required	schema
projectId	path	Project Identifier.	true	[object Object]

projects.reports.raw.exportOne(projectId, reportId)

Export project report raw

Parameters

name	in	description	required	schema
projectId	path	Project Identifier.	true	[object Object]
reportId	path	Report Identifier, consists of 36 characters	true	[object Object]

projects.files.revisions.getMany(projectId, fileId, [options])

List file revisions

Parameters

name	in	description	required	schema
projectId	path	Project Identifier.	true	[object Object]
fileId	path	File Identifier.	true	[object Object]
limit	query	Maximum number of items to retrieve.		[object Object]
offset	query	Starting offset in the collection.		[object Object]

projects.files.revisions.createOne(projectId, fileId)

Create a file revision

Parameters

name	in	description	required	schema
projectId	path	Project Identifier.	true	[object Object]
fileId	path	File Identifier.	true	[object Object]

projects.files.revisions.getOne(projectId, fileId, revision)

Get a file revision

Parameters

name	in	description	required	schema
projectId	path	Project Identifier.	true	[object Object]
fileId	path	File Identifier.	true	[object Object]
revision	path	Revision number.	true	[object Object]

projects.screenshots.getMany(projectId, [options])

List screenshots

Parameters

name	in	description	required	schema
projectId	path	Project Identifier.	true	[object Object]
limit	query	Maximum number of items to retrieve.		[object Object]
offset	query	Starting offset in the collection.		[object Object]

projects.screenshots.createOne(projectId)

Create a screenshot

Parameters

name	in	description	required	schema
projectId	path	Project Identifier.	true	[object Object]

projects.screenshots.getOne(projectId, screenshotId)

Get a screenshot

Parameters

name	in	description	required	schema
projectId	path	Project Identifier.	true	[object Object]
screenshotId	path	Screenshot Identifier.	true	[object Object]

projects.screenshots.replaceOne(projectId, screenshotId)

Replace a screenshot

Parameters

name	in	description	required	schema
projectId	path	Project Identifier.	true	[object Object]
screenshotId	path	Screenshot Identifier.	true	[object Object]

projects.screenshots.deleteOne(projectId, screenshotId)

Delete a screenshot

Parameters

name	in	description	required	schema
projectId	path	Project Identifier.	true	[object Object]
screenshotId	path	Screenshot Identifier.	true	[object Object]

projects.screenshots.patchOne(projectId, screenshotId)

Update a screenshot

Parameters

name	in	description	required	schema
projectId	path	Project Identifier.	true	[object Object]
screenshotId	path	Screenshot Identifier.	true	[object Object]

projects.screenshots.tags.getMany(projectId, screenshotId, [options])

List screenshot tags

Parameters

name	in	description	required	schema
projectId	path	Project Identifier.	true	[object Object]
screenshotId	path	Screenshot Identifier.	true	[object Object]
limit	query	Maximum number of items to retrieve.		[object Object]
offset	query	Starting offset in the collection.		[object Object]

projects.screenshots.tags.replaceAll(projectId, screenshotId)

Replace all screenshot tags

Parameters

name	in	description	required	schema
projectId	path	Project Identifier.	true	[object Object]
screenshotId	path	Screenshot Identifier.	true	[object Object]

projects.screenshots.tags.createOne(projectId, screenshotId)

Add a tag

Parameters

name	in	description	required	schema
projectId	path	Project Identifier.	true	[object Object]
screenshotId	path	Screenshot Identifier.	true	[object Object]

projects.screenshots.tags.deleteAll(projectId, screenshotId)

Delete all screenshot tags

Parameters

name	in	description	required	schema
projectId	path	Project Identifier.	true	[object Object]
screenshotId	path	Screenshot Identifier.	true	[object Object]

projects.screenshots.tags.getOne(projectId, screenshotId, tagId)

Get a tag

Parameters

name	in	description	required	schema
projectId	path	Project Identifier.	true	[object Object]
screenshotId	path	Screenshot Identifier.	true	[object Object]
tagId	path	Screenshot’s tag identifier. Use List screenshots or Get screenshots method to get the tag identifier..	true	[object Object]

projects.screenshots.tags.deleteOne(projectId, screenshotId, tagId)

Delete a tag

Parameters

name	in	description	required	schema
projectId	path	Project Identifier.	true	[object Object]
screenshotId	path	Screenshot Identifier.	true	[object Object]
tagId	path	Screenshot’s tag identifier. Use List screenshots or Get screenshots method to get the tag identifier..	true	[object Object]

projects.screenshots.tags.patchOne(projectId, screenshotId, tagId)

Update a tag

Parameters

name	in	description	required	schema
projectId	path	Project Identifier.	true	[object Object]
screenshotId	path	Screenshot Identifier.	true	[object Object]
tagId	path	Screenshot’s tag identifier. Use List screenshots or Get screenshots method to get the tag identifier..	true	[object Object]

projects.settings.getOne(projectId)

Get project settings

Parameters

name	in	description	required	schema
projectId	path	Project Identifier.	true	[object Object]

projects.settings.patchOne(projectId)

Update project settings

Parameters

name	in	description	required	schema
projectId	path	Project Identifier.	true	[object Object]

storages.getAll(storageId)

List user storages

Parameters

parameter	name	in	description	required	schema
StorageId	storageId	path	A unique identifier for the storage.	true	[object Object]

storages.uploadOne()

Upload a file

Parameters

name	in	description	required	schema
Content-Type	header	File content type	true	[object Object]

storages.getOne(storageId)

Get storage

Parameters

parameter	name	in	description	required	schema
StorageId	storageId	path	A unique identifier for the storage.	true	[object Object]

storages.deleteOne(storageId)

Delete Storage

Parameters

parameter	name	in	description	required	schema
StorageId	storageId	path	A unique identifier for the storage.	true	[object Object]

projects.pseudo.listProjectStrings(projectId, [options])

List project strings

Parameters

name	in	description	required	schema
projectId	path	Project Identifier.	true	[object Object]
fileId	query	File Identifier.		[object Object]
limit	query	Maximum number of items to retrieve.		[object Object]
offset	query	Starting offset in the collection.		[object Object]

projects.strings.createOne(projectId)

Create a project string

Parameters

name	in	description	required	schema
projectId	path	Project Identifier.	true	[object Object]

projects.strings.getOne(projectId, stringId)

Get a project string

Parameters

name	in	description	required	schema
projectId	path	Project Identifier.	true	[object Object]
stringId	path	String Identifier.	true	[object Object]

projects.strings.deleteOne(projectId, stringId)

Delete a project string

Parameters

name	in	description	required	schema
projectId	path	Project Identifier.	true	[object Object]
stringId	path	String Identifier.	true	[object Object]

projects.strings.patchOne(projectId, stringId)

Update a project string

Parameters

name	in	description	required	schema
projectId	path	Project Identifier.	true	[object Object]
stringId	path	String Identifier.	true	[object Object]

projects.tasks.getMany(projectId, [options])

List tasks

Parameters

name	in	description	required	schema
projectId	path	Project Identifier.	true	[object Object]
limit	query	Maximum number of items to retrieve.		[object Object]
offset	query	Starting offset in the collection.		[object Object]

projects.tasks.createOne(projectId)

Create a task

Parameters

name	in	description	required	schema
projectId	path	Project Identifier.	true	[object Object]

projects.tasks.getOne(projectId, taskId)

Get a task

Parameters

name	in	description	required	schema
projectId	path	Project Identifier.	true	[object Object]
taskId	path	Task Identifier.	true	[object Object]

projects.tasks.deleteOne(projectId, taskId)

Delete a task

Parameters

name	in	description	required	schema
projectId	path	Project Identifier.	true	[object Object]
taskId	path	Task Identifier.	true	[object Object]

projects.tasks.patchOne(projectId, taskId)

Update a task

Parameters

name	in	description	required	schema
projectId	path	Project Identifier.	true	[object Object]
taskId	path	Task Identifier.	true	[object Object]

projects.tasks.statistics.getMany(projectId, [options])

List of task statistic

Parameters

name	in	description	required	schema
projectId	path	Project Identifier.	true	[object Object]
limit	query	Maximum number of items to retrieve.		[object Object]
offset	query	Starting offset in the collection.		[object Object]
status	query	Defines the task resolution status:

• 0 - todo
• 1 - in_progress
• 2 - done
• 3 - closed
• 4 - archived
• 5 - overdue | | [object Object] | | languageIds | query | Language identifier for filter. | | [object Object] |

glossaries.terms.getMany(glossaryId, [options])

List terms

Parameters

name	in	description	required	schema
glossaryId	path	Glossary Identifier.	true	[object Object]
userId	query	User Identifier.		[object Object]
limit	query	Maximum number of items to retrieve.		[object Object]
offset	query	Starting offset in the collection.		[object Object]

glossary.terms.createOne(glossaryId)

Create a term

Parameters

name	in	description	required	schema
glossaryId	path	Glossary Identifier.	true	[object Object]

glossaries.terms.getOne(glossaryId, termId)

Get a term

Parameters

name	in	description	required	schema
glossaryId	path	Glossary Identifier.	true	[object Object]
termId	path	Term Identifier.	true	[object Object]

glossaries.terms.deleteOne(glossaryId, termId)

Delete a term

Parameters

name	in	description	required	schema
glossaryId	path	Glossary Identifier.	true	[object Object]
termId	path	Term Identifier.	true	[object Object]

glossaries.terms.patchOne(glossaryId, termId)

Update a term

Parameters

name	in	description	required	schema
glossaryId	path	Glossary Identifier.	true	[object Object]
termId	path	Term Identifier.	true	[object Object]

tms.getList([options])

List TMs

Parameters

name	in	description	required	schema
groupId	query	A unique identifier for the group.	true	[object Object]
limit	query	Maximum number of items to retrieve.		[object Object]
offset	query	Starting offset in the collection.		[object Object]

tms.uploadOne()

Create a TM

Parameters

| | | |

tms.getOne(tmId)

Get a TM

Parameters

name	in	description	required	schema
tmId	path	TM Identifier.	true	[object Object]

tms.deleteOne(tmId)

Delete a TM

Parameters

name	in	description	required	schema
tmId	path	TM Identifier.	true	[object Object]

tms.patchOne(tmId)

Update a TM

Parameters

name	in	description	required	schema
tmId	path	TM Identifier.	true	[object Object]

tms.downloadOne(tmId, [options])

Get a TM download link

Parameters

name	in	description	required	schema
tmId	path	TM Identifier.	true	[object Object]
sourceLanguageId	query	Defines a source language in the language pair.		[object Object]
targetLanguageId	query	Defines a target language in the language pair.		[object Object]
format	query	Defines the format of TMs file. Default is tmx.		[object Object]

tms.exportOne(tmId)

Start TM export

Parameters

name	in	description	required	schema
tmId	path	TM Identifier.	true	[object Object]

tms.export.getOne(tmId, exportId)

Get TM export status

Parameters

name	in	description	required	schema
tmId	path	TM Identifier.	true	[object Object]
exportId	path	Export Identifier, consists of 36 characters.	true	[object Object]

tms.upload(tmId)

Upload a TM

Parameters

name	in	description	required	schema
tmId	path	TM Identifier.	true	[object Object]

tms.upload.jobByTm(tmId, importId)

Get TM import status

Parameters

name	in	description	required	schema
tmId	path	TM Identifier.	true	[object Object]
importId	path	Import Identifier, consists of 36 characters.	true	[object Object]

projects.translations.builds.getList([options])

List project builds

Parameters

name	in	description	schema
branchId	query	Filter builds by branchId	[object Object]
limit	query	Maximum number of items to retrieve.	[object Object]
offset	query	Starting offset in the collection.	[object Object]

projects.translations.builds.init(projectId)

Build transaltions

Parameters

name	in	description	required	schema
projectId	path	Project Identifier.	true	[object Object]

projects.translations.builds.getDownloadLink(projectId, buildId)

Download translations URL

Parameters

name	in	description	required	schema
projectId	path	Project Identifier.	true	[object Object]
buildId	path	Project Build Identifier.	true	[object Object]

projects.translations.builds.getOne(projectId, buildId)

Get project build info

Parameters

name	in	description	required	schema
projectId	path	Project Identifier.	true	[object Object]
buildId	path	Project Build Identifier.	true	[object Object]

projects.translations.builds.cancel(projectId, buildId)

Cancel project build

Parameters

name	in	description	required	schema
projectId	path	Project Identifier.	true	[object Object]
buildId	path	Project Build Identifier.	true	[object Object]

projects.translations.initByLanguage(projectId, languageId)

Upload translation for a specified language

Parameters

name	in	description	required	schema
projectId	path	Project Identifier.	true	[object Object]
languageId	path	Language Identifier.	true	[object Object]

projects.webhooks.getMany(projectId, [options])

List webhooks

Parameters

name	in	description	required	schema
projectId	path	Project Identifier.	true	[object Object]
limit	query	Maximum number of items to retrieve.		[object Object]
offset	query	Starting offset in the collection.		[object Object]

projects.webhooks.createOne(projectId)

Create a webhook

Parameters

name	in	description	required	schema
projectId	path	Project Identifier.	true	[object Object]

projects.webhooks.getOne(projectId, webhookId)

Get a webhook

Parameters

name	in	description	required	schema
projectId	path	Project Identifier.	true	[object Object]
webhookId	path	Webhook Identifier.	true	[object Object]

projects.webhooks.deleteOne(projectId, webhookId)

Delete a webhook

Parameters

name	in	description	required	schema
projectId	path	Project Identifier.	true	[object Object]
webhookId	path	Webhook Identifier.	true	[object Object]

projects.webhooks.patchOne(projectId, webhookId)

Update a webhook

Parameters

name	in	description	required	schema
projectId	path	Project Identifier.	true	[object Object]
webhookId	path	Webhook Identifier.	true	[object Object]