Transifex Team Memberships API

openapi: 3.0.1
info:
  contact:
    email: support@transifex.com
    name: Transifex Support
  description: "<br/>\n<br/>\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<br />\n<br />\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<br />\n<br />\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<!-- ReDoc-Inject: <security-definitions> -->\n"
  title: Transifex Activity Reports Team Memberships 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: Team Memberships
paths:
  /team_memberships:
    get:
      description: List team memberships.
      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: Filter results by a team
        in: query
        name: filter[team]
        required: false
        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: Filter results by a language
        in: query
        name: filter[language]
        required: false
        schema:
          description: Language identifier.
          example: l:en_US
          pattern: ^l:[a-zA-Z0-9@_.-]+$
          type: string
      - description: Filter results by a user
        in: query
        name: filter[user]
        required: false
        schema:
          description: User identifier.
          example: u:user_1
          pattern: ^u:[\w.-]+$
          type: string
      - description: Filter results by role
        in: query
        name: filter[role]
        required: false
        schema:
          enum:
          - coordinator
          - reviewer
          - translator
          example: translator
          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
      - explode: false
        in: query
        name: include
        required: false
        schema:
          enum:
          - user
          type: string
        style: form
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                additionalProperties: false
                properties:
                  data:
                    items:
                      additionalProperties: false
                      properties:
                        attributes:
                          additionalProperties: false
                          properties:
                            role:
                              enum:
                              - coordinator
                              - reviewer
                              - translator
                              example: translator
                              type: string
                          required:
                          - role
                          type: object
                        id:
                          example: o:organization_slug:t:team_slug:l:lang_code:u:username
                          pattern: ^o:[a-zA-Z0-9._-]+:t:[a-zA-Z0-9._-]+:l:[a-zA-Z0-9._-]+:u:[a-zA-Z0-9._-]+$
                          type: string
                        links:
                          additionalProperties: false
                          properties:
                            self:
                              example: /team_memberships/o:organization_slug:t:team_slug:l:lang_code:u:username
                              type: string
                          required:
                          - self
                          type: object
                        relationships:
                          additionalProperties: false
                          properties:
                            language:
                              additionalProperties: false
                              properties:
                                data:
                                  additionalProperties: false
                                  description: Language data container.
                                  properties:
                                    id:
                                      description: Language identifier.
                                      example: l:en_US
                                      pattern: ^l:[a-zA-Z0-9@_.-]+$
                                      type: string
                                    type:
                                      enum:
                                      - languages
                                      type: string
                                  required:
                                  - type
                                  - id
                                  type: object
                                links:
                                  additionalProperties: false
                                  description: Language related link.
                                  properties:
                                    related:
                                      description: Language details link.
                                      example: /languages/l:en_US
                                      type: string
                                  required:
                                  - related
                                  type: object
                              required:
                              - data
                              - links
                              type: object
                            team:
                              additionalProperties: false
                              properties:
                                data:
                                  description: Team data container.
                                  properties:
                                    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:
                                  - type
                                  - id
                                  type: object
                                links:
                                  additionalProperties: false
                                  properties:
                                    related:
                                      example: /teams/o:organization_slug:t:team_slug
                                      type: string
                                  required:
                                  - related
                                  type: object
                              required:
                              - data
                              - links
                              type: object
                            user:
                              additionalProperties: false
                              properties:
                                data:
                                  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
                                links:
                                  additionalProperties: false
                                  description: User links.
                                  properties:
                                    related:
                                      description: User details link.
                                      example: /users/u:user_1
                                      type: string
                                  required:
                                  - related
                                  type: object
                              required:
                              - data
                              - links
                              type: object
                          required:
                          - team
                          - language
                          - user
                          type: object
                        type:
                          enum:
                          - team_memberships
                          example: team_memberships
                          type: string
                      required:
                      - type
                      - id
                      - attributes
                      - relationships
                      - links
                      type: object
                    type: array
                  included:
                    description: List of included user objects.
                    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: /team_memberships?filter[organization]=organization_slug&page[cursor]=XXX
                        nullable: true
                        type: string
                      previous:
                        example: /team_memberships?filter[organization]=organization_slug&page[cursor]=XXX
                        nullable: true
                        type: string
                      self:
                        example: /team_memberships?filter[organization]=o:organization_slug
                        type: string
                    required:
                    - self
                    - previous
                    - next
                    type: object
                required:
                - data
                - links
                type: object
          description: Success.
        '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: List team memberships
      tags:
      - Team Memberships
      x-released: true
    post:
      description: Create a new team membership.
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              additionalProperties: false
              properties:
                data:
                  additionalProperties: false
                  properties:
                    attributes:
                      additionalProperties: false
                      properties:
                        role:
                          enum:
                          - coordinator
                          - reviewer
                          - translator
                          example: translator
                          type: string
                      required:
                      - role
                      type: object
                    relationships:
                      additionalProperties: false
                      properties:
                        language:
                          additionalProperties: false
                          properties:
                            data:
                              additionalProperties: false
                              description: Language data container.
                              properties:
                                id:
                                  description: Language identifier.
                                  example: l:en_US
                                  pattern: ^l:[a-zA-Z0-9@_.-]+$
                                  type: string
                                type:
                                  enum:
                                  - languages
                                  type: string
                              required:
                              - type
                              - id
                              type: object
                          required:
                          - data
                          type: object
                        team:
                          additionalProperties: false
                          properties:
                            data:
                              description: Team data container.
                              properties:
                                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:
                              - type
                              - id
                              type: object
                          required:
                          - data
                          type: object
                        user:
                          additionalProperties: false
                          properties:
                            data:
                              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
                          required:
                          - data
                          type: object
                      required:
                      - team
                      - language
                      - user
                      type: object
                    type:
                      enum:
                      - team_memberships
                      example: team_memberships
                      type: string
                  required:
                  - type
                  - attributes
                  - relationships
                  type: object
              required:
              - data
              type: object
        required: true
      responses:
        '201':
          content:
            application/vnd.api+json:
              schema:
                additionalProperties: false
                properties:
                  data:
                    additionalProperties: false
                    properties:
                      attributes:
                        additionalProperties: false
                        properties:
                          role:
                            enum:
                            - coordinator
                            - reviewer
                            - translator
                            example: translator
                            type: string
                        required:
                        - role
                        type: object
                      id:
                        example: o:organization_slug:t:team_slug:l:lang_code:u:username
                        pattern: ^o:[a-zA-Z0-9._-]+:t:[a-zA-Z0-9._-]+:l:[a-zA-Z0-9._-]+:u:[a-zA-Z0-9._-]+$
                        type: string
                      links:
                        additionalProperties: false
                        properties:
                          self:
                            example: /team_memberships/o:organization_slug:t:team_slug:l:lang_code:u:username
                            type: string
                        required:
                        - self
                        type: object
                      relationships:
                        additionalProperties: false
                        properties:
                          language:
                            additionalProperties: false
                            properties:
                              data:
                                additionalProperties: false
                                description: Language data container.
                                properties:
                                  id:
                                    description: Language identifier.
                                    example: l:en_US
                                    pattern: ^l:[a-zA-Z0-9@_.-]+$
                                    type: string
                                  type:
                                    enum:
                                    - languages
                                    type: string
                                required:
                                - type
                                - id
                                type: object
                              links:
                                additionalProperties: false
                                description: Language related link.
                                properties:
                                  related:
                                    description: Language details link.
                                    example: /languages/l:en_US
                                    type: string
                                required:
                                - related
                                type: object
                            required:
                            - data
                            - links
                            type: object
                          team:
                            additionalProperties: false
                            properties:
                              data:
                                description: Team data container.
                                properties:
                                  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:
                                - type
                                - id
                                type: object
                              links:
                                additionalProperties: false
                                properties:
                                  related:
                                    example: /teams/o:organization_slug:t:team_slug
                                    type: string
                                required:
                                - related
                                type: object
                            required:
                            - data
                            - links
                            type: object
                          user:
                            additionalProperties: false
                            properties:
                              data:
                                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
                              links:
                    

# --- truncated at 32 KB (77 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/transifex/refs/heads/main/openapi/transifex-team-memberships-api-openapi.yml