KISI Team memberships API

openapi: 3.2.0
info:
  version: 1.0.0
  title: Kisi Team memberships API
  description: '## Introduction


    Welcome to the Kisi API documentation.'
  contact:
    name: Kisi Support
    email: support@getkisi.com
servers:
- url: https://api.kisi.io
  description: Kisi Production
tags:
- name: Team Memberships
paths:
  /team_memberships:
    get:
      operationId: fetchTeamMemberships
      summary: Fetch team memberships
      tags:
      - Team Memberships
      security:
      - Kisi-Login: []
      - OAuth2: []
      parameters:
      - name: ids
        in: query
        schema:
          type: string
        description: Filter by object IDs
      - name: member_type
        in: query
        schema:
          type: string
          enum:
          - User
          - Guest
        description: Filter by member type
      - name: member_id
        in: query
        schema:
          type: integer
        description: Filter by member ID. Must be used with `member_type`
      - name: team_id
        in: query
        schema:
          type: integer
        description: Filter by team ID
      - name: limit
        in: query
        schema:
          type: integer
          default: 10
          maximum: 250
        description: The number of objects to return
      - name: offset
        in: query
        schema:
          type: integer
          default: 0
          maximum: 20000
        description: The number of objects to offset
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  title: Team Membership
                  properties:
                    id:
                      type: integer
                      description: The ID of the team membership
                    resource_type:
                      type: string
                      description: The resource type of the team membership
                      const: TeamMembership
                    created_at:
                      type: string
                      format: date-time
                      description: When the team membership was created
                    updated_at:
                      type: string
                      format: date-time
                      description: When the team membership was updated
                    team_id:
                      type: integer
                      description: The team ID of the team membership
                    team:
                      type: object
                      title: Team
                      description: The team of the team membership
                      properties:
                        id:
                          type: integer
                          description: The ID of the team
                        resource_type:
                          type: string
                          description: The resource type of the team
                          const: Team
                        name:
                          type: string
                          description: The name of the team
                      required:
                      - id
                      - resource_type
                      - name
                      additionalProperties: false
                    member_type:
                      type: string
                      enum:
                      - User
                      - Guest
                      description: The member type of the team membership
                    member_id:
                      type: integer
                      description: The member ID of the team membership
                    member:
                      type: object
                      description: The member of the team membership
                      oneOf:
                      - type: object
                        title: User
                        properties:
                          id:
                            type: integer
                            description: The ID of the user
                          resource_type:
                            type: string
                            description: The resource type of the user
                            const: User
                          email:
                            type: string
                            format: email
                            description: The email of the user.
                          name:
                            type: string
                            description: The name of the user
                        required:
                        - id
                        - resource_type
                        - email
                        - name
                        additionalProperties: false
                      - type: object
                        title: Guest
                        properties:
                          id:
                            type: integer
                            description: The ID of the guest
                          resource_type:
                            type: string
                            description: The resource type of the guest
                            const: Guest
                          name:
                            type: string
                            description: The name of the guest
                          email:
                            type:
                            - string
                            - 'null'
                            format: email
                            description: The email of the guest.
                          phone_number:
                            type:
                            - string
                            - 'null'
                            description: 'The phone number of the guest. Only US, Canadian and Puerto Rican numbers in the format +11234567890 (E.164) are accepted.

                              '
                        required:
                        - id
                        - resource_type
                        - name
                        - email
                        - phone_number
                        additionalProperties: false
                  required:
                  - id
                  - resource_type
                  - created_at
                  - updated_at
                  - team_id
                  - team
                  - member_type
                  - member_id
                  - member
                  additionalProperties: false
          headers:
            X-Collection-Range:
              description: 'Pagination information for offset based pagination. `start-end` represents the range

                of items requested. `total` represents the total count of items. If there is a total

                of 15 items and an offset of 10 and limit of 10 is used, the resulting header is:

                `10-19/15`.

                '
              schema:
                type: string
                pattern: ^(?<start>\d+)-(?<end>\d+)/(?<total>\d+)$
              example: 0-9/200
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    post:
      operationId: createTeamMembership
      summary: Create team membership
      tags:
      - Team Memberships
      security:
      - Kisi-Login: []
      - OAuth2: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              title: Team Membership
              properties:
                team_membership:
                  type: object
                  properties:
                    team_id:
                      type: integer
                      description: The team ID of the team membership
                    member_id:
                      type: integer
                      description: The member ID of the team membership
                    member_type:
                      type: string
                      enum:
                      - User
                      - Guest
                      description: The member type of the team membership
                  required:
                  - team_id
                  - member_id
                  - member_type
              required:
              - team_membership
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                title: Team Membership
                properties:
                  id:
                    type: integer
                    description: The ID of the team membership
                  resource_type:
                    type: string
                    description: The resource type of the team membership
                    const: TeamMembership
                  created_at:
                    type: string
                    format: date-time
                    description: When the team membership was created
                  updated_at:
                    type: string
                    format: date-time
                    description: When the team membership was updated
                  team_id:
                    type: integer
                    description: The team ID of the team membership
                  team:
                    type: object
                    title: Team
                    description: The team of the team membership
                    properties:
                      id:
                        type: integer
                        description: The ID of the team
                      resource_type:
                        type: string
                        description: The resource type of the team
                        const: Team
                      name:
                        type: string
                        description: The name of the team
                    required:
                    - id
                    - resource_type
                    - name
                    additionalProperties: false
                  member_type:
                    type: string
                    enum:
                    - User
                    - Guest
                    description: The member type of the team membership
                  member_id:
                    type: integer
                    description: The member ID of the team membership
                  member:
                    type: object
                    description: The member of the team membership
                    oneOf:
                    - type: object
                      title: User
                      properties:
                        id:
                          type: integer
                          description: The ID of the user
                        resource_type:
                          type: string
                          description: The resource type of the user
                          const: User
                        email:
                          type: string
                          format: email
                          description: The email of the user.
                        name:
                          type: string
                          description: The name of the user
                      required:
                      - id
                      - resource_type
                      - email
                      - name
                      additionalProperties: false
                    - type: object
                      title: Guest
                      properties:
                        id:
                          type: integer
                          description: The ID of the guest
                        resource_type:
                          type: string
                          description: The resource type of the guest
                          const: Guest
                        name:
                          type: string
                          description: The name of the guest
                        email:
                          type:
                          - string
                          - 'null'
                          format: email
                          description: The email of the guest.
                        phone_number:
                          type:
                          - string
                          - 'null'
                          description: 'The phone number of the guest. Only US, Canadian and Puerto Rican numbers in the format +11234567890 (E.164) are accepted.

                            '
                      required:
                      - id
                      - resource_type
                      - name
                      - email
                      - phone_number
                      additionalProperties: false
                required:
                - id
                - resource_type
                - created_at
                - updated_at
                - team_id
                - team
                - member_type
                - member_id
                - member
                additionalProperties: false
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '422':
          description: Unprocessable Content
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
  /team_memberships/{id}:
    get:
      operationId: fetchTeamMembership
      summary: Fetch team membership
      tags:
      - Team Memberships
      security:
      - Kisi-Login: []
      - OAuth2: []
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
        description: The ID of the object
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                title: Team Membership
                properties:
                  id:
                    type: integer
                    description: The ID of the team membership
                  resource_type:
                    type: string
                    description: The resource type of the team membership
                    const: TeamMembership
                  created_at:
                    type: string
                    format: date-time
                    description: When the team membership was created
                  updated_at:
                    type: string
                    format: date-time
                    description: When the team membership was updated
                  team_id:
                    type: integer
                    description: The team ID of the team membership
                  team:
                    type: object
                    title: Team
                    description: The team of the team membership
                    properties:
                      id:
                        type: integer
                        description: The ID of the team
                      resource_type:
                        type: string
                        description: The resource type of the team
                        const: Team
                      name:
                        type: string
                        description: The name of the team
                    required:
                    - id
                    - resource_type
                    - name
                    additionalProperties: false
                  member_type:
                    type: string
                    enum:
                    - User
                    - Guest
                    description: The member type of the team membership
                  member_id:
                    type: integer
                    description: The member ID of the team membership
                  member:
                    type: object
                    description: The member of the team membership
                    oneOf:
                    - type: object
                      title: User
                      properties:
                        id:
                          type: integer
                          description: The ID of the user
                        resource_type:
                          type: string
                          description: The resource type of the user
                          const: User
                        email:
                          type: string
                          format: email
                          description: The email of the user.
                        name:
                          type: string
                          description: The name of the user
                      required:
                      - id
                      - resource_type
                      - email
                      - name
                      additionalProperties: false
                    - type: object
                      title: Guest
                      properties:
                        id:
                          type: integer
                          description: The ID of the guest
                        resource_type:
                          type: string
                          description: The resource type of the guest
                          const: Guest
                        name:
                          type: string
                          description: The name of the guest
                        email:
                          type:
                          - string
                          - 'null'
                          format: email
                          description: The email of the guest.
                        phone_number:
                          type:
                          - string
                          - 'null'
                          description: 'The phone number of the guest. Only US, Canadian and Puerto Rican numbers in the format +11234567890 (E.164) are accepted.

                            '
                      required:
                      - id
                      - resource_type
                      - name
                      - email
                      - phone_number
                      additionalProperties: false
                required:
                - id
                - resource_type
                - created_at
                - updated_at
                - team_id
                - team
                - member_type
                - member_id
                - member
                additionalProperties: false
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    delete:
      operationId: deleteTeamMembership
      summary: Delete team membership
      tags:
      - Team Memberships
      security:
      - Kisi-Login: []
      - OAuth2: []
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
        description: The ID of the object
      responses:
        '204':
          description: No Content
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    Error:
      description: Schema describing errors.
      type: object
      properties:
        error:
          type: string
          description: The error message.
          example: Wrong email address or password.
        code:
          type: string
          description: An identifier of the error.
          example: afc516
      required:
      - error
      - code
    Errors:
      description: Schema describing validation errors.
      type: object
      properties:
        errors:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          example:
            email:
            - can't be blank or invalid
            password:
            - can't be blank
      required:
      - errors
  securitySchemes:
    Webhook-Signature:
      type: apiKey
      in: header
      name: X-Signature
      description: 'Authorize using a signature of the request body. The signature is a HMAC-SHA256 hash of the request body using a secret key. <br><br>E.g. `X-Signature: 123`'
    Kisi-Login:
      type: apiKey
      in: header
      name: Authorization
      description: 'Authorize using a login. Prefix the value with `KISI-LOGIN`<br><br>Example: `Authorization: KISI-LOGIN 123`'
    Kisi-Access-Key:
      type: apiKey
      in: header
      name: Authorization
      description: 'Authorize using an access key. Prefix the value with `KISI-ACCESS-KEY`<br><br>Example: `Authorization: KISI-ACCESS-KEY 123`'
    Kisi-Group-Link:
      type: apiKey
      in: header
      name: Authorization
      description: 'Authorize using a group link. Prefix the value with `KISI-GROUP-LINK`<br><br>Example: `Authorization: KISI-GROUP-LINK 123`'
    Kisi-Service:
      type: apiKey
      in: header
      name: Authorization
      description: 'Authorize using a service. Prefix the value with `KISI-SERVICE`<br><br>Example: `Authorization: KISI-SERVICE 123`'
    OAuth2Basic:
      type: http
      scheme: basic
      description: Username is the client id. Password is the client secret.
    OAuth2:
      type: oauth2
      description: 'OAuth access tokens are sent as bearer tokens. Example: `Authorization: Bearer youraccesstoken`'
      flows:
        authorizationCode:
          authorizationUrl: https://api.kisi.io/oauth/authorize
          tokenUrl: https://api.kisi.io/oauth/token
          scopes: {}