openapi: 3.0.0
info:
  title: Users
  description: |
    <b><a href="https://help.zoho.com/portal/en/kb/zoho-cliq/admin-guides/users-and-profiles/users" target="_blank">Users</a></b> are members of an organization registered in Cliq. The User object represents a user’s profile and the associated attributes within the organization. Using the User APIs, you can retrieve all users in the organization, fetch detailed user information, add new users, update user profiles, and access team-related information.
  contact: {}
  version: 1.0.0
externalDocs:
  description: Find out more about Zoho Cliq APIs V2
  url: https://www.zoho.com/cliq/help/restapi/v2/
servers:
  - url: https://cliq.zoho.com/api/v2
    description: Zoho Cliq US DC
tags:
  - name: users
    description: Users Module
paths:
  /users:
    post:
      summary: Add Users
      operationId: Add Users
      description: |
        Use this API to add a new user or a list of new users.
        <br>
        <p>
          <b>Threshold limit</b>: 5 requests per minute per user<br>
          Number of API calls allowed within a minute.<br><br>
          <b>Lock period</b>: 5 minutes<br>Wait time before consecutive API requests.<br>
        </p>
        <b>Note</b>: When adding users, you might encounter errors for certain email IDs. The table below lists the possible error codes and their descriptions to help you understand and resolve these issues effectively.
        <br><br>
        <table style="width: 100%; table-layout: fixed; border-collapse: collapse;">
          <tr>
            <th style="width: 35%; text-align: center; padding: 12px; background-color: #f5f5f5; border: 1px solid #ddd;">Error Code</th>
            <th style="width: 65%; text-align: center; padding: 12px; background-color: #f5f5f5; border: 1px solid #ddd;">Description</th>
          </tr>
          <tr>
            <td style="word-wrap: break-word; padding: 10px; border: 1px solid #ddd; vertical-align: top;">zohoaccount.conflict</td>
            <td style="padding: 10px; border: 1px solid #ddd; vertical-align: top;">The user has an existing Cliq account with the same email ID. Use a different email to invite.</td>
          </tr>
          <tr>
            <td style="word-wrap: break-word; padding: 10px; border: 1px solid #ddd; vertical-align: top;">email.invitation.blocked</td>
            <td style="padding: 10px; border: 1px solid #ddd; vertical-align: top;">The user has rejected the invitation multiple times. Try a different email ID.</td>
          </tr>
          <tr>
            <td style="word-wrap: break-word; padding: 10px; border: 1px solid #ddd; vertical-align: top;">email.activeuser</td>
            <td style="padding: 10px; border: 1px solid #ddd; vertical-align: top;">The user is already part of your Cliq organization.</td>
          </tr>
          <tr>
            <td style="word-wrap: break-word; padding: 10px; border: 1px solid #ddd; vertical-align: top;">email.pendinguser</td>
            <td style="padding: 10px; border: 1px solid #ddd; vertical-align: top;">An invitation is already pending. Reinvite from the admin panel if needed.</td>
          </tr>
        </table>
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserRequest'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserResponse'
        '400':
          description: Bad Request.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: The request cannot be performed. Usually because of malformed parameter or missing parameter.
        '401':
          description: Unauthorized.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Request was rejected because of invalid AuthToken.
        '403':
          description: Forbidden.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: The user does not have enough permission or possibly not an user of the respective organization to access the resource.
        '404':
          description: Invalid URL.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: The URL you've sent is wrong. It's possible that the resource you've requested has been moved to another URL.
        '405':
          description: Method Not Allowed.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: The requested resource does not support the HTTP method used. For example, requesting List of all customers API with PUT as the HTTP method.
        '406':
          description: Not Acceptable.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: The response has been received but the requested response type is not supported by the browser.
        '429':
          description: Too many requests.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Too many requests within a certain time frame.
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Cliq server encountered an error which prevents it from fulfilling the request.
      security:
        - Cliq_Auth:
            - ZohoCliq.Users.CREATE
      tags:
        - users
    get:
      summary: Retrieve all users
      operationId: Retrieve all users
      description: |
        Use this API to get details of all the users.
        <br><br> 
        <p>
          <b>Threshold limit</b>: 30 requests per min per user<br>
          Number of API calls allowed within a minute.<br><br>
          <b>Lock period</b>: 10 minutes<br>Wait time before consecutive API requests.<br>
        </p>
      parameters:
        - name: status
          in: query
          required: false
          description: |
            Use this parameter to fetch the list of users based on their current status. Allowed values: <ul>
              <li><b>active</b> - User is currently active in the organization.</li>  
              <li><b>inactive</b> - User is manually marked as inactive.</li>
              <li><b>pending</b> - Invitation sent, but user hasn't accepted yet.</li>
              <li><b>imported_active</b> - User imported from another Zoho service and is active.</li>
              <li><b>imported_inactive</b> - User imported but marked as inactive.</li>
            </ul>
          schema:
            type: string
            enum:
              - active
              - inactive
              - pending
              - imported_active
              - imported_inactive
        - name: plan_type
          in: query
          required: false
          description: |
            Use this parameter to filter users based on their subscription type. Allowed values: <ul>
              <li><b>paid</b> - User is under a paid subscription plan.</li>
              <li><b>free</b> - User is under a free version of the plan.</li>
            </ul>
          schema:
            type: string
            enum:
              - paid
              - free
        - name: fields
          in: query
          required: false
          description: |
            Use this parameter to specify which user fields to return.   Multiple fields can be comma-separated. Use fields=all to return all fields. Allowed values: <ul>
              <li><b>display_name</b> - Display name of the user.</li>
              <li><b>mobile</b> - Mobile number of the user.</li>
              <li><b>department</b> - Department the user belongs to.</li>
              <li><b>designation</b> - Job title or role of the user.</li>
              <li><b>all</b> - All available user fields will be returned.</li>
            </ul>
          schema:
            type: string
            enum:
              - display_name
              - mobile
              - department
              - designation
              - all
            example: display_name,mobile
        - name: limit
          in: query
          required: false
          description: The number of users to fetch. Maximum is 100.
          schema:
            type: integer
            maximum: 100
            example: 50
        - name: search
          in: query
          required: false
          description: |
            A text string to search users by name or email address.   If Zoho People is integrated, search includes all its user fields.
          schema:
            type: string
            example: scott
        - name: sort_by
          in: query
          required: false
          description: |
            Use this parameter to sort the users based on specific criteria.
            Allowed values:

              usage - Sort users based on their activity or usage in Cliq.
          schema:
            type: string
            enum:
              - usage
        - name: modified_after
          in: query
          required: false
          description: |
            Fetch users whose fields were modified after this timestamp.<br>   Only changes in the following fields are considered: Department, Designation, Employee ID, Extension, Reporting To, and Work Location.<br>   <b>Note:</b> Only modifications within the last 7 days are available.
          schema:
            type: string
            format: date-time
            example: '2025-06-01T10:00:00Z'
        - name: next_token
          in: query
          required: false
          description: Use this token to paginate and retrieve the next batch of user results.
          schema:
            type: string
      responses:
        '200':
          description: The request was successfully completed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserListResponse'
        '400':
          description: Bad Request.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: The request cannot be performed. Usually because of malformed parameter or missing parameter.
        '401':
          description: Unauthorized.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Request was rejected because of invalid AuthToken.
        '403':
          description: Forbidden.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: The user does not have enough permission or possibly not an user of the respective organization to access the resource.
        '404':
          description: Invalid URL.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: The URL you've sent is wrong. It's possible that the resource you've requested has been moved to another URL.
        '405':
          description: Method Not Allowed.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: The requested resource does not support the HTTP method used. For example, requesting List of all customers API with PUT as the HTTP method.
        '406':
          description: Not Acceptable.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: The response has been received but the requested response type is not supported by the browser.
        '429':
          description: Too many requests.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Too many requests within a certain time frame.
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Cliq server encountered an error which prevents it from fulfilling the request.
      security:
        - Cliq_Auth:
            - ZohoCliq.Users.READ
            - ZohoPeople.forms.READ
            - ZohoPeople.employee.READ
            - ZohoPeople.attendance.READ
      tags:
        - users
  /users/{USER_ID}:
    get:
      summary: Retrieve a particular user
      operationId: Retrieve a particular user
      description: |
        Use this API to get details of a particular user.
        <br><br> 
        <p>
          <b>Threshold limit</b>: 20 requests per min per user<br>
          Number of API calls allowed within a minute.<br><br>
          <b>Lock period</b>: 10 minutes<br>Wait time before consecutive API requests.<br>
        </p>
      parameters:
        - name: USER_ID
          in: path
          required: true
          schema:
            type: string
          example: USER_ID
          description: Unique identifier of the user to be retrieved To learn how to retrieve this ID, see <a href="/cliq/help/restapi/v2/glossary/#USER_ID">USER_ID</a> in the Glossary page.
        - name: fields
          in: query
          required: false
          schema:
            type: string
            enum:
              - display_name
              - mobile
              - department
              - designation
              - all
          description: |

            Use this parameter to fetch the list of user fields. If fields=all, returns all the user fields.<br>
            Allowed values : <b>display_name</b>|<b>mobile</b>|<b>department</b>|<b>designation</b>.<br>
            You can enter multiple fields by seperating them with a comma.
      responses:
        '200':
          description: The request was successfully completed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/retrieve-user-response'
        '400':
          description: Bad Request.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: The request cannot be performed. Usually because of malformed parameter or missing parameter.
        '401':
          description: Unauthorized.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Request was rejected because of invalid AuthToken.
        '403':
          description: Forbidden.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: The user does not have enough permission or possibly not an user of the respective organization to access the resource.
        '404':
          description: Invalid URL.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: The URL you've sent is wrong. It's possible that the resource you've requested has been moved to another URL.
        '405':
          description: Method Not Allowed.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: The requested resource does not support the HTTP method used. For example, requesting List of all customers API with PUT as the HTTP method.
        '406':
          description: Not Acceptable.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: The response has been received but the requested response type is not supported by the browser.
        '429':
          description: Too many requests.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Too many requests within a certain time frame.
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Cliq server encountered an error which prevents it from fulfilling the request.
      security:
        - Cliq_Auth:
            - ZohoCliq.Users.READ
            - ZohoPeople.forms.READ
            - ZohoPeople.employee.READ
            - ZohoPeople.attendance.READ
      tags:
        - users
    put:
      summary: Update user details
      operationId: Update user details
      description: |
        Use this API to edit or update a user's details.
        <br><br> 
        <p>
          <b>Threshold limit</b>: 20 requests per min per user<br>
          Number of API calls allowed within a minute.<br><br>
          <b>Lock period</b>: 10 minutes<br>Wait time before consecutive API requests.<br>
        </p>
        <b>Note:</b> For updating profile picture through the API, the scope <b>Profile.orguserphoto.UPDATE</b> should be included.
        <br><br>
        <table style="width: 100%; table-layout: fixed; border-collapse: collapse;">
          <tr>
            <th style="width: 35%; text-align: center; padding: 12px; background-color: #f5f5f5; border: 1px solid #ddd;">Error Code</th>
            <th style="width: 65%; text-align: center; padding: 12px; background-color: #f5f5f5; border: 1px solid #ddd;">Description</th>
          </tr>
          <tr>
            <td style="word-wrap: break-word; padding: 10px; border: 1px solid #ddd; vertical-align: top;">operation_not_allowed</td>
            <td style="padding: 10px; border: 1px solid #ddd; vertical-align: top;">The operation is not allowed because you might be trying to update another user's profile or trying to update a user who does not belong to your Cliq organization.</td>
          </tr>
        </table>
      parameters:
        - name: USER_ID
          in: path
          required: true
          schema:
            type: string
          example: USER_ID
          description: Unique identifier of the user whose details needs to be updated To learn how to retrieve this ID, see <a href="/cliq/help/restapi/v2/glossary/#USER_ID">USER_ID</a> in the Glossary page.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserRequest'
      responses:
        '200':
          description: The request was successfully completed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserResponse'
        '400':
          description: Bad Request.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: The request cannot be performed. Usually because of malformed parameter or missing parameter.
        '401':
          description: Unauthorized.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Request was rejected because of invalid AuthToken.
        '403':
          description: Forbidden.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: The user does not have enough permission or possibly not an user of the respective organization to access the resource.
        '404':
          description: Invalid URL.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: The URL you've sent is wrong. It's possible that the resource you've requested has been moved to another URL.
        '405':
          description: Method Not Allowed.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: The requested resource does not support the HTTP method used. For example, requesting List of all customers API with PUT as the HTTP method.
        '406':
          description: Not Acceptable.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: The response has been received but the requested response type is not supported by the browser.
        '429':
          description: Too many requests.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Too many requests within a certain time frame.
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Cliq server encountered an error which prevents it from fulfilling the request.
      security:
        - Cliq_Auth:
            - ZohoCliq.Users.UPDATE
            - Profile.orguserphoto.UPDATE
  /users/{USER_ID}/teams:
    get:
      summary: Fetch list of user teams
      operationId: Fetch list of user teams
      description: |
        Use  this API to fetch the list of teams that the user belongs to. Head on over here to know more about team object attributes.
        <br><br> 
        <p>
          <b>Threshold limit</b>: 20 requests per min per user<br>
          Number of API calls allowed within a minute.<br><br>
          <b>Lock period</b>: 10 minutes<br>Wait time before consecutive API requests.<br>
        </p>
      parameters:
        - name: USER_ID
          in: path
          required: true
          schema:
            type: string
          example: USER_ID
          description: Unique identifier of the user whose team information need to be retrieved To learn how to retrieve this ID, see <a href="/cliq/help/restapi/v2/glossary/#USER_ID">USER_ID</a> in the Glossary page.
      responses:
        '200':
          description: The request was successfully completed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TeamListResponse'
        '400':
          description: Bad Request.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: The request cannot be performed. Usually because of malformed parameter or missing parameter.
        '401':
          description: Unauthorized.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Request was rejected because of invalid AuthToken.
        '403':
          description: Forbidden.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: The user does not have enough permission or possibly not an user of the respective organization to access the resource.
        '404':
          description: Invalid URL.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: The URL you've sent is wrong. It's possible that the resource you've requested has been moved to another URL.
        '405':
          description: Method Not Allowed.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: The requested resource does not support the HTTP method used. For example, requesting List of all customers API with PUT as the HTTP method.
        '406':
          description: Not Acceptable.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: The response has been received but the requested response type is not supported by the browser.
        '429':
          description: Too many requests.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Too many requests within a certain time frame.
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Cliq server encountered an error which prevents it from fulfilling the request.
      security:
        - Cliq_Auth:
            - ZohoCliq.Users.READ
      tags:
        - users
  /users/layout:
    get:
      summary: List user field layouts
      operationId: List user field layouts
      description: |
        Use this API to fetch the list layouts configured for user fields.
        <br><br> 
        <p>
          <b>Threshold limit</b>: 10 requests per min per user<br>
          Number of API calls allowed within a minute.<br><br>
          <b>Lock period</b>: 10 minutes<br>Wait time before consecutive API requests.<br>
        </p>
      parameters:
        - name: unique_name
          in: query
          required: false
          schema:
            type: string
          description: |
            A unique name identifier for the user field layout.  
            Allowed values:
            <ul>
              <li><b>quick_view</b> - Layout shown in hover cards.
              <li><b>profile_details_android</b> - Layout shown in the Android app user profile.
              <li><b>profile_details_ios</b> - Layout shown in the iOS app user profile.
              <li><b>profile_details_web</b> - Layout shown in the web version user profile.
            </ul>
      responses:
        '200':
          description: The request was successfully completed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserLayoutResponse'
        '400':
          description: Bad Request.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: The request cannot be performed. Usually because of malformed parameter or missing parameter.
        '401':
          description: Unauthorized.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Request was rejected because of invalid AuthToken.
        '403':
          description: Forbidden.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: The user does not have enough permission or possibly not an user of the respective organization to access the resource.
        '404':
          description: Invalid URL.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: The URL you've sent is wrong. It's possible that the resource you've requested has been moved to another URL.
        '405':
          description: Method Not Allowed.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: The requested resource does not support the HTTP method used. For example, requesting List of all customers API with PUT as the HTTP method.
        '406':
          description: Not Acceptable.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: The response has been received but the requested response type is not supported by the browser.
        '429':
          description: Too many requests.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Too many requests within a certain time frame.
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Cliq server encountered an error which prevents it from fulfilling the request.
      security:
        - Cliq_Auth:
            - ZohoCliq.Users.READ
      tags:
        - users
