openapi: 3.0.1
info:
  title: CometChat REST Management Auth Tokens Friends API
  description: Server-side REST Management API (v3) for CometChat in-app messaging. Manages users, authentication tokens, groups, group members, messages, conversations, reactions, roles, friends, blocked and banned users, and webhooks for a CometChat app. The API is scoped to a single app and region; the host is derived from your App ID and the region your app is provisioned in (us, eu, in). All requests authenticate with a Rest API Key (fullAccess scope) passed in the `apikey` header. Realtime delivery to end users is handled separately by the CometChat client SDKs over a managed WebSocket layer and is not part of this REST surface.
  termsOfService: https://www.cometchat.com/terms-and-conditions
  contact:
    name: CometChat Support
    url: https://www.cometchat.com/contact-sales
  version: '3.0'
servers:
- url: https://{appId}.api-{region}.cometchat.io/v3
  description: Per-app, per-region CometChat REST Management API host
  variables:
    appId:
      default: APP_ID
      description: Your CometChat App ID from the dashboard
    region:
      default: us
      enum:
      - us
      - eu
      - in
      description: The region your CometChat app is provisioned in
security:
- apiKeyAuth: []
tags:
- name: Friends
  description: User-to-user friend relationships
paths:
  /friends:
    post:
      operationId: addFriends
      tags:
      - Friends
      summary: Add friends for a user
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FriendsRequest'
      responses:
        '200':
          description: Acknowledgement.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Acknowledgement'
  /users/{uid}/friends:
    parameters:
    - $ref: '#/components/parameters/Uid'
    get:
      operationId: listFriends
      tags:
      - Friends
      summary: List a user's friends
      responses:
        '200':
          description: A list of friends.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserList'
    delete:
      operationId: removeFriends
      tags:
      - Friends
      summary: Remove friends for a user
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FriendsRequest'
      responses:
        '200':
          description: Acknowledgement.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Acknowledgement'
components:
  schemas:
    User:
      type: object
      properties:
        uid:
          type: string
        name:
          type: string
        avatar:
          type: string
        link:
          type: string
        role:
          type: string
        metadata:
          type: object
        status:
          type: string
          enum:
          - online
          - offline
        statusMessage:
          type: string
        hasBlockedMe:
          type: boolean
        blockedByMe:
          type: boolean
        createdAt:
          type: integer
          format: int64
        updatedAt:
          type: integer
          format: int64
        lastActiveAt:
          type: integer
          format: int64
        deactivatedAt:
          type: integer
          format: int64
    UserList:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/User'
        meta:
          type: object
          properties:
            pagination:
              $ref: '#/components/schemas/Pagination'
    Pagination:
      type: object
      properties:
        total:
          type: integer
        count:
          type: integer
        per_page:
          type: integer
        current_page:
          type: integer
        total_pages:
          type: integer
    Acknowledgement:
      type: object
      properties:
        data:
          type: object
          properties:
            success:
              type: boolean
            message:
              type: string
    FriendsRequest:
      type: object
      required:
      - friends
      properties:
        friends:
          type: array
          items:
            type: string
          description: List of UIDs.
  parameters:
    Uid:
      name: uid
      in: path
      required: true
      schema:
        type: string
      description: Unique user identifier.
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: apikey
      description: Rest API Key with fullAccess scope from the CometChat dashboard. The App ID and region are encoded in the host, not in a header.