clickup Authorization API

Operations for retrieving authenticated user information.

OpenAPI Specification

clickup-authorization-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: ClickUp Comments Authorization API
  description: The ClickUp Comments API provides endpoints for creating and retrieving comments on tasks, views, and lists. Comments support rich text formatting, mentions, and attachments. Developers can use this API to build integrations that synchronize discussions between ClickUp and other collaboration tools, or to programmatically add status updates and notes to tasks.
  version: '2.0'
  contact:
    name: ClickUp Support
    url: https://help.clickup.com
  termsOfService: https://clickup.com/terms
servers:
- url: https://api.clickup.com/api/v2
  description: ClickUp API v2 Production Server
security:
- bearerAuth: []
tags:
- name: Authorization
  description: Operations for retrieving authenticated user information.
paths:
  /user:
    get:
      operationId: getAuthorizedUser
      summary: Get authorized user
      description: Retrieves information about the currently authenticated user, including their ID, username, email, and profile picture. This endpoint requires a valid access token.
      tags:
      - Authorization
      security:
      - bearerAuth: []
      responses:
        '200':
          description: Successfully retrieved user information
          content:
            application/json:
              schema:
                type: object
                properties:
                  user:
                    $ref: '#/components/schemas/AuthorizedUser'
        '401':
          description: Unauthorized - invalid or expired token
components:
  schemas:
    AuthorizedUser:
      type: object
      description: The authenticated user's profile information.
      properties:
        id:
          type: integer
          description: The unique identifier of the user.
        username:
          type: string
          description: The username of the user.
        email:
          type: string
          format: email
          description: The email address of the user.
        color:
          type: string
          description: The hex color code associated with the user.
        profilePicture:
          type: string
          format: uri
          nullable: true
          description: URL of the user's profile picture.
        initials:
          type: string
          description: The initials of the user.
        week_start_day:
          type: integer
          description: The day of the week that starts the user's week. 0 is Sunday.
        global_font_support:
          type: boolean
          description: Whether global font support is enabled.
        timezone:
          type: string
          description: The user's timezone.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: ClickUp personal API token or OAuth access token.
externalDocs:
  description: ClickUp Comments API Documentation
  url: https://developer.clickup.com/reference/get-task-comments