openapi: 3.2.0
info:
  title: ClickUp API v2 Reference Workspaces API
  description: The ClickUp API enables you to programmatically access and manage your ClickUp resources.
  contact: {}
  version: '2.0'
servers:
- url: https://api.clickup.com/api
  description: ClickUp
  variables: {}
security:
- Authorization_Token: []
tags:
- name: Workspaces
paths:
  /v2/team:
    parameters: []
    get:
      summary: Get Authorized Workspaces
      tags:
      - Workspaces
      description: View the Workspaces available to the authenticated user.
      operationId: GetAuthorizedTeams
      parameters: []
      responses:
        '200':
          description: ''
          headers: {}
          content:
            application/json:
              schema:
                title: GetAuthorizedTeamsresponse
                required:
                - teams
                type: object
                properties:
                  teams:
                    type: array
                    items:
                      title: Team
                      required:
                      - id
                      - name
                      - color
                      - avatar
                      - members
                      type: object
                      properties:
                        id:
                          type: string
                        name:
                          type: string
                        color:
                          type: string
                        avatar:
                          type: string
                        members:
                          type: array
                          items:
                            title: Member
                            required:
                            - user
                            type: object
                            properties:
                              user:
                                $ref: '#/paths/~1v2~1user/get/responses/200/content/application~1json/schema/properties/user'
                            examples:
                            - user:
                                id: 123
                                username: John Doe
                                color: '#000000'
                                profilePicture: https://clickup.com/avatar.jpg
                          description: ''
                      examples:
                      - id: '1234'
                        name: My ClickUp Workspace
                        color: '#000000'
                        avatar: https://clickup.com/avatar.jpg
                        members:
                        - user:
                            id: 123
                            username: John Doe
                            color: '#000000'
                            profilePicture: https://clickup.com/avatar.jpg
                    description: ''
                examples:
                - teams:
                  - id: '1234'
                    name: My ClickUp Workspace
                    color: '#000000'
                    avatar: https://clickup.com/avatar.jpg
                    members:
                    - user:
                        id: 123
                        username: John Doe
                        color: '#000000'
                        profilePicture: https://clickup.com/avatar.jpg
              example:
                teams:
                - id: '1234'
                  name: My ClickUp Workspace
                  color: '#000000'
                  avatar: https://clickup.com/avatar.jpg
                  members:
                  - user:
                      id: 123
                      username: John Doe
                      color: '#000000'
                      profilePicture: https://clickup.com/avatar.jpg
      deprecated: false
  /v2/team/{team_id}/seats:
    parameters: []
    get:
      summary: Get Workspace seats
      tags:
      - Workspaces
      description: View the used, total, and available member and guest seats for a Workspace.
      operationId: GetWorkspaceseats
      parameters:
      - name: team_id
        in: path
        description: Workspace ID
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: ''
          headers: {}
          content:
            application/json:
              schema:
                title: GetWorkspaceseatsresponse
                required:
                - members
                - guests
                type: object
                properties:
                  members:
                    title: Members
                    required:
                    - filled_members_seats
                    - total_member_seats
                    - empty_member_seats
                    type: object
                    properties:
                      filled_members_seats:
                        type: integer
                        contentEncoding: int32
                      total_member_seats:
                        type: integer
                        contentEncoding: int32
                      empty_member_seats:
                        type: integer
                        contentEncoding: int32
                    examples:
                    - filled_members_seats: 9
                      total_member_seats: 9
                      empty_member_seats: 0
                  guests:
                    title: Guests
                    required:
                    - filled_guest_seats
                    - total_guest_seats
                    - empty_guest_seats
                    type: object
                    properties:
                      filled_guest_seats:
                        type: integer
                        contentEncoding: int32
                      total_guest_seats:
                        oneOf:
                        - type: integer
                          contentEncoding: int32
                        - type: string
                          enum:
                          - Infinity
                      empty_guest_seats:
                        oneOf:
                        - type: integer
                          contentEncoding: int32
                        - type: string
                          enum:
                          - Infinity
                    examples:
                    - filled_guest_seats: 2
                      total_guest_seats: 50
                      empty_guest_seats: 48
                    - filled_guest_seats: 2
                      total_guest_seats: Infinity
                      empty_guest_seats: Infinity
                examples:
                - members:
                    filled_members_seats: 9
                    total_member_seats: 9
                    empty_member_seats: 0
                  guests:
                    filled_guest_seats: 2
                    total_guest_seats: 50
                    empty_guest_seats: 48
                - members:
                    filled_members_seats: 9
                    total_member_seats: 9
                    empty_member_seats: 0
                  guests:
                    filled_guest_seats: 2
                    total_guest_seats: Infinity
                    empty_guest_seats: Infinity
              example:
                members:
                  filled_members_seats: 9
                  total_member_seats: 9
                  empty_member_seats: 0
                guests:
                  filled_guest_seats: 2
                  total_guest_seats: 50
                  empty_guest_seats: 48
      deprecated: false
  /v2/team/{team_id}/plan:
    parameters: []
    get:
      summary: Get Workspace Plan
      tags:
      - Workspaces
      description: View the current Plan for the specified Workspace.
      operationId: GetWorkspaceplan
      parameters:
      - name: team_id
        in: path
        description: Workspace ID
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: ''
          headers: {}
          content:
            application/json:
              schema:
                title: GetWorkspaceplanresponse
                type: object
                properties:
                  plan_name:
                    type: string
                  plan_id:
                    type: integer
                examples:
                - plan_name: Enterprise
                  plan_id: 4
              example:
                plan_name: Enterprise
                plan_id: 4
      deprecated: false
components:
  securitySchemes:
    Authorization_Token:
      name: Authorization
      type: apiKey
      in: header
      description: 'API token required for authentication. Two types of tokens are supported:

        **Personal API Key** Obtain from ClickUp''s settings page under ''Apps'' and add it to the header as `Authorization: pk_...`

        **OAuth2 Access Token** Generated through the OAuth2 flow and add it to the header as `Authorization: Bearer {access_token}`'