Doctor Profiles

Function-calling namespace: doctorProfiles

Base URL: https://api.aivida.in
Engine endpoint: POST /api
Auth: Stack token middleware enabled in optional mode.
Send token in header: x-stack-access-token: <access_token> (or Authorization: Bearer <access_token>).
In optional mode: no token is allowed; invalid token is rejected with 401.

`delete`

Source: backend/endpoints/doctor-profiles/delete

Input Fields

Field	Type	Required	Constraints
`id`	`string`	Yes	-
`organizationId`	`string`	Yes	-

Example Request

curl -X POST https://api.aivida.in/api \
  -H "Content-Type: application/json" \
  -H "x-stack-access-token: <access_token_optional>" \
  -d '{
  "namespace": "doctorProfiles",
  "apiName": "delete",
  "data": {
    "id": "id_123",
    "organizationId": "org_123"
  }
}'

Example Response

{ "status": "ok", "data": {} }

`getById`

Source: backend/endpoints/doctor-profiles/get-by-id

Input Fields

Field	Type	Required	Constraints
`id`	`string`	Yes	-
`organizationId`	`string`	Yes	-

Example Request

curl -X POST https://api.aivida.in/api \
  -H "Content-Type: application/json" \
  -H "x-stack-access-token: <access_token_optional>" \
  -d '{
  "namespace": "doctorProfiles",
  "apiName": "getById",
  "data": {
    "id": "id_123",
    "organizationId": "org_123"
  }
}'

Example Response

{ "status": "ok", "data": {} }

`getByUserId`

Source: backend/endpoints/doctor-profiles/get-by-user-id

Input Fields

Field	Type	Required	Constraints
`userId`	`string`	Yes	-
`organizationId`	`string`	Yes	-

Example Request

curl -X POST https://api.aivida.in/api \
  -H "Content-Type: application/json" \
  -H "x-stack-access-token: <access_token_optional>" \
  -d '{
  "namespace": "doctorProfiles",
  "apiName": "getByUserId",
  "data": {
    "userId": "user_123",
    "organizationId": "org_123"
  }
}'

Example Response

{ "status": "ok", "data": {} }

`getByUserIdForPatient`

Source: backend/endpoints/doctor-profiles/get-by-user-id-for-patient

Input Fields

Field	Type	Required	Constraints
`userId`	`string`	Yes	-
`organizationId`	`string`	No	-

Example Request

curl -X POST https://api.aivida.in/api \
  -H "Content-Type: application/json" \
  -H "x-stack-access-token: <access_token_optional>" \
  -d '{
  "namespace": "doctorProfiles",
  "apiName": "getByUserIdForPatient",
  "data": {
    "userId": "user_123"
  }
}'

Example Response

{ "status": "ok", "data": {} }

`getCompleteById`

Source: backend/endpoints/doctor-profiles/get-complete-by-id

Input Fields

Field	Type	Required	Constraints
`doctorProfileId`	`string`	Yes	-

Example Request

curl -X POST https://api.aivida.in/api \
  -H "Content-Type: application/json" \
  -H "x-stack-access-token: <access_token_optional>" \
  -d '{
  "namespace": "doctorProfiles",
  "apiName": "getCompleteById",
  "data": {
    "doctorProfileId": "doctorprofile_123"
  }
}'

Example Response

{ "status": "ok", "data": {} }

`getSummaryByUserId`

Source: backend/endpoints/doctor-profiles/get-summary-by-user-id

Input Fields

Field	Type	Required	Constraints
`userId`	`string`	Yes	-
`organizationId`	`string`	No	-

Example Request

curl -X POST https://api.aivida.in/api \
  -H "Content-Type: application/json" \
  -H "x-stack-access-token: <access_token_optional>" \
  -d '{
  "namespace": "doctorProfiles",
  "apiName": "getSummaryByUserId",
  "data": {
    "userId": "user_123"
  }
}'

Example Response

{ "status": "ok", "data": {} }

`listByOrganization`

Source: backend/endpoints/doctor-profiles/list-by-organization

Input Fields

Field	Type	Required	Constraints
`organizationId`	`string`	Yes	-
`searchQuery`	`string`	No	nullable
`departmentId`	`string`	No	nullable
`page`	`integer`	No	-
`pageSize`	`integer`	No	-

Example Request

curl -X POST https://api.aivida.in/api \
  -H "Content-Type: application/json" \
  -H "x-stack-access-token: <access_token_optional>" \
  -d '{
  "namespace": "doctorProfiles",
  "apiName": "listByOrganization",
  "data": {
    "organizationId": "org_123"
  }
}'

Example Response

