openapi: 3.0.0
info:
  title: Portals & Projects
  description: A Portal is an org-level setup in Apptics. It’s where an organisation can manage everything related to the projects (apps) you integrate with Apptics. All the projects, users, and settings for your organization live under this Portal. <br> A Project is a specific app or product that your organization is tracking or managing within the Portal. Each app gets its own Project so that data like user behavior, events, crashes, and analytics can be tracked separately and clearly.<br><br> Both Portal ID (zsoid) and Project ID are mandatory parameters for all other Apptics API endpoints. These identifiers establish the organizational context and specific app scope required for data retrieval across crashes, events, screens, and active devices analytics.
  contact: {}
  version: 1.0.0
servers:
  - url: https://apptics.zoho.com/cx/api/v1
    description: API Endpoint
tags:
  - name: projects
    description: List of portals and projects
paths:
  /userprojects:
    get:
      tags:
        - projects
      summary: Get the list of portals and projects
      description: Returns a list of portals and projects that are available for the user.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/userprojects-response'
      security:
        - Zoho_Auth:
            - JProxy.jmobileapi.ALL
components:
  schemas:
    userprojects-response:
      type: object
      properties:
        result:
          type: array
          items:
            type: object
            properties:
              projects:
                type: array
                items:
                  type: object
                  properties:
                    projectName:
                      type: string
                      example: Zoho Apptics
                    projectid:
                      type: string
                      example: 12345
              portalName:
                type: string
                example: pilot
              zsoid:
                type: string
                example: 12345
  securitySchemes:
    Zoho_Auth:
      type: oauth2
      flows:
        implicit:
          authorizationUrl: https://accounts.zoho.com/oauth/v2/auth
          scopes:
            JProxy.jmobileapi.ALL: Analytics & Insight view
