openapi: 3.0.1 info: contact: email: support@transifex.com name: Transifex Support description: "
\n
\n\n# Introduction\n\nThis API is based on **{json:api}**.\n\n{json:api} is a specification that follows shared conventions and standards. This specification enables API discoverability and partial\nself-descriptiveness through conventions. The Json Api specification exposes resources and their relationships representations with\nunique uris and all CRUD operations are performed on those endpoints. With it's simplified approach it assists the API uniformity.\n\nRead more: https://jsonapi.org/\n\nAdditionally, this API is defined using OpenAPI (ex Swagger). This means that you can easily:\n* Generate clients in your preferred: https://swagger.io/tools/swagger-codegen/\n* Download the specification file (see above) and use it in clients like Postman etc\n\n
\n
\n\n# Pagination\n\nAll list endpoints include pagination to guarantee performant responses. Those endpoints will return `next` and `previous` links in the\nresponse payload (`links` section). The client does not have to construct any pagination specific URLs or headers, just follow those\nlinks.\n\nPage size is fixed to 150 items per page.\n\n
\n
\n\n# Content Negotiation\n\nThe basic media type for the API is `application/vnd.api+json`. If you want to execute a request that includes data (`POST`, `PATCH`, `DELETE`)\nyou should include this media type in the `Content-Type` header. The only case where a different `Content-Type` header will be accepted is for\nendpoints that can accept file like objects where the media type used should be `multipart/form-data`.\n\nThe base media type this API responds is `application/vnd.api+json`. To retrieve the data in this media type you should include it in the `Accept`\nheader. The only case where the server will return another media type is for endpoint that return file like objects.\nIn this case the media type used should be `*/*` and the server will prioritize the negotiation to the media type dictated from the file.\nNote that `application/vnd.api+json` will be also available for accept header in these cases and will return a JSON serialized representation of the file.\n\nRead more here: https://jsonapi.org/format/#content-negotiation\n\n# File Uploads\n\nThere are three different methods for uploading file content to Transifex:\n* Using Content-Type `application/vnd.api+json` the content must\n be JSON serializable.\n - For content that is directly JSON serializable you can dump the content\n of the file directly and set the `content_encoding` attribute to `text`.\n - For any content, even if it's not JSON serializable (eg .xlsx, .idml or .docx file extensions),\n you can encode the file using the `base64` encoding and set the `content_encoding` attribute to `base64`.\n* Using Content-Type `multipart/form-data` the content can be any raw file, and can\n be send without further processing.\n\n# Asynchronous Processing\n\nAsynchronous operations are triggered via a POST request. The response status in such cases is 202 Accepted, with a link in the Content-Location header.\nTo check the status of the operation, a client can send a request to the location given earlier.\nAn optional `callback_url` can be provided when the asynchronous operation is triggered. If such url is provided, upon completion\na HTTP POST request is executed containing all information required to identify the specific operation:\n\nExample request:\n```\nPOST callback_url HTTP/1.1\nContent-Type: application/json\n\n{\n \"data\": {\n \"type\": resource_strings_async_downloads\",\n \"id\": \"xxxxxxxxx\",\n \"attributes\": {\n \"location\": \"https://rest.api.transifex.com/resource_strings_async_downloads/xxxxxxxxx\",\n \"status\": \"succeeded\"\n }\n }\n}\n```\n\n# Restrictions\n\nThe following Plan based restrictions apply:\n* [Activity Reports](#tag/Activity-Reports) are available to Premium and up\n* [XLIFF export](#tag/Resource-Translations/paths/~1resource_translations_async_downloads/post) is available to Premium and up.\n* [Screenshots](#tag/Context-Screenshots) are available to Premium and up\n\n# Rate Limit\n\nTo maintain optimal performance and availability of the API, we limit the request rate to 500\nrequests/min or 30,000 requests / 5 minutes / IP. Polling endpoints like\n`resource_translations_async_downloads/{resource_translations_async_download_id}` and\n`resource_strings_async_downloads/{resource_strings_async_download_id}` have a rate limit of 1,200 requests/min.\nOnce past the respective limit, requests will be throttled and you will get a 429 Throttled response.\n\n\nExample response:\n```\n{\n \"errors\": [\n {\n \"code\": \"Throttled\",\n \"detail\": \"Request was throttled. Expected available in 60 seconds.\",\n \"status\": \"429\",\n \"title\": \"Throttled\"\n }\n ]\n}\n```\n\n# Authentication\n\n" title: Transifex Activity Reports Teams API version: '3.0' x-logo: altText: Transifex logo backgroundColor: '#FFFFFF' url: transifex-blue-logo.svg servers: - url: https://rest.api.transifex.com security: - bearerAuth: [] tags: - name: Teams paths: /teams: get: description: Get the list of teams that belong to a single organization. parameters: - description: Filter results by an organization in: query name: filter[organization] required: true schema: description: Organization identifier. example: o:org_123 pattern: ^o:[a-zA-Z0-9._-]+$ type: string - description: 'The cursor used for pagination. The value of the cursor must be retrieved from pagination links included in previous responses; you should not attempt to write them on your own. ' in: query name: page[cursor] schema: type: string - description: The slug of the team to get details in: query name: filter[slug] required: false schema: pattern: ^[a-zA-Z0-9._-]+$ type: string - in: query name: filter[name] required: false schema: type: string responses: '200': content: application/vnd.api+json: schema: additionalProperties: false properties: data: description: List of Project objects. items: additionalProperties: false properties: attributes: additionalProperties: false description: Team attributes. properties: auto_join: description: Whether members will be allowed in the team automatically type: boolean cla: description: The CLA members will need to agree to before joining type: string cla_required: description: Whether members will need to agree to a CLA before joining type: boolean datetime_created: example: XXXX-XX-XXTXX:XX:XXZ format: date-time type: string name: description: The name of the team type: string slug: description: The slug of the Team. example: team_slug maxLength: 255 pattern: ^[a-zA-Z0-9_-]+$ type: string required: - name - slug - auto_join - cla_required - cla - datetime_created type: object id: description: Team identifier. example: o:organization_slug:t:team_slug pattern: ^o:[a-zA-Z0-9._-]+:t:[a-zA-Z0-9_-]+$ type: string links: additionalProperties: false properties: self: example: /teams/o:organization_slug:t:team_slug type: string required: - self type: object relationships: additionalProperties: false description: Team relationships properties: managers: additionalProperties: false description: Managers object. properties: links: additionalProperties: false properties: related: description: Team-managers list link example: /teams/o:organization_slug:t:team_slug/managers type: string self: description: Team-manager relationship link example: /teams/o:organization_slug:t:team_slug/relationships/managers type: string required: - self - related type: object required: - links type: object organization: additionalProperties: false description: Organization object. properties: data: additionalProperties: false description: Organization data container. properties: id: description: Organization identifier. example: o:org_123 pattern: ^o:[a-zA-Z0-9._-]+$ type: string type: enum: - organizations type: string required: - type - id type: object links: additionalProperties: false properties: related: description: Organization details link. example: /organizations/o:organization_slug type: string required: - related type: object required: - links - data type: object required: - organization type: object type: enum: - teams type: string required: - type - id - attributes - relationships - links type: object type: array links: additionalProperties: false description: Pagination links. properties: next: description: Link to the next page of results. example: /teams?filter[organization]=o:organization_slug&page[cursor]=XXX nullable: true type: string previous: description: Link to the previous page of results. example: /'teams?filter[organization]=o:organization_slug&page[cursor]=XXX' nullable: true type: string self: description: Link to the current page of results example: /teams?filter[organization]=o:organization_slug type: string required: - self - next - previous type: object required: - data - links type: object description: Get a list of all the teams for a given organization '400': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: true properties: code: example: forbidden type: string detail: example: You do not have permissions to perform this action type: string status: example: '403' type: string title: example: Operation not allowed type: string type: object type: array type: object description: Forbidden '401': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: unauthorized type: string detail: example: Please verify your credentials type: string status: example: '401' type: string title: example: Unauthorized type: string type: object type: array type: object description: Unauthorized '403': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: true properties: code: example: forbidden type: string detail: example: You do not have permissions to perform this action type: string status: example: '403' type: string title: example: Operation not allowed type: string type: object type: array type: object description: Forbidden '404': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: true properties: code: example: forbidden type: string detail: example: You do not have permissions to perform this action type: string status: example: '403' type: string title: example: Operation not allowed type: string type: object type: array type: object description: Forbidden '500': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: server error type: string detail: example: Something went wrong, please try again type: string status: example: '500' type: string title: example: Something went wrong type: string type: object type: array type: object description: Internal Error summary: List teams tags: - Teams x-released: true post: requestBody: content: application/vnd.api+json: schema: additionalProperties: false properties: data: additionalProperties: false description: Create team body request details. properties: attributes: additionalProperties: false properties: auto_join: description: Whether members will be allowed in the team automatically type: boolean cla: description: The CLA members will need to agree to before joining type: string cla_required: description: Whether members will need to agree to a CLA before joining type: boolean name: description: The name of the team type: string required: - name type: object relationships: additionalProperties: false description: Team parent relationships. properties: organization: additionalProperties: false description: The `organization` the created team should belong to. properties: data: additionalProperties: false description: Organization data container. properties: id: description: Organization identifier. example: o:org_123 pattern: ^o:[a-zA-Z0-9._-]+$ type: string type: enum: - organizations type: string required: - type - id type: object required: - data type: object required: - organization type: object type: enum: - teams type: string required: - type - attributes - relationships type: object required: - data type: object required: true responses: '200': content: application/vnd.api+json: schema: additionalProperties: false properties: data: additionalProperties: false properties: attributes: additionalProperties: false description: Team attributes. properties: auto_join: description: Whether members will be allowed in the team automatically type: boolean cla: description: The CLA members will need to agree to before joining type: string cla_required: description: Whether members will need to agree to a CLA before joining type: boolean datetime_created: example: XXXX-XX-XXTXX:XX:XXZ format: date-time type: string name: description: The name of the team type: string slug: description: The slug of the Team. example: team_slug maxLength: 255 pattern: ^[a-zA-Z0-9_-]+$ type: string required: - name - slug - auto_join - cla_required - cla - datetime_created type: object id: description: Team identifier. example: o:organization_slug:t:team_slug pattern: ^o:[a-zA-Z0-9._-]+:t:[a-zA-Z0-9_-]+$ type: string links: additionalProperties: false properties: self: example: /teams/o:organization_slug:t:team_slug type: string required: - self type: object relationships: additionalProperties: false description: Team relationships properties: managers: additionalProperties: false description: Managers object. properties: links: additionalProperties: false properties: related: description: Team-managers list link example: /teams/o:organization_slug:t:team_slug/managers type: string self: description: Team-manager relationship link example: /teams/o:organization_slug:t:team_slug/relationships/managers type: string required: - self - related type: object required: - links type: object organization: additionalProperties: false description: Organization object. properties: data: additionalProperties: false description: Organization data container. properties: id: description: Organization identifier. example: o:org_123 pattern: ^o:[a-zA-Z0-9._-]+$ type: string type: enum: - organizations type: string required: - type - id type: object links: additionalProperties: false properties: related: description: Organization details link. example: /organizations/o:organization_slug type: string required: - related type: object required: - links - data type: object required: - organization type: object type: enum: - teams type: string required: - type - id - attributes - relationships - links type: object required: - data type: object description: Successful Response. '400': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: invalid type: string detail: example: Enter a valid `name` consisting of Unicode letters, numbers, underscores, or hyphens type: string source: anyOf: - properties: pointer: example: /data/attributes/name type: string - properties: parameter: example: ?filter[foo] type: string status: example: '400' type: string title: example: Field `name` is invalid type: string type: object type: array type: object description: Invalid '403': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: true properties: code: example: forbidden type: string detail: example: You do not have permissions to perform this action type: string status: example: '403' type: string title: example: Operation not allowed type: string type: object type: array type: object description: Forbidden '404': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: properties: code: example: not found type: string detail: example: Object not found. It may have been deleted or not been created yet type: string status: example: '404' type: string title: example: Object not found type: string type: object type: array type: object description: Not found '409': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: conflict type: string detail: example: Value `some_field_value` already exists type: string source: additionalProperties: false properties: pointer: example: /data/attributes/some_field type: string type: object status: example: '409' type: string title: example: Field `some_field` conflicted type: string type: object type: array type: object description: Conflict summary: Create a Team tags: - Teams x-released: true /teams/{team_id}: parameters: - description: 'Format of composite id should be `o:organization_slug:t:team_slug`. ' in: path name: team_id required: true schema: description: Team identifier. example: o:organization_slug:t:team_slug pattern: ^o:[a-zA-Z0-9._-]+:t:[a-zA-Z0-9_-]+$ type: string delete: description: Delete a team. responses: '204': description: No Content. '401': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: unauthorized type: string detail: example: Please verify your credentials type: string status: example: '401' type: string title: example: Unauthorized type: string type: object type: array type: object description: Unauthorized '403': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: true properties: code: example: forbidden type: string detail: example: You do not have permissions to perform this action type: string status: example: '403' type: string title: example: Operation not allowed type: string type: object type: array type: object description: Forbidden '404': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: properties: code: example: not found type: string detail: example: Object not found. It may have been deleted or not been created yet type: string status: example: '404' type: string title: example: Object not found type: string type: object type: array type: object description: Not found '409': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: conflict type: string detail: example: Value `some_field_value` already exists type: string source: additionalProperties: false properties: pointer: example: /data/attributes/some_field type: string type: object status: example: '409' type: string title: example: Field `some_field` conflicted type: string type: object type: array type: object description: Conflict '500': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: server error type: string detail: example: Something went wrong, please try again type: string status: example: '500' type: string title: example: Something went wrong type: string type: object type: array type: object description: Internal Error summary: Delete team tags: - Teams x-released: true get: description: Get the details of a single team. responses: '200': content: application/vnd.api+json: schema: additionalProperties: false properties: data: additionalProperties: false properties: attributes: additionalProperties: false description: Team attributes. properties: auto_join: description: Whether members will be allowed in the team automatically type: boolean cla: description: The CLA members will need to agree to before joining type: string cla_required: description: Whether members will need to agree to a CLA before joining type: boolean datetime_created: example: XXXX-XX-XXTXX:XX:XXZ format: date-time type: string name: description: The name of the team type: string slug: description: The slug of the Team. example: team_slug maxLength: 255 pattern: ^[a-zA-Z0-9_-]+$ type: string required: - name - slug - auto_join - cla_required - cla - datetime_created type: object id: description: Team identifier. example: o:organization_slug:t:team_slug pattern: ^o:[a-zA-Z0-9._-]+:t:[a-zA-Z0-9_-]+$ type: string links: additionalProperties: false properties: self: example: /teams/o:organization_slug:t:team_slug type: string required: - self type: object relationships: additionalProperties: false description: Team relationships properties: managers: additionalProperties: false description: Managers object. properties: links: additionalProperties: false properties: related: description: Team-managers list link example: /teams/o:organization_slug:t:team_slug/managers type: string self: description: Team-manager relationship link example: /teams/o:organization_slug:t:team_slug/relationships/managers type: string required: - self - related type: object required: - links type: object organization: additionalProperties: false description: Organization object. properties: data: additionalProperties: false description: Organization data container. properties: id: description: Organization identifier. example: o:org_123 pattern: ^o:[a-zA-Z0-9._-]+$ type: string type: enum: - organizations type: string required: - type - id type: object links: additionalProperties: false properties: related: description: Organization details link. example: /organizations/o:organization_slug type: string required: - related type: object required: - links - data type: object required: - organization type: object type: enum: - teams type: string required: - type - id - attributes - relationships - links type: object required: - data type: object description: Successful Response. '400': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: true properties: code: example: forbidden type: string detail: example: You do not have permissions to perform this action type: string status: example: '403' type: string title: example: Operation not allowed type: string type: object type: array type: object description: Forbidden '401': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: unauthorized type: string detail: example: Please verify your credentials type: string status: example: '401' type: string title: example: Unauthorized type: string type: object type: array type: object description: Unauthorized '403': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: true properties: code: example: forbidden type: string detail: example: You do not have permissions to perform this action type: string status: example: '403' type: string title: example: Operation not allowed type: string type: object type: array type: object description: Forbidden '404': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: properties: code: example: not found type: string detail: example: Object not found. It may have been deleted or not been created yet type: string status: example: '404' type: string title: example: Object not found type: string type: object type: array type: object description: Not found '500': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: server error type: string detail: example: Something went wrong, please try again type: string status: example: '500' type: string title: example: Something went wrong type: string type: object type: array type: object description: Internal Error summary: Get team detail tags: - Teams x-released: true patch: requestBody: content: application/vnd.api+json: schema: additionalProperties: false properties: data: additionalProperties: false description: Update team body request details. properties: attributes: additionalProperties: false minProperties: 1 properties: auto_join: description: Whether members will be allowed in the team automatically type: boolean cla: description: The CLA members will need to agree to before joining type: string cla_required: description: Whether members will need to agree to a CLA before joining type: boolean name: description: The name of the team type: string type: object id: description: Team identifier. example: o:organization_slug:t:team_slug pattern: ^o:[a-zA-Z0-9._-]+:t:[a-zA-Z0-9_-]+$ type: string type: enum: - teams type: string required: - id - type - attributes type: object required: - data type: object required: true responses: '200': content: application/vnd.api+json: schema: additionalProperties: false properties: data: description: List of team objects. items: additionalProperties: false properties: attributes: additionalProperties: false description: Team attributes. properties: auto_join: description: Whether members will be allowed in the team automatically type: boolean cla: description: The CLA members will need to agree to before joining type: string cla_required: description: Whether members will need to agree to a CLA before joining type: boolean datetime_created: example: XXXX-XX-XXTXX:XX:XXZ format: date-time type: string name: description: The name of the team type: string slug: description: The slug of the Team. example: team_slug maxLength: 255 pattern: ^[a-zA-Z0-9_-]+$ type: string required: - name - slug - auto_join - cla_required - cla - datetime_created type: object id: description: Team identifier. example: o:organization_slug:t:team_slug pattern: ^o:[a-zA-Z0-9._-]+:t:[a-zA-Z0-9_-]+$ type: string links: additionalProperties: false properties: self: example: /teams/o:organization_slug:t:team_slug type: string required: - self type: object relationships: additionalProperties: false description: Team relationships properties: managers: additionalProperties: false description: Managers object. properties: links: additionalProperties: false properties: related: description: Team-managers list link example: /teams/o:organization_slug:t:team_slug/managers type: string self: description: Team-manager relationship link example: /teams/o:organization_slug:t:team_slug/relationships/managers type: string required: - self - related type: object required: - links type: object organization: additionalProperties: false description: Organization object. properties: data: additionalProperties: false description: Organization data container. properties: id: description: Organization identifier. example: o:org_123 pattern: ^o:[a-zA-Z0-9._-]+$ type: string type: enum: - organizations type: string required: - type - id type: object links: additionalProperties: false properties: related: description: Organization details link. example: /organizations/o:organization_slug type: string required: - related type: object required: - links - data type: object required: - organization type: object type: enum: - teams type: string required: - type - id - attributes - relationships - links type: object required: - data type: object description: Successful response. '400': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: invalid type: string detail: example: Enter a valid `name` consisting of Unicode letters, numbers, underscores, or hyphens type: string source: anyOf: - properties: pointer: example: /data/attributes/name type: string - properties: parameter: example: ?filter[foo] type: string status: example: '400' type: string title: example: Field `name` is invalid type: string type: object type: array type: object description: Invalid '401': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: unauthorized type: string detail: example: Please verify your credentials type: string status: example: '401' type: string title: example: Unauthorized type: string type: object type: array type: object description: Unauthorized '403': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: true properties: code: example: forbidden type: string detail: example: You do not have permissions to perform this action type: string status: example: '403' type: string title: example: Operation not allowed type: string type: object type: array type: object description: Forbidden '404': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: properties: code: example: not found type: string detail: example: Object not found. It may have been deleted or not been created yet type: string status: example: '404' type: string title: example: Object not found type: string type: object type: array type: object description: Not found '409': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: conflict type: string detail: example: Value `some_field_value` already exists type: string source: additionalProperties: false properties: pointer: example: /data/attributes/some_field type: string type: object status: example: '409' type: string title: example: Field `some_field` conflicted type: string type: object type: array type: object description: Conflict '500': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: server error type: string detail: example: Something went wrong, please try again type: string status: example: '500' type: string title: example: Something went wrong type: string type: object type: array type: object description: Internal Error summary: Update a team tags: - Teams x-released: true /teams/{team_id}/managers: description: Team managers. parameters: - description: 'Format of composite id should be `o:organization_slug:t:team_slug`. ' in: path name: team_id required: true schema: description: Team identifier. example: o:organization_slug:t:team_slug pattern: ^o:[a-zA-Z0-9._-]+:t:[a-zA-Z0-9_-]+$ type: string - description: 'The cursor used for pagination. The value of the cursor must be retrieved from pagination links included in previous responses; you should not attempt to write them on your own. ' in: query name: page[cursor] schema: type: string summary: Get team managers get: description: Get the managers of a team. responses: '200': content: application/vnd.api+json: schema: additionalProperties: false properties: data: items: allOf: - description: User id. properties: id: description: User identifier. example: u:user_1 pattern: ^u:[\w.-]+$ type: string type: enum: - users type: string required: - type - id type: object - properties: attributes: additionalProperties: false description: User attributes. properties: username: description: The username. example: user_1 type: string required: - username type: object links: additionalProperties: false description: User links. properties: self: description: User details link. example: /users/u:user_1 type: string required: - self type: object required: - attributes - links type: object type: array links: additionalProperties: false properties: next: example: /teams/o:organization_slug:t:team_slug/managers?page[cursor]=XXX nullable: true type: string previous: example: /teams/o:organization_slug:t:team_slug/managers?page[cursor]=XXX nullable: true type: string self: example: /teams/o:organization_slug:t:team_slug/managers type: string required: - self - previous - next type: object required: - data - links type: object description: Successful Response. summary: Get team managers tags: - Teams x-released: true /teams/{team_id}/relationships/managers: description: Update team managers. parameters: - description: 'Format of composite id should be `o:organization_slug:t:team_slug`. ' in: path name: team_id required: true schema: description: Team identifier. example: o:organization_slug:t:team_slug pattern: ^o:[a-zA-Z0-9._-]+:t:[a-zA-Z0-9_-]+$ type: string summary: Edit team managers delete: description: Remove managers from team. requestBody: content: application/vnd.api+json: schema: additionalProperties: false properties: data: items: description: User id. properties: id: description: User identifier. example: u:user_1 pattern: ^u:[\w.-]+$ type: string type: enum: - users type: string required: - type - id type: object type: array required: - data type: object required: true responses: '204': description: No content. '400': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: invalid type: string detail: example: Enter a valid `name` consisting of Unicode letters, numbers, underscores, or hyphens type: string source: anyOf: - properties: pointer: example: /data/attributes/name type: string - properties: parameter: example: ?filter[foo] type: string status: example: '400' type: string title: example: Field `name` is invalid type: string type: object type: array type: object description: Invalid '401': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: unauthorized type: string detail: example: Please verify your credentials type: string status: example: '401' type: string title: example: Unauthorized type: string type: object type: array type: object description: Unauthorized '403': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: true properties: code: example: forbidden type: string detail: example: You do not have permissions to perform this action type: string status: example: '403' type: string title: example: Operation not allowed type: string type: object type: array type: object description: Forbidden '404': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: properties: code: example: not found type: string detail: example: Object not found. It may have been deleted or not been created yet type: string status: example: '404' type: string title: example: Object not found type: string type: object type: array type: object description: Not found '409': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: conflict type: string detail: example: Value `some_field_value` already exists type: string source: additionalProperties: false properties: pointer: example: /data/attributes/some_field type: string type: object status: example: '409' type: string title: example: Field `some_field` conflicted type: string type: object type: array type: object description: Conflict '500': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: server error type: string detail: example: Something went wrong, please try again type: string status: example: '500' type: string title: example: Something went wrong type: string type: object type: array type: object description: Internal Error summary: Remove managers from team tags: - Teams x-released: true get: description: Get team manager relationships. parameters: - description: 'The cursor used for pagination. The value of the cursor must be retrieved from pagination links included in previous responses; you should not attempt to write them on your own. ' in: query name: page[cursor] schema: type: string responses: '200': content: application/vnd.api+json: schema: additionalProperties: false properties: data: items: description: User id. properties: id: description: User identifier. example: u:user_1 pattern: ^u:[\w.-]+$ type: string type: enum: - users type: string required: - type - id type: object type: array links: additionalProperties: false properties: next: example: /teams/o:organization_slug:t:team_slug/relationships/managers?page[cursor]=XXX nullable: true type: string previous: example: /teams/o:organization_slug:t:team_slug/relationships/managers?page[cursor]=XXX nullable: true type: string self: example: /teams/o:organization_slug:t:team_slug/relationships/managers type: string required: - self - previous - next type: object required: - data - links type: object description: Successful Response. '400': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: invalid type: string detail: example: Enter a valid `name` consisting of Unicode letters, numbers, underscores, or hyphens type: string source: anyOf: - properties: pointer: example: /data/attributes/name type: string - properties: parameter: example: ?filter[foo] type: string status: example: '400' type: string title: example: Field `name` is invalid type: string type: object type: array type: object description: Invalid '401': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: unauthorized type: string detail: example: Please verify your credentials type: string status: example: '401' type: string title: example: Unauthorized type: string type: object type: array type: object description: Unauthorized '403': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: true properties: code: example: forbidden type: string detail: example: You do not have permissions to perform this action type: string status: example: '403' type: string title: example: Operation not allowed type: string type: object type: array type: object description: Forbidden '404': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: properties: code: example: not found type: string detail: example: Object not found. It may have been deleted or not been created yet type: string status: example: '404' type: string title: example: Object not found type: string type: object type: array type: object description: Not found '500': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: server error type: string detail: example: Something went wrong, please try again type: string status: example: '500' type: string title: example: Something went wrong type: string type: object type: array type: object description: Internal Error summary: Get team manager relationships tags: - Teams x-released: true patch: description: 'Completely replace team managers. _**Warning**: This is a highly destructive operation._ ' requestBody: content: application/vnd.api+json: schema: additionalProperties: false properties: data: items: description: User id. properties: id: description: User identifier. example: u:user_1 pattern: ^u:[\w.-]+$ type: string type: enum: - users type: string required: - type - id type: object type: array required: - data type: object required: true responses: '204': description: No content. '400': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: invalid type: string detail: example: Enter a valid `name` consisting of Unicode letters, numbers, underscores, or hyphens type: string source: anyOf: - properties: pointer: example: /data/attributes/name type: string - properties: parameter: example: ?filter[foo] type: string status: example: '400' type: string title: example: Field `name` is invalid type: string type: object type: array type: object description: Invalid '401': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: unauthorized type: string detail: example: Please verify your credentials type: string status: example: '401' type: string title: example: Unauthorized type: string type: object type: array type: object description: Unauthorized '402': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: payment_required type: string detail: example: 'Your plan doesn''t cover the requested feature, please upgrade ' type: string status: example: '402' type: string title: example: Payment required type: string type: object type: array type: object description: Payment required '403': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: true properties: code: example: forbidden type: string detail: example: You do not have permissions to perform this action type: string status: example: '403' type: string title: example: Operation not allowed type: string type: object type: array type: object description: Forbidden '404': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: properties: code: example: not found type: string detail: example: Object not found. It may have been deleted or not been created yet type: string status: example: '404' type: string title: example: Object not found type: string type: object type: array type: object description: Not found '500': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: server error type: string detail: example: Something went wrong, please try again type: string status: example: '500' type: string title: example: Something went wrong type: string type: object type: array type: object description: Internal Error summary: Update team managers tags: - Teams x-released: true post: description: Add managers to team. requestBody: content: application/vnd.api+json: schema: additionalProperties: false properties: data: items: description: User id. properties: id: description: User identifier. example: u:user_1 pattern: ^u:[\w.-]+$ type: string type: enum: - users type: string required: - type - id type: object type: array required: - data type: object required: true responses: '204': description: No content. '400': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: invalid type: string detail: example: Enter a valid `name` consisting of Unicode letters, numbers, underscores, or hyphens type: string source: anyOf: - properties: pointer: example: /data/attributes/name type: string - properties: parameter: example: ?filter[foo] type: string status: example: '400' type: string title: example: Field `name` is invalid type: string type: object type: array type: object description: Invalid '401': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: unauthorized type: string detail: example: Please verify your credentials type: string status: example: '401' type: string title: example: Unauthorized type: string type: object type: array type: object description: Unauthorized '402': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: payment_required type: string detail: example: 'Your plan doesn''t cover the requested feature, please upgrade ' type: string status: example: '402' type: string title: example: Payment required type: string type: object type: array type: object description: Payment required '403': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: true properties: code: example: forbidden type: string detail: example: You do not have permissions to perform this action type: string status: example: '403' type: string title: example: Operation not allowed type: string type: object type: array type: object description: Forbidden '404': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: properties: code: example: not found type: string detail: example: Object not found. It may have been deleted or not been created yet type: string status: example: '404' type: string title: example: Object not found type: string type: object type: array type: object description: Not found '409': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: conflict type: string detail: example: Value `some_field_value` already exists type: string source: additionalProperties: false properties: pointer: example: /data/attributes/some_field type: string type: object status: example: '409' type: string title: example: Field `some_field` conflicted type: string type: object type: array type: object description: Conflict '500': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: server error type: string detail: example: Something went wrong, please try again type: string status: example: '500' type: string title: example: Something went wrong type: string type: object type: array type: object description: Internal Error summary: Add managers to team tags: - Teams x-released: true components: securitySchemes: bearerAuth: description: 'To use the API you need to authenticate your requests using Token Authentication. Specifically, you need to * Acquire an authentication token from the Transifex (under user settings) * Uses the `Bearer` keyword and prepend the token when passing the header. For example, if the authentication token is `1/0b4e75552e481aeae813aebad53f3de3fcc67ccd`, then the HTTP header should look like this: `Authorization: Bearer 1/0b4e75552e481aeae813aebad53f3de3fcc67ccd` To create an API token: 1. Head to your User Settings by going to the main navigation, and clicking on your profile image in the top right corner. 2. In the left menu, click on API token. 3. Click Generate a token. Once you''ve generated a token, you can edit its name so it''s easier to remember where you use the token. To keep your API token secure, we''ll only show it once, so please be sure to save it somewhere secure. In case you lose your API token, you can regenerate a new one at any time. However, when you regenerate a new token, you''ll need to update your applications and replace the old token with the new one. ' scheme: bearer type: http