{ "status": "ok", "data": {} }

`listByPlatformDepartment`

Source: backend/endpoints/doctor-profiles/list-by-platform-department

Input Fields

Field	Type	Required	Constraints
`organizationId`	`string`	Yes	-
`platformDepartmentId`	`string`	No	-
`search`	`string`	No	nullable
`includeTherapists`	`boolean`	No	-

Example Request

curl -X POST https://api.aivida.in/api \
  -H "Content-Type: application/json" \
  -H "x-stack-access-token: <access_token_optional>" \
  -d '{
  "namespace": "doctorProfiles",
  "apiName": "listByPlatformDepartment",
  "data": {
    "organizationId": "org_123"
  }
}'

Example Response

{ "status": "ok", "data": {} }

`listWithStatusByOrganization`

Source: backend/endpoints/doctor-profiles/list-with-status-by-organization

Input Fields

Field	Type	Required	Constraints
`organizationId`	`string`	Yes	-
`search`	`string`	No	-
`status`	`string`	No	-
`page`	`integer`	No	-
`pageSize`	`integer`	No	-

Example Request

curl -X POST https://api.aivida.in/api \
  -H "Content-Type: application/json" \
  -H "x-stack-access-token: <access_token_optional>" \
  -d '{
  "namespace": "doctorProfiles",
  "apiName": "listWithStatusByOrganization",
  "data": {
    "organizationId": "org_123"
  }
}'

Example Response

{ "status": "ok", "data": {} }

`update`

Source: backend/endpoints/doctor-profiles/update

Input Fields

Field	Type	Required	Constraints
`id`	`string`	Yes	-
`organizationId`	`string`	Yes	-
`name`	`string`	No	nullable
`email`	`string`	No	nullable
`userId`	`string`	No	nullable
`departmentId`	`string`	No	nullable
`experience`	`integer`	No	nullable
`experiences`	`array<object>`	No	nullable
`bio`	`string`	No	nullable
`languages`	`array<string>`	No	nullable
`conditions`	`array<string>`	No	nullable
`gender`	`string`	No	nullable
`registrationNumber`	`string`	No	nullable
`doctorSignature`	`string`	No	nullable
`isAvailableForOnline`	`boolean`	No	nullable
`weeklySchedule`	`array<object>`	No	nullable
`slotDuration`	`integer`	No	nullable
`profileImageId`	`string`	No	nullable
`profileImageUrl`	`string`	No	nullable
`education`	`array<object>`	No	nullable
`awards`	`array<string>`	No	nullable
`phone`	`string`	No	nullable
`address`	`string`	No	nullable
`isVerified`	`boolean`	No	nullable
`verifiedAt`	`integer`	No	unix-ms timestamp; nullable
`documents`	`array<object>`	No	nullable

Nested Field Structures

`experiences` item

Field	Type	Required	Constraints
`id`	`string`	No	-
`designation`	`string`	No	-
`hospitalName`	`string`	No	-
`startYear`	`string`	No	-
`endYear`	`string`	No	-
`isCurrent`	`boolean`	No	-
`experienceLabel`	`string`	No	-
`createdAt`	`integer`	No	unix-ms timestamp
`updatedAt`	`integer`	No	unix-ms timestamp

`weeklySchedule` item

Field	Type	Required	Constraints
`day`	`string`	No	-
`startTime`	`string`	No	format: HH:mm
`endTime`	`string`	No	format: HH:mm
`isActive`	`boolean`	No	-
`slotDuration`	`integer`	No	nullable
`breakEnabled`	`boolean`	No	nullable
`breakInterval`	`integer`	No	nullable
`breakDuration`	`integer`	No	nullable

`education` item

Field	Type	Required	Constraints
`id`	`string`	No	-
`degree`	`string`	No	-
`institute`	`string`	No	-
`startYear`	`string`	No	-
`endYear`	`string`	No	-
`year`	`string`	No	-
`educationStatus`	`string`	No	-
`educationLabel`	`string`	No	-
`createdAt`	`integer`	No	unix-ms timestamp
`updatedAt`	`integer`	No	unix-ms timestamp

`documents` item

Field	Type	Required	Constraints
`type`	`string`	No	-
`name`	`string`	No	-
`url`	`string`	No	-
`uploadedAt`	`integer`	No	unix-ms timestamp

Example Request

curl -X POST https://api.aivida.in/api \
  -H "Content-Type: application/json" \
  -H "x-stack-access-token: <access_token_optional>" \
  -d '{
  "namespace": "doctorProfiles",
  "apiName": "update",
  "data": {
    "id": "id_123",
    "organizationId": "org_123"
  }
}'

