Introduction to API 3.0
Outdated article
All developer documentation has moved to Transifex Developer Hub. Read this article here.
These new API endpoints are currently declared Generally Available, ie. all modifications from this point forward will be backwards compatible. They require authentication with a bearer token. A detailed documentation guide for this new stable API version can be found here. On the current page, you can find only a brief summary of what has been implemented.
Users
- Get user details [GET]. Get the details of the user specified by the required path parameter
user_id
.
Organizations
Represents Transifex's organizations. Every user can be a member of one or multiple organizations. Only the organizations the authenticated user belongs to will appear here.
- List of organizations [GET]. Get a list of all the Organizations the user belongs to.
- Get organization details [GET]. Get the details of an Organization.
Languages
- List languages [GET]. Get information for all the supported languages.
- Get language details [GET]. Get information for a specific supported language.
Projects
Represents projects, as used within Transifex. Each project belongs to an organization
- List projects [GET]
- Create a Project [POST]
- Delete Project [Del]
- Get project details [GET]
- Update a Project [PATCH]
- List project languages [GET]
- Get project maintainers [GET]
- Delete language relationship [DEL]
- List language relationships [GET]
- Update language relationships [PATCH]
- Create language relationship [POST]
- Remove maintainers from project [DEL]
- Get project maintainer relationships [GET]
- Update project maintainers [PATCH]
- Add maintainers to project [POST]
- Get team relationship [GET]
- Update team relationship [PATCH]
Project Webhooks
- List project webhooks [GET]
- Create project webhook [POST]
- Delete project webhook [DEL]
- Get project webhooks details [GET]
- Update project webhook [PATCH]
Resources
Represents a resource that holds source strings. Resources belong to a specific project in Transifex
- List resources [GET]. Get a list of all resources (in a specific project)
- Create new resource [POST]. Making a POST request to this endpoint creates a resource without content. This step is performed synchronously so you don't have to verify that resource creation succeeded afterwards. In order to upload content, see the /resource_strings_async_uploads endpoint.
- Delete resource [DEL]. Delete a resource of a project.
- Get resource details [GET]. Get details of a specific resource.
- Update resource [PATCH]. Update details of a resource.
Resource Strings
- Get resource strings collection [GET]
- Get the details of a specific resource string. [GET]. Get the details of a specific resource string
- Update resource string metadata [PATCH]
- Create one or more resource strings [POST]. Applies only to fileless resources
- Delete a resource string [DELETE]. Applies only to fileless resources
- Delete resource strings in bulk [DELETE]. Applies only to fileless resources
- Create a source file download action [POST]
- Get resource strings download status [GET]
- Upload a new source file for a resource [POST]. The response represents the file upload job.
- Get source upload [GET]. With this endpoint, you can inquire about the status of an upload job.
Resource String Comments
- List resource string comments [GET]. Get a list of all resource string comments for an organization. You can further narrow down the list using the available filters.
- Create resource string comments [POST]. Create a new resource string comment. This needs to be associated with a resource string and a target language.
- Delete resource string comment [DELETE]. Delete a resource string comment
- Get resource string comment [GET]. Get details for a comment related to a specific resource string
- Update resource string comment [PATCH]. Change a resource string comment. You can update it's status, change it to an issue or edit the description.
I18n Formats
- List i18n formats [GET]. Get information for all the supported i18n formats
Context Screenshots
- Get project context screenshot map collection [GET]
- Upload a new context screenshot map to a resource_string [POST]
- Delete screenshot map [DEL]
- Get context screenshot map [GET]
- Get project context screenshot collection [GET]
- Delete screenshot [DEL]
- Get context screenshot [GET]
- Update context screenshot [PATCH]
- Upload a new context screenshot file to a project [POST]
Activity Reports
- Create an organization activity report file download action [POST]
- Get organization activity report download status [GET]
- Create a project activity report file download action [POST]
- Get project activity report download status [GET]
- Create a resource activity report file download action [POST]
- Get resource activity report download status [GET]
- Create a team activity report file download action [POST]
- Get team activity report download status [GET]
Team Memberships
- List team memberships [GET]
- Create a new team membership [POST]
- Delete team membership [DEL]
- Get single team membership [GET]
- Update a membership's role [PATCH]
Teams
- List teams [GET]
- Create a Team [POST]
- Delete team [DEL]
- Get team detail [GET]
- Update a team [PATCH]
- Get team managers [GET]
- Remove managers from team [DEL]
- Get team manager relationships [GET]
- Update team managers [PATCH]
- Add managers to team [POST]