---
updatedAt: 2025-05-20T21:48:09.000Z
agentTools:
  projectIndex: https://developers.optt.health/llms.txt
---

# Get clinic dashboard information

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "version": "1.0.0",
    "title": "Profile APIs",
    "license": {
      "name": "Apache 2.0",
      "url": "http://www.apache.org/licenses/LICENSE-2.0.html"
    }
  },
  "tags": [
    {
      "name": "clinic-controller",
      "description": "Clinic Controller"
    }
  ],
  "paths": {
    "/clinic/dashboard": {
      "get": {
        "tags": [
          "clinic-controller"
        ],
        "summary": "Get clinic dashboard information",
        "operationId": "getDashboardUsingGET_2",
        "parameters": [
          {
            "name": "Authorization",
            "in": "header",
            "required": true,
            "schema": {
              "type": "string",
              "default": "bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE1OTk5MjYyNTgsInVzZXJfbmFtZSI6Imluc3RpdHV0ZSIsImF1dGhvcml0aWVzIjpbIklOU1RJVFVURSJdLCJqdGkiOiIyZDMzNGY5YS01OWFmLTRjMzctOWE0OS1iMGU4NzBhNTQzZjQiLCJjbGllbnRfaWQiOiJvcHR0LTAyZWU3N2RjLWFjNDUtNDM0NC04MTdlLTE3Y2E1MmI1OGI1ZCIsInNjb3BlIjpbInJlYWQiLCJ3cml0ZSJdfQ.ANh2KLL4IfolkPfaJ3JsUYQTFkpKxlXT5vCKzkwhvJsqUO5eBSErYB5H6c2kQvB3EWfLlFZAo1QQAgbHpkUm776qijWcncv77uT-drBvscInvBu0ahQh96Fdn9eXnbXrCBgt80RsZKkFI4W7SrziiVpXlFuUjKL4Jm5CkuK5dmAB6nPXJGnKx0qqg0uHfuHsHvJxfeoiqwz481oJ48dUx8W-CVDDAo79twFfqCmAm_yy8kgJe67_nGYfWPu6wY9Z5YCDnLiVM6Ky8md-hcQhScTIRAHql7nebfUIPb8h_J7jQbhAg2IwVLp92Xccp_F9gmeOu4O6dWy08Amstt1l2A"
            }
          },
          {
            "name": "offset",
            "in": "header",
            "description": "offset",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "*/*": {
                "schema": {
                  "$ref": "#/components/schemas/ClinicDashboardResponseModel"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "Forbidden"
          },
          "404": {
            "description": "Not Found"
          }
        }
      }
    }
  },
  "servers": [
    {
      "url": "//gwi.dv.optt.ca/gateway/profile/"
    }
  ],
  "components": {
    "schemas": {
      "AssignmentResponseModelPartial": {
        "type": "object",
        "properties": {
          "bookId": {
            "type": "integer",
            "format": "int64"
          },
          "caregiver": {
            "$ref": "#/components/schemas/CaregiverPartialResponseModel"
          },
          "client": {
            "$ref": "#/components/schemas/ClientPartialResponseModel"
          },
          "createDate": {
            "type": "string"
          },
          "id": {
            "type": "integer",
            "format": "int64"
          },
          "name": {
            "type": "string"
          },
          "startDate": {
            "type": "string"
          }
        },
        "title": "AssignmentResponseModelPartial"
      },
      "CaregiverPartialResponseModel": {
        "type": "object",
        "properties": {
          "activationStatus": {
            "type": "string",
            "enum": [
              "ACTIVE",
              "INACTIVE",
              "PENDING",
              "VERIFIED",
              "INVITED"
            ]
          },
          "clinicId": {
            "type": "integer",
            "format": "int64"
          },
          "createDate": {
            "type": "string"
          },
          "email": {
            "type": "string"
          },
          "id": {
            "type": "integer",
            "format": "int64"
          },
          "image": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "opttId": {
            "type": "string"
          },
          "position": {
            "type": "string"
          },
          "userId": {
            "type": "string"
          }
        },
        "title": "CaregiverPartialResponseModel"
      },
      "ClientPartialResponseModel": {
        "type": "object",
        "properties": {
          "activationStatus": {
            "type": "string",
            "enum": [
              "ACTIVE",
              "INACTIVE",
              "PENDING",
              "VERIFIED",
              "INVITED"
            ]
          },
          "chatId": {
            "type": "string"
          },
          "clinic": {
            "$ref": "#/components/schemas/ClinicResponseModel"
          },
          "clinicId": {
            "type": "integer",
            "format": "int64"
          },
          "clinicName": {
            "type": "string"
          },
          "createDate": {
            "type": "string"
          },
          "email": {
            "type": "string"
          },
          "id": {
            "type": "integer",
            "format": "int64"
          },
          "image": {
            "type": "string"
          },
          "lastSession": {
            "$ref": "#/components/schemas/SessionPartialResponseModel"
          },
          "lastSessionNote": {
            "$ref": "#/components/schemas/NoteResponseModel"
          },
          "name": {
            "type": "string"
          },
          "opttId": {
            "type": "string"
          },
          "patientId": {
            "type": "string"
          },
          "userId": {
            "type": "string"
          }
        },
        "title": "ClientPartialResponseModel"
      },
      "ClinicDashboardResponseModel": {
        "type": "object",
        "properties": {
          "address": {
            "type": "string"
          },
          "assignments": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/AssignmentResponseModelPartial"
            }
          },
          "caregivers": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CaregiverPartialResponseModel"
            }
          },
          "clients": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ClientPartialResponseModel"
            }
          },
          "email": {
            "type": "string"
          },
          "image": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "newCaregiverDailyCount": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/DailyCountModel"
            }
          },
          "newClientDailyCount": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/DailyCountModel"
            }
          },
          "phone": {
            "type": "string"
          },
          "sessions": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/SessionPartialResponseModel"
            }
          },
          "status": {
            "type": "string"
          },
          "topCaregivers": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/PartialResponseModel"
            }
          },
          "totalCaregivers": {
            "type": "integer",
            "format": "int32"
          },
          "totalClients": {
            "type": "integer",
            "format": "int32"
          }
        },
        "title": "ClinicDashboardResponseModel"
      },
      "ClinicResponseModel": {
        "type": "object",
        "properties": {
          "activationStatus": {
            "type": "string",
            "enum": [
              "ACTIVE",
              "INACTIVE",
              "PENDING",
              "VERIFIED",
              "INVITED"
            ]
          },
          "address": {
            "type": "string"
          },
          "adminOpttId": {
            "type": "string"
          },
          "adminUserId": {
            "type": "string"
          },
          "allowCo": {
            "type": "boolean"
          },
          "baseUrl": {
            "type": "string"
          },
          "contactPersonName": {
            "type": "string"
          },
          "cpmLink": {
            "type": "string"
          },
          "createDate": {
            "type": "string"
          },
          "domainId": {
            "type": "integer",
            "format": "int64"
          },
          "email": {
            "type": "string"
          },
          "healthCardRequired": {
            "type": "boolean"
          },
          "id": {
            "type": "integer",
            "format": "int64"
          },
          "image": {
            "type": "string"
          },
          "invitationToken": {
            "type": "string"
          },
          "language": {
            "type": "string",
            "enum": [
              "EN",
              "FR"
            ]
          },
          "name": {
            "type": "string"
          },
          "phoneNumber": {
            "type": "string"
          },
          "termConditionLink": {
            "type": "string"
          }
        },
        "title": "ClinicResponseModel"
      },
      "DailyCountModel": {
        "type": "object",
        "properties": {
          "count": {
            "type": "integer",
            "format": "int32"
          },
          "date": {
            "type": "string"
          },
          "day": {
            "type": "integer",
            "format": "int32"
          }
        },
        "title": "DailyCountModel"
      },
      "NoteResponseModel": {
        "type": "object",
        "properties": {
          "caregiverId": {
            "type": "integer",
            "format": "int64"
          },
          "caregiverImage": {
            "type": "string"
          },
          "caregiverName": {
            "type": "string"
          },
          "content": {
            "type": "string"
          },
          "date": {
            "type": "string"
          },
          "id": {
            "type": "integer",
            "format": "int64"
          },
          "isAutoSave": {
            "type": "boolean"
          },
          "sessionId": {
            "type": "integer",
            "format": "int64"
          }
        },
        "title": "NoteResponseModel"
      },
      "PartialResponseModel": {
        "type": "object",
        "properties": {
          "activationStatus": {
            "type": "string",
            "enum": [
              "ACTIVE",
              "INACTIVE",
              "PENDING",
              "VERIFIED",
              "INVITED"
            ]
          },
          "count": {
            "type": "integer",
            "format": "int64"
          },
          "date": {
            "type": "string"
          },
          "description": {
            "type": "string"
          },
          "email": {
            "type": "string"
          },
          "id": {
            "type": "integer",
            "format": "int64"
          },
          "image": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "position": {
            "type": "string"
          }
        },
        "title": "PartialResponseModel"
      },
      "SessionPartialResponseModel": {
        "type": "object",
        "properties": {
          "caregiver": {
            "$ref": "#/components/schemas/CaregiverPartialResponseModel"
          },
          "client": {
            "$ref": "#/components/schemas/ClientPartialResponseModel"
          },
          "createDate": {
            "type": "string"
          },
          "description": {
            "type": "string"
          },
          "id": {
            "type": "integer",
            "format": "int64"
          },
          "name": {
            "type": "string"
          },
          "sessionChatId": {
            "type": "string"
          },
          "sessionNote": {
            "type": "string"
          },
          "startDate": {
            "type": "string"
          }
        },
        "title": "SessionPartialResponseModel"
      }
    }
  },
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  }
}
```