components:
  schemas:
    UserRequest:
      type: object
      description: Request body to create or update one or more users.
      properties:
        users:
          type: array
          description: Array of user objects to be created or updated.
          items:
            type: object
            description: User object to be created or updated
            required:
              - email_id
            properties:
              email_id:
                type: string
                format: email
                description: The email ID of the user. (Mandatory)
                example: amy@zylker.com
              first_name:
                type: string
                description: The first name of the user.
                example: Amy
              last_name:
                type: string
                description: The last name of the user.
                example: Smith
              display_name:
                type: string
                description: The display name of the user.
                example: Amy Smith
              phone:
                type: string
                description: Phone number of the user.
                example: '04412345678'
              mobile:
                type: string
                description: Mobile number of the user.
                example: '9876543210'
              timezone:
                type: string
                description: User's timezone.
                example: Asia/Kolkata
              language:
                type: string
                description: User's default language.
                example: en
              country:
                type: string
                description: Country code of the user.
                example: IN
              designation_id:
                type: string
                description: ID of the designation to be associated with the user.
                example: D123456
              department_id:
                type: string
                description: ID of the department where the user will be added.
                example: Dept789
              reporting_to_zuid:
                type: string
                description: User ID of the reporting manager.
                example: ZU_1234567890
              work_location:
                type: string
                description: Work location of the user.
                example: Chennai Office
              extension:
                type: string
                description: The user's extension/desk phone number.
                example: '4021'
              employee_id:
                type: string
                description: The user's employee ID.
                example: EMP1234
              image_data:
                type: string
                format: byte
                description: The profile picture of the user in Base64 format.
              channel_ids:
                type: array
                description: IDs of the channels the user will be added to.
                items:
                  type: string
                  description: A single channel ID
                example:
                  - O1864232000000076001
                  - '02436281894678923571'
              team_ids:
                type: array
                description: IDs of the teams the user will be added to. To retrieve team IDs, use the <a href="/cliq/help/restapi/v2/teams/#list-all-teams">List all teams</a> API.
                items:
                  type: string
                  description: A single team ID
                example:
                  - '674269993'
                  - '122347899'
              Custom_Field_UniqueName:
                type: string
                description: |
                  Unique name of a custom user field.  
                  <ul>
                    <li>Note: This is not a static value and can change according to the user-defined field name.</li>
                    <li>Example: For a custom user field "Workplace Name", provide its unique name as the key and the desired value.</li>
                  </ul>
                example: workplace_name
    UserResponse:
      type: object
      description: Response returned after creating or updating users.
      properties:
        data:
          type: object
          properties:
            success_users:
              type: array
              items:
                type: string
              description: List of successfully created/updated users.
              example:
                - amy@zylker.com
                - riyaan@zylker.com
            failed_users:
              type: object
              additionalProperties:
                type: string
              description: Map of failed user emails to error messages.
              example: {}
    retrieve-user-response:
      type: object
      description: Response for retrieving a single user.
      properties:
        data:
          type: object
          properties:
            employee_id:
              type: string
              example: '213'
            first_name:
              type: string
              example: Scott
            reportingto:
              type: object
              properties:
                name:
                  type: string
                  example: Tim Harrison
                id:
                  type: string
                  example: '631831446'
            mobile:
              type: string
              example: 534 678 1234
            zoid:
              type: string
              example: '54107592'
            organization_id:
              type: string
              example: '631836344'
            email_id:
              type: string
              format: email
              example: scott.fisher@zylker.com
            extension:
              type: string
              example: '3129'
            work_location:
              type: string
              example: C block, S-H12
            id:
              type: string
              example: '631830849'
            timeoffset:
              type: integer
              example: 19800000
            timezone:
              type: string
              example: Asia/Kolkata
            language:
              type: string
              example: English
            status:
              type: string
              example: active
            country:
              type: string
              example: United States
            department:
              type: object
              properties:
                name:
                  type: string
                  example: Zylker Corp
                id:
                  type: string
                  example: '1901318000001424001'
            last_name:
              type: string
              example: Fisher
            full_name:
              type: string
              example: Scott Fisher
            designation:
              type: object
              properties:
                name:
                  type: string
                  example: Leadership Staff
                id:
                  type: string
                  example: '1901318000001072003'
            display_name:
              type: string
              example: Scott Fisher
            name:
              type: string
              example: Scott Fisher
    UserListResponse:
      type: object
      description: Response returned when listing users.
      properties:
        next_token:
          type: string
          example: 359868eb5dca56ghs721hak082ynoy85hakqovfewjbf41533
        has_more:
          type: boolean
          example: true
        data:
          type: array
          items:
            type: object
            properties:
              email_id:
                type: string
                format: email
              zuid:
                type: string
              zoid:
                type: string
              display_name:
                type: string
              name:
                type: string
              organization_id:
                type: string
              id:
                type: string
          example:
            - email_id: yoda@zylker.com
              zuid: '163315760'
              zoid: '54107592'
              display_name: Yod
              name: Yod Agbaria
              organization_id: '631836344'
              id: '163315760'
            - email_id: noweit@zylker.com
              zuid: '163317679'
              zoid: '54107592'
              display_name: No-Wei
              name: No-Wei Ting
              organization_id: '631836344'
              id: '163317679'
    TeamListResponse:
      type: object
      description: Response containing the list of teams in the organization.
      properties:
        data:
          type: array
          items:
            type: object
            properties:
              name:
                type: string
              creation_time:
                type: string
                format: date-time
              organization_id:
                type: string
              is_active:
                type: boolean
              is_moderator:
                type: boolean
              description:
                type: string
              team_id:
                type: integer
              joined:
                type: boolean
              participant_count:
                type: integer
          example:
            - name: Zylcal
              creation_time: '2017-10-19T08:36:24-07:00'
              organization_id: '54107592'
              is_active: true
              is_moderator: true
              description: Team working on the Zylker Calendar
              team_id: 655249742
              joined: true
              participant_count: 9
            - name: Zylker Website Revamp
              creation_time: '2019-09-05T21:31:30-07:00'
              organization_id: '54107592'
              is_active: true
              is_moderator: true
              description: To revamp Zylker's Website
              team_id: 695903787
              joined: true
              participant_count: 5
            - name: Zylnotes
              creation_time: '2019-09-06T04:18:56-07:00'
              organization_id: '54107592'
              is_active: true
              is_moderator: true
              description: Team for Zylnotes Project
              team_id: 695920980
              joined: true
              participant_count: 6
    UserLayoutResponse:
      type: object
      description: Response returning the layout configuration of user fields.
      properties:
        data:
          type: array
          items:
            type: object
            properties:
              unique_name:
                type: string
                example: profile_details_android
              sections:
                type: array
                items:
                  type: object
                  properties:
                    sequence_number:
                      type: integer
                      example: 1
                    label:
                      type: string
                      example: Work
                    unique_name:
                      type: string
                      example: work_info
                    system_defined:
                      type: boolean
                      example: true
                    fields:
                      type: array
                      items:
                        type: object
                        properties:
                          status:
                            type: string
                            example: enabled
                          sequence_number:
                            type: integer
                            example: 1
                          label:
                            type: string
                            example: Designation
                          unique_name:
                            type: string
                            example: designation
                          system_defined:
                            type: boolean
                            example: true
                          id:
                            type: string
                            example: '1901318000001264017'
          example:
            data:
              - unique_name: profile_details_android
                sections:
                  - sequence_number: 1
                    label: Work
                    unique_name: work_info
                    system_defined: true
                    fields:
                      - status: enabled
                        sequence_number: 1
                        label: Designation
                        unique_name: designation
                        system_defined: true
                        id: '1901318000001264017'
                      - status: enabled
                        sequence_number: 2
                        label: Department
                        unique_name: department
                        system_defined: true
                        id: '1901318000001264015'
      example:
        data:
          - unique_name: profile_details_android
            sections:
              - sequence_number: 1
                label: Work
                unique_name: work_info
                system_defined: true
                fields:
                  - status: enabled
                    sequence_number: 1
                    label: Designation
                    unique_name: designation
                    system_defined: true
                    id: '1901318000001264017'
                  - status: enabled
                    sequence_number: 2
                    label: Department
                    unique_name: department
                    system_defined: true
                    id: '1901318000001264015'
                  - status: enabled
                    sequence_number: 3
                    label: Reporting To
                    unique_name: reportingto
                    system_defined: true
                    id: '1901318000001264023'
                  - status: enabled
                    sequence_number: 4
                    label: Seating Location
                    unique_name: work_location
                    system_defined: true
                    id: '1901318000001264005'
                  - status: enabled
                    sequence_number: 5
                    label: Employee ID
                    unique_name: employee_id
                    system_defined: true
                    id: '1901318000001264013'
                  - status: enabled
                    sequence_number: 6
                    label: Status
                    unique_name: status
                    system_defined: true
                    id: '1901318000001468001'
              - sequence_number: 2
                label: Contact
                unique_name: contact_info
                system_defined: true
                fields:
                  - status: enabled
                    sequence_number: 1
                    label: Phone
                    unique_name: phone
                    system_defined: true
                    id: '1901318000001705005'
                  - status: enabled
                    sequence_number: 2
                    label: Mobile
                    unique_name: mobile
                    system_defined: true
                    id: '1901318000001264003'
                  - status: enabled
                    sequence_number: 3
                    label: Email
                    unique_name: email_id
                    system_defined: true
                    id: '1901318000001264011'
                  - status: enabled
                    sequence_number: 4
                    label: Extension
                    unique_name: extension
                    system_defined: true
                    id: '1901318000001264019'
  securitySchemes:
    Cliq_Auth:
      type: oauth2
      x-authorization-example: Bearer 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f
      flows:
        implicit:
          authorizationUrl: https://accounts.zoho.com/oauth/v2/auth
          scopes:
            ZohoCliq.Users.CREATE: Add Users
            ZohoCliq.Users.UPDATE: Update Users
            ZohoCliq.Users.READ: Read Users