Example Response

{ "status": "ok", "data": {} }

`updateByUserId`

Source: backend/endpoints/doctor-profiles/update-by-user-id

Input Fields

Field	Type	Required	Constraints
`userId`	`string`	Yes	-
`organizationId`	`string`	Yes	-
`name`	`string`	No	nullable
`email`	`string`	No	nullable
`userIdUpdate`	`string`	No	format: YYYY-MM-DD; nullable
`departmentId`	`string`	No	nullable
`experience`	`integer`	No	nullable
`experiences`	`array<object>`	No	nullable
`bio`	`string`	No	nullable
`languages`	`array<string>`	No	nullable
`conditions`	`array<string>`	No	nullable
`gender`	`string`	No	nullable
`registrationNumber`	`string`	No	nullable
`doctorSignature`	`string`	No	nullable
`isAvailableForOnline`	`boolean`	No	nullable
`weeklySchedule`	`array<object>`	No	nullable
`slotDuration`	`integer`	No	nullable
`profileImageId`	`string`	No	nullable
`profileImageUrl`	`string`	No	nullable
`education`	`array<object>`	No	nullable
`awards`	`array<string>`	No	nullable
`phone`	`string`	No	nullable
`address`	`string`	No	nullable
`isVerified`	`boolean`	No	nullable
`verifiedAt`	`integer`	No	unix-ms timestamp; nullable
`documents`	`array<object>`	No	nullable

Nested Field Structures

`experiences` item

Field	Type	Required	Constraints
`id`	`string`	No	-
`designation`	`string`	No	-
`hospitalName`	`string`	No	-
`startYear`	`string`	No	-
`endYear`	`string`	No	-
`isCurrent`	`boolean`	No	-
`experienceLabel`	`string`	No	-
`createdAt`	`integer`	No	unix-ms timestamp
`updatedAt`	`integer`	No	unix-ms timestamp

`weeklySchedule` item

Field	Type	Required	Constraints
`day`	`string`	No	-
`startTime`	`string`	No	format: HH:mm
`endTime`	`string`	No	format: HH:mm
`isActive`	`boolean`	No	-
`slotDuration`	`integer`	No	nullable
`breakEnabled`	`boolean`	No	nullable
`breakInterval`	`integer`	No	nullable
`breakDuration`	`integer`	No	nullable

`education` item

Field	Type	Required	Constraints
`id`	`string`	No	-
`degree`	`string`	No	-
`institute`	`string`	No	-
`startYear`	`string`	No	-
`endYear`	`string`	No	-
`year`	`string`	No	-
`educationStatus`	`string`	No	-
`educationLabel`	`string`	No	-
`createdAt`	`integer`	No	unix-ms timestamp
`updatedAt`	`integer`	No	unix-ms timestamp

`documents` item

Field	Type	Required	Constraints
`type`	`string`	No	-
`name`	`string`	No	-
`url`	`string`	No	-
`uploadedAt`	`integer`	No	unix-ms timestamp

Example Request

curl -X POST https://api.aivida.in/api \
  -H "Content-Type: application/json" \
  -H "x-stack-access-token: <access_token_optional>" \
  -d '{
  "namespace": "doctorProfiles",
  "apiName": "updateByUserId",
  "data": {
    "userId": "user_123",
    "organizationId": "org_123"
  }
}'

Example Response

{ "status": "ok", "data": {} }

Doctor Languages Doctor Reserved Slots

Doctor Profiles

delete

Input Fields

Example Request

Example Response

getById

Input Fields

Example Request

Example Response

getByUserId

Input Fields

Example Request

Example Response

getByUserIdForPatient

Input Fields

Example Request

Example Response

getCompleteById

Input Fields

Example Request

Example Response

getSummaryByUserId

Input Fields

Example Request

Example Response

listByOrganization

Input Fields

Example Request

Example Response

listByPlatformDepartment

Input Fields

Example Request

Example Response

listWithStatusByOrganization

Input Fields

Example Request

Example Response

update

Input Fields

Nested Field Structures

experiences item

weeklySchedule item

education item

documents item

Example Request

Example Response

updateByUserId

Input Fields

Nested Field Structures

experiences item

weeklySchedule item

education item

documents item

Example Request

Example Response

`delete`

`getById`

`getByUserId`

`getByUserIdForPatient`

`getCompleteById`

`getSummaryByUserId`

`listByOrganization`

`listByPlatformDepartment`

`listWithStatusByOrganization`

`update`

`experiences` item

`weeklySchedule` item

`education` item

`documents` item

`updateByUserId`

`experiences` item

`weeklySchedule` item

`education` item

`documents` item