Services

Function-calling namespace: services

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.

`checkServiceDependencies`

Source: backend/endpoints/services/check-service-dependencies

Input Fields

Field	Type	Required	Constraints
`organizationId`	`string`	Yes	-
`serviceId`	`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": "services",
  "apiName": "checkServiceDependencies",
  "data": {
    "organizationId": "org_123",
    "serviceId": "service_123"
  }
}'

Example Response

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

`create`

Source: backend/endpoints/services/create

Input Fields

Field	Type	Required	Constraints
`usage`	`object`	No	nullable
`_id`	`string`	No	-
`organizationId`	`string`	No	-
`organization`	`object`	No	nullable
`categoryId`	`string`	No	-
`categoryIds`	`array<string>`	No	-
`category`	`object`	No	nullable
`platformCategoryId`	`string`	No	-
`platformCategoryIds`	`array<string>`	No	-
`platformCategory`	`object`	No	nullable
`departmentId`	`string`	No	-
`platformDepartmentId`	`string`	No	-
`department`	`object`	No	nullable
`platformDepartment`	`object`	No	nullable
`name`	`string`	No	-
`code`	`string`	No	-
`description`	`string`	No	-
`imageId`	`string`	No	-
`imageUrl`	`array<string>`	No	-
`type`	`string`	No	-
`serviceCategory`	`string`	No	-
`chargeType`	`string`	No	-
`unit`	`string`	No	-
`basePrice`	`number`	No	-
`mrp`	`number`	No	nullable
`minAge`	`integer`	No	nullable
`maxAge`	`integer`	No	nullable
`consumeTypeId`	`string`	No	-
`hsnCode`	`string`	No	-
`batchNumber`	`string`	No	-
`expiryDate`	`string`	No	format: YYYY-MM-DD
`dosage`	`string`	No	-
`prescriptionType`	`string`	No	-
`sideEffects`	`array<object>`	No	-
`safetyAdvice`	`array<object>`	No	-
`discount`	`number`	No	-
`currency`	`string`	No	-
`gender`	`array<string>`	No	-
`doctorId`	`string`	No	-
`doctorProfile`	`object`	No	nullable
`user`	`object`	No	nullable
`isAvailableToday`	`boolean`	No	-
`consultationTypes`	`array<string>`	No	-
`consultationType`	`string`	No	-
`isHomeCollectionAvailable`	`boolean`	No	-
`sampleType`	`string`	No	-
`videoUrl`	`array<string>`	No	-
`faq`	`array<object>`	No	-
`metadata`	`object`	No	nullable
`totalReviews`	`integer`	No	-
`averageRatings`	`number`	No	-
`isBestSeller`	`boolean`	No	-
`feedbacks`	`array<object>`	No	-
`isActive`	`boolean`	No	-
`isPublic`	`boolean`	No	-
`isDeleted`	`boolean`	No	nullable
`deletedAt`	`integer`	No	unix-ms timestamp; nullable
`createdAt`	`integer`	No	unix-ms timestamp
`updatedAt`	`integer`	No	unix-ms timestamp
`status`	`string`	No	-

Nested Field Structures

`organization`

Field	Type	Required	Constraints
`_id`	`string`	No	-
`stackTeamId`	`string`	No	-
`name`	`string`	No	-
`slug`	`string`	No	-
`verificationStatus`	`string`	No	-
`type`	`string`	No	-
`organizationTypeId`	`string`	No	-
`organizationTypeName`	`string`	No	-
`facilities`	`object`	No	-
`logoId`	`string`	No	-
`logoUrl`	`string`	No	-
`settings`	`object`	No	-
`address`	`object`	No	-
`coordinates`	`object`	No	-
`addressStreet`	`string`	No	-
`addressCity`	`string`	No	-
`addressState`	`string`	No	-
`addressPostalCode`	`string`	No	-
`addressCountry`	`string`	No	-
`contactEmail`	`string`	No	-
`contactPhone`	`string`	No	-
`contactCustomerCarePhone`	`string`	No	-
`contactCustomerCareEmail`	`string`	No	-
`bankDetails`	`object`	No	-
`openingHours`	`object`	No	-
`serviceAudiences`	`array<string>`	No	-
`serviceOccasions`	`array<string>`	No	-
`commissionPercent`	`number`	No	-
`totalReviews`	`integer`	No	-
`averageRatings`	`number`	No	-
`isActive`	`boolean`	No	-
`isDeleted`	`boolean`	No	-
`deletedAt`	`integer`	No	unix-ms timestamp; nullable
`createdAt`	`integer`	No	unix-ms timestamp
`updatedAt`	`integer`	No	unix-ms timestamp

`category`

Field	Type	Required	Constraints
`_id`	`string`	No	-
`organizationId`	`string`	No	-
`platformCategoryId`	`string`	No	-
`name`	`string`	No	-
`code`	`string`	No	-
`type`	`string`	No	-
`description`	`string`	No	-
`icon`	`string`	No	-
`sortOrder`	`integer`	No	-
`isActive`	`boolean`	No	-
`createdAt`	`integer`	No	unix-ms timestamp
`updatedAt`	`integer`	No	unix-ms timestamp

`platformCategory`

Field	Type	Required	Constraints
`_id`	`string`	No	-
`name`	`string`	No	-
`code`	`string`	No	-
`slug`	`string`	No	-
`type`	`string`	No	-
`description`	`string`	No	-
`imageUrl`	`string`	No	-
`videoUrl`	`string`	No	-
`isActive`	`boolean`	No	-
`sortOrder`	`integer`	No	-
`parentIds`	`array<string>`	No	-
`organizationTypeIds`	`array<string>`	No	-
`organizationTypeNames`	`array<string>`	No	-
`dependentServicesCount`	`integer`	No	-
`createdAt`	`integer`	No	unix-ms timestamp
`updatedAt`	`integer`	No	unix-ms timestamp

`department`

Field	Type	Required	Constraints
`_id`	`string`	No	-
`organizationId`	`string`	No	-
`platformDepartmentId`	`string`	No	-
`name`	`string`	No	-
`code`	`string`	No	-
`description`	`string`	No	-
`hodUserId`	`string`	No	-
`operatingHours`	`object`	No	nullable
`isActive`	`boolean`	No	-
`createdAt`	`integer`	No	unix-ms timestamp
`updatedAt`	`integer`	No	unix-ms timestamp

`platformDepartment`

Field	Type	Required	Constraints
`_id`	`string`	No	-
`name`	`string`	No	-
`code`	`string`	No	-
`description`	`string`	No	-
`category`	`string`	No	-
`imageUrl`	`string`	No	-
`role`	`string`	No	-
`roles`	`array<string>`	No	-
`serviceCount`	`integer`	No	-
`isActive`	`boolean`	No	-
`createdAt`	`integer`	No	unix-ms timestamp
`updatedAt`	`integer`	No	unix-ms timestamp

`sideEffects` item

Field	Type	Required	Constraints
`title`	`string`	No	-
`description`	`string`	No	-

`safetyAdvice` item

Field	Type	Required	Constraints
`type`	`string`	No	-
`status`	`string`	No	-
`message`	`string`	No	-

`doctorProfile`

Field	Type	Required	Constraints
`_id`	`string`	No	-
`userId`	`string`	No	-
`displayName`	`string`	No	-
`user`	`object`	No	nullable
`organizationId`	`string`	No	-
`departmentId`	`string`	No	-
`department`	`object`	No	nullable
`platformDepartment`	`object`	No	nullable
`experience`	`integer`	No	nullable
`experiences`	`array<object>`	No	-
`bio`	`string`	No	-
`languages`	`array<string>`	No	-
`conditions`	`array<string>`	No	-
`gender`	`string`	No	-
`registrationNumber`	`string`	No	-
`doctorSignature`	`string`	No	-
`isAvailableForOnline`	`boolean`	No	-
`weeklySchedule`	`array<object>`	No	-
`slotDuration`	`integer`	No	nullable
`profileImageId`	`string`	No	-
`profileImageUrl`	`string`	No	-
`education`	`array<object>`	No	-
`awards`	`array<string>`	No	-
`phone`	`string`	No	-
`address`	`string`	No	-
`isVerified`	`boolean`	No	nullable
`verifiedAt`	`integer`	No	unix-ms timestamp; nullable
`documents`	`array<object>`	No	-
`totalReviews`	`integer`	No	-
`averageRating`	`number`	No	-
`createdAt`	`integer`	No	unix-ms timestamp
`updatedAt`	`integer`	No	unix-ms timestamp

`user`

Field	Type	Required	Constraints
`_id`	`string`	No	-
`stackUserId`	`string`	No	-
`organizationId`	`string`	No	-
`organizationBranchIds`	`array<string>`	No	-
`organizationBranches`	`array<object>`	No	-
`email`	`string`	No	-
`title`	`string`	No	nullable
`displayName`	`string`	No	-
`avatarUrl`	`string`	No	-
`role`	`string`	No	-
`roles`	`array<string>`	No	-
`isActive`	`boolean`	No	nullable
`isBlocked`	`boolean`	No	nullable
`blockedAt`	`integer`	No	unix-ms timestamp; nullable
`blockedBy`	`string`	No	-
`lastLoginAt`	`integer`	No	unix-ms timestamp; nullable
`isVerified`	`boolean`	No	nullable
`verifiedAt`	`integer`	No	unix-ms timestamp; nullable
`verifiedBy`	`string`	No	-
`gender`	`string`	No	nullable
`yoe`	`integer`	No	nullable
`totalReviews`	`integer`	No	-
`averageRatings`	`number`	No	-
`createdAt`	`integer`	No	unix-ms timestamp
`updatedAt`	`integer`	No	unix-ms timestamp

`metadata`

Field	Type	Required	Constraints
`sampleType`	`string`	No	-
`turnaroundTime`	`string`	No	format: HH:mm
`manufacturer`	`string`	No	-
`dosageForm`	`string`	No	-
`strength`	`string`	No	-
`composition`	`string`	No	-
`packSize`	`string`	No	-
`modality`	`string`	No	-
`bodyPart`	`string`	No	-
`locationId`	`string`	No	-
`category`	`string`	No	-
`durationMinutes`	`integer`	No	nullable
`modelNumber`	`string`	No	-
`specifications`	`string`	No	-
`stockQuantity`	`number`	No	nullable
`reorderLevel`	`number`	No	nullable
`lastStockUpdate`	`number`	No	nullable

`feedbacks` item

Field	Type	Required	Constraints
`id`	`string`	No	-
`providerOrderId`	`string`	No	-
`serviceId`	`string`	No	-
`patientId`	`string`	No	-
`rating`	`integer`	No	-
`review`	`string`	No	-
`images`	`array<string>`	No	-
`createdAt`	`integer`	No	unix-ms timestamp
`updatedAt`	`integer`	No	unix-ms timestamp
`patientDetails`	`object`	No	nullable

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": "services",
  "apiName": "create",
  "data": {
    "organizationId": "org_123",
    "doctorId": "doctor_123",
    "name": "value",
    "status": "scheduled",
    "organization": {
      "_id": "__123",
      "stackTeamId": "org_123",
      "name": "value",
      "slug": "value",
      "verificationStatus": "scheduled",
      "type": "general",
      "organizationTypeId": "organizationtype_123",
      "organizationTypeName": "value",
      "facilities": {},
      "logoId": "logo_123",
      "logoUrl": "value",
      "settings": {},
      "address": "221B Baker Street",
      "coordinates": {},
      "addressStreet": "221B Baker Street",
      "addressCity": "221B Baker Street",
      "addressState": "221B Baker Street",
      "addressPostalCode": "221B Baker Street",
      "addressCountry": "221B Baker Street",
      "contactEmail": "user@example.com",
      "contactPhone": "+911234567890",
      "contactCustomerCarePhone": "+911234567890",
      "contactCustomerCareEmail": "user@example.com",
      "bankDetails": {},
      "openingHours": {},
      "serviceAudiences": [
        "value"
      ],
      "serviceOccasions": [
        "value"
      ],
      "commissionPercent": 1,
      "totalReviews": 1,
      "averageRatings": 1,
      "isActive": true,
      "isDeleted": false,
      "deletedAt": 1710201600000,
      "createdAt": 1710201600000,
      "updatedAt": 1710201600000
    },
    "category": {
      "_id": "__123",
      "organizationId": "org_123",
      "platformCategoryId": "platformcategory_123",
      "name": "value",
      "code": "value",
      "type": "general",
      "description": "value",
      "icon": "value",
      "sortOrder": 1,
      "isActive": true,
      "createdAt": 1710201600000,
      "updatedAt": 1710201600000
    },
    "platformCategory": {
      "_id": "__123",
      "name": "value",
      "code": "value",
      "slug": "value",
      "type": "general",
      "description": "value",
      "imageUrl": "value",
      "videoUrl": "value",
      "isActive": true,
      "sortOrder": 1,
      "parentIds": [
        "value"
      ],
      "organizationTypeIds": [
        "value"
      ],
      "organizationTypeNames": [
        "value"
      ],
      "dependentServicesCount": 1,
      "createdAt": 1710201600000,
      "updatedAt": 1710201600000
    },
    "department": {
      "_id": "__123",
      "organizationId": "org_123",
      "platformDepartmentId": "org_123",
      "name": "value",
      "code": "value",
      "description": "value",
      "hodUserId": "hoduser_123",
      "operatingHours": {
        "openTime": "10:30",
        "closeTime": "10:30",
        "daysOpen": [
          "value"
        ]
      },
      "isActive": true,
      "createdAt": 1710201600000,
      "updatedAt": 1710201600000
    },
    "platformDepartment": {
      "_id": "__123",
      "name": "value",
      "code": "value",
      "description": "value",
      "category": "value",
      "imageUrl": "value",
      "role": "value",
      "roles": [
        "value"
      ],
      "serviceCount": 1,
      "isActive": true,
      "createdAt": 1710201600000,
      "updatedAt": 1710201600000
    },
    "sideEffects": [
      {
        "title": "value",
        "description": "value"
      }
    ],
    "safetyAdvice": [
      {
        "type": "general",
        "status": "scheduled",
        "message": "value"
      }
    ],
    "doctorProfile": {
      "_id": "__123",
      "userId": "user_123",
      "displayName": "value",
      "user": {
        "_id": "__123",
        "stackUserId": "stackuser_123",
        "organizationId": "org_123",
        "organizationBranchIds": [
          "value"
        ],
        "organizationBranches": [
          {
            "_id": "__123",
            "organizationId": "org_123",
            "branchName": "value",
            "branchCode": "value",
            "branchType": "general",
            "description": "value",
            "managerName": "value",
            "managerContact": "value",
            "streetAddress": "221B Baker Street",
            "area": "value",
            "city": "Bengaluru",
            "state": "Karnataka",
            "postalCode": "value",
            "country": "India",
            "coordinates": {},
            "contactPhone": "+911234567890",
            "telephoneNumber": "+911234567890",
            "contactEmail": "user@example.com",
            "website": "value",
            "emergencyContact": "value",
            "openingHours": {},
            "coverImageUrl": "value",
            "status": "scheduled",
            "isActive": true,
            "isDeleted": false,
            "deletedAt": 1710201600000,
            "createdAt": 1710201600000,
            "updatedAt": 1710201600000
          }
        ],
        "email": "user@example.com",
        "title": "value",
        "displayName": "value",
        "avatarUrl": "value",
        "role": "value",
        "roles": [
          "value"
        ],
        "isActive": true,
        "isBlocked": true,
        "blockedAt": 1710201600000,
        "blockedBy": "value",
        "lastLoginAt": 1710201600000,
        "isVerified": true,
        "verifiedAt": 1710201600000,
        "verifiedBy": "value",
        "gender": "value",
        "yoe": 1,
        "totalReviews": 1,
        "averageRatings": 1,
        "createdAt": 1710201600000,
        "updatedAt": 1710201600000
      },
      "organizationId": "org_123",
      "departmentId": "department_123",
      "department": {
        "_id": "__123",
        "organizationId": "org_123",
        "platformDepartmentId": "org_123",
        "name": "value",
        "code": "value",
        "description": "value",
        "hodUserId": "hoduser_123",
        "operatingHours": {
          "openTime": "10:30",
          "closeTime": "10:30",
          "daysOpen": [
            "value"
          ]
        },
        "isActive": true,
        "createdAt": 1710201600000,
        "updatedAt": 1710201600000
      },
      "platformDepartment": {
        "_id": "__123",
        "name": "value",
        "code": "value",
        "description": "value",
        "category": "value",
        "imageUrl": "value",
        "role": "value",
        "roles": [
          "value"
        ],
        "serviceCount": 1,
        "isActive": true,
        "createdAt": 1710201600000,
        "updatedAt": 1710201600000
      },
      "experience": 1,
      "experiences": [
        {
          "id": "id_123",
          "designation": "value",
          "hospitalName": "value",
          "startYear": "value",
          "endYear": "value",
          "isCurrent": true,
          "experienceLabel": "value",
          "createdAt": 1710201600000,
          "updatedAt": 1710201600000
        }
      ],
      "bio": "value",
      "languages": [
        "value"
      ],
      "conditions": [
        "diabetes",
        "fever"
      ],
      "gender": "value",
      "registrationNumber": "value",
      "doctorSignature": "value",
      "isAvailableForOnline": true,
      "weeklySchedule": [
        {
          "day": "value",
          "startTime": "10:30",
          "endTime": "10:30",
          "isActive": true,
          "slotDuration": 1,
          "breakEnabled": true,
          "breakInterval": 1,
          "breakDuration": 1
        }
      ],
      "slotDuration": 1,
      "profileImageId": "profileimage_123",
      "profileImageUrl": "value",
      "education": [
        {
          "id": "id_123",
          "degree": "value",
          "institute": "value",
          "startYear": "value",
          "endYear": "value",
          "year": "value",
          "educationStatus": "scheduled",
          "educationLabel": "value",
          "createdAt": 1710201600000,
          "updatedAt": 1710201600000
        }
      ],
      "awards": [
        "value"
      ],
      "phone": "+911234567890",
      "address": "221B Baker Street",
      "isVerified": true,
      "verifiedAt": 1710201600000,
      "documents": [
        {
          "type": "general",
          "name": "value",
          "url": "value",
          "uploadedAt": 1710201600000
        }
      ],
      "totalReviews": 1,
      "averageRating": 1,
      "createdAt": 1710201600000,
      "updatedAt": 1710201600000
    }
  }
}'

Example Response

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

`delete`

Source: backend/endpoints/services/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": "services",
  "apiName": "delete",
  "data": {
    "id": "id_123",
    "organizationId": "org_123"
  }
}'

Example Response

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

`getById`

Source: backend/endpoints/services/get-by-id

Input Fields

Field	Type	Required	Constraints
`id`	`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": "services",
  "apiName": "getById",
  "data": {
    "id": "id_123"
  }
}'

Example Response

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

`getPharmacyCatalogPublic`

Source: backend/endpoints/services/get-pharmacy-catalog-public

Input Fields

Field	Type	Required	Constraints
`organizationId`	`string`	Yes	-
`limitItemsPerCategory`	`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": "services",
  "apiName": "getPharmacyCatalogPublic",
  "data": {
    "organizationId": "org_123"
  }
}'

Example Response

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

`getStats`

Source: backend/endpoints/services/get-stats

Input Fields

Field	Type	Required	Constraints
`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": "services",
  "apiName": "getStats",
  "data": {
    "organizationId": "org_123"
  }
}'

Example Response

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

`getSystemServiceById`

Source: backend/endpoints/services/get-system-service-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": "services",
  "apiName": "getSystemServiceById",
  "data": {
    "id": "id_123",
    "organizationId": "org_123"
  }
}'

Example Response

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

`list`

Source: backend/endpoints/services/list

Input Fields

Field	Type	Required	Constraints
`organizationId`	`string`	Yes	-
`type`	`array<string>`	No	-
`search`	`string`	No	-
`page`	`integer`	No	-
`pageSize`	`integer`	No	-
`includeDeleted`	`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": "services",
  "apiName": "list",
  "data": {
    "organizationId": "org_123"
  }
}'

Example Response

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

`listActiveLabServices`

Source: backend/endpoints/services/list-active-lab-services

Input Fields

Field	Type	Required	Constraints
`organizationId`	`string`	Yes	-
`type`	`array<string>`	No	-
`search`	`string`	No	-
`sortBy`	`string`	No	-
`sortOrder`	`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": "services",
  "apiName": "listActiveLabServices",
  "data": {
    "organizationId": "org_123"
  }
}'

Example Response

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

`listAllActiveServices`

Source: backend/endpoints/services/list-all-active-services

Input Fields

Field	Type	Required	Constraints
`type`	`array<string>`	No	-
`search`	`string`	No	-
`organizationId`	`array<string>`	No	-
`consultationTypes`	`array<string>`	No	-
`specialization`	`array<string>`	No	-
`conditions`	`array<string>`	No	-
`languages`	`array<string>`	No	-
`gender`	`array<string>`	No	-
`rating`	`number`	No	nullable
`departmentId`	`array<string>`	No	-
`categoryId`	`array<string>`	No	-
`minPrice`	`number`	No	nullable
`maxPrice`	`number`	No	nullable
`medicineNames`	`array<string>`	No	-
`labTestNames`	`array<string>`	No	-
`nearBy`	`object`	No	nullable
`sortBy`	`string`	No	-
`cursor`	`string`	No	-
`page`	`integer`	No	-
`pageSize`	`integer`	No	-

Nested Field Structures

`nearBy`

Field	Type	Required	Constraints
`lat`	`number`	No	unix-ms timestamp; nullable
`lot`	`number`	No	nullable
`latitude`	`number`	No	nullable
`longitude`	`number`	No	nullable
`radiusKm`	`number`	No	nullable
`addressStreet`	`string`	No	-
`addressCity`	`string`	No	-
`addressState`	`string`	No	-
`addressPostalCode`	`string`	No	-
`addressCountry`	`string`	No	-

Filter Notes

conditions accepts condition names or condition IDs, for example ["diabetes", "fever"].
When conditions is sent without type, the backend filters consultation services because conditions belong to doctor profiles.
The filter checks the normalized doctor-profile-condition mapping table and falls back to the legacy doctor_profiles.conditions JSON data during migration.
type, organizationId, specialization, conditions, languages, gender, departmentId, categoryId, and medicineNames accept either a string, comma-separated string, or array of strings.

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": "services",
  "apiName": "listAllActiveServices",
  "data": {
    "conditions": [
      "diabetes",
      "fever"
    ],
    "page": 1,
    "pageSize": 20
  }
}'

Example Response

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

`listByCategory`

Source: backend/endpoints/services/list-by-category

Input Fields

Field	Type	Required	Constraints
`categoryId`	`string`	Yes	-
`page`	`integer`	No	-
`pageSize`	`integer`	No	-
`organizationTypeIds`	`array<string>`	No	-
`organizationTypeId`	`string`	No	nullable

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": "services",
  "apiName": "listByCategory",
  "data": {
    "categoryId": "category_123"
  }
}'

Example Response

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

`listByOrganization`

Source: backend/endpoints/services/list-by-organization

Input Fields

Field	Type	Required	Constraints
`organizationId`	`string`	Yes	-
`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": "services",
  "apiName": "listByOrganization",
  "data": {
    "organizationId": "org_123"
  }
}'

Example Response

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

`listDiagnosticTests`

Source: backend/endpoints/services/list-diagnostic-tests

Input Fields

Field	Type	Required	Constraints
`organizationId`	`string`	No	-
`organizationIds`	`array<string>`	No	-
`categoryId`	`string`	No	-
`categoryIds`	`array<string>`	No	-
`search`	`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": "services",
  "apiName": "listDiagnosticTests",
  "data": {
    "organizationId": "org_123"
  }
}'

Example Response

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

`listPharmacyCatalogPublic`

Source: backend/endpoints/services/list-pharmacy-catalog-public

Input Fields

Field	Type	Required	Constraints
`searchQuery`	`string`	No	-
`limitProviders`	`integer`	No	-
`limitItemsPerCategory`	`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": "services",
  "apiName": "listPharmacyCatalogPublic",
  "data": {
    "searchQuery": "value",
    "limitProviders": 1,
    "limitItemsPerCategory": 1
  }
}'

Example Response

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

`listPlatformCategories`

Source: backend/endpoints/services/list-platform-categories

Input Fields

Field	Type	Required	Constraints
`types`	`array<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": "services",
  "apiName": "listPlatformCategories",
  "data": {
    "types": [
      "value"
    ]
  }
}'

Example Response

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

`listSystemServices`

Source: backend/endpoints/services/list-system-services

Input Fields

Field	Type	Required	Constraints
`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": "services",
  "apiName": "listSystemServices",
  "data": {
    "organizationId": "org_123"
  }
}'

Example Response

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

`softDelete`

Source: backend/endpoints/services/soft-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": "services",
  "apiName": "softDelete",
  "data": {
    "id": "id_123",
    "organizationId": "org_123"
  }
}'

Example Response

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

`update`

Source: backend/endpoints/services/update

Input Fields

Field	Type	Required	Constraints
`id`	`string`	Yes	-
`organizationId`	`string`	Yes	-
`usage`	`object`	No	nullable
`categoryId`	`string`	No	nullable
`categoryIds`	`array<string>`	No	nullable
`platformCategoryId`	`string`	No	nullable
`platformCategoryIds`	`array<string>`	No	nullable
`departmentId`	`string`	No	nullable
`platformDepartmentId`	`string`	No	nullable
`name`	`string`	No	nullable
`code`	`string`	No	nullable
`description`	`string`	No	nullable
`imageId`	`string`	No	nullable
`imageUrl`	`array<string>`	No	nullable
`type`	`string`	No	nullable
`serviceCategory`	`string`	No	nullable
`chargeType`	`string`	No	nullable
`unit`	`string`	No	nullable
`basePrice`	`number`	No	nullable
`mrp`	`number`	No	nullable
`minAge`	`integer`	No	nullable
`maxAge`	`integer`	No	nullable
`consumeTypeId`	`string`	No	nullable
`hsnCode`	`string`	No	nullable
`batchNumber`	`string`	No	nullable
`expiryDate`	`string`	No	format: YYYY-MM-DD; nullable
`dosage`	`string`	No	nullable
`prescriptionType`	`string`	No	nullable
`sideEffects`	`array<object>`	No	nullable
`safetyAdvice`	`array<object>`	No	nullable
`currency`	`string`	No	nullable
`gender`	`array<string>`	No	nullable
`doctorId`	`string`	No	nullable
`consultationTypes`	`array<string>`	No	nullable
`consultationType`	`string`	No	nullable
`isHomeCollectionAvailable`	`boolean`	No	nullable
`sampleType`	`string`	No	nullable
`videoUrl`	`array<string>`	No	nullable
`faq`	`array<object>`	No	-
`metadata`	`object`	No	nullable
`totalReviews`	`integer`	No	nullable
`averageRatings`	`number`	No	nullable
`isActive`	`boolean`	No	nullable
`isPublic`	`boolean`	No	nullable
`isDeleted`	`boolean`	No	nullable
`deletedAt`	`integer`	No	unix-ms timestamp; nullable
`createdAt`	`integer`	No	unix-ms timestamp; nullable
`updatedAt`	`integer`	No	unix-ms timestamp; nullable

Nested Field Structures

`sideEffects` item

Field	Type	Required	Constraints
`title`	`string`	No	-
`description`	`string`	No	-

`safetyAdvice` item

Field	Type	Required	Constraints
`type`	`string`	No	-
`status`	`string`	No	-
`message`	`string`	No	-

`metadata`

Field	Type	Required	Constraints
`sampleType`	`string`	No	-
`turnaroundTime`	`string`	No	format: HH:mm
`manufacturer`	`string`	No	-
`dosageForm`	`string`	No	-
`strength`	`string`	No	-
`composition`	`string`	No	-
`packSize`	`string`	No	-
`modality`	`string`	No	-
`bodyPart`	`string`	No	-
`locationId`	`string`	No	-
`category`	`string`	No	-
`durationMinutes`	`integer`	No	nullable
`modelNumber`	`string`	No	-
`specifications`	`string`	No	-
`stockQuantity`	`number`	No	nullable
`reorderLevel`	`number`	No	nullable
`lastStockUpdate`	`number`	No	nullable

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": "services",
  "apiName": "update",
  "data": {
    "id": "id_123",
    "organizationId": "org_123"
  }
}'

Example Response

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

`v1Create`

Source: backend/endpoints/services/v1/create

Input Fields

Field	Type	Required	Constraints
`id`	`string`	No	-
`name`	`string`	No	-
`code`	`string`	No	-
`description`	`string`	No	-
`type`	`string`	No	-
`chargeType`	`string`	No	-
`unit`	`string`	No	-
`categoryId`	`string`	No	-
`categoryIds`	`array<string>`	No	-
`platformCategoryIds`	`array<string>`	No	-
`imageUrl`	`array<string>`	No	-
`imageUrls`	`array<string>`	No	-
`basePrice`	`number`	No	-
`mrp`	`number`	No	nullable
`minAge`	`integer`	No	nullable
`maxAge`	`integer`	No	nullable
`min_age`	`integer`	No	nullable
`max_age`	`integer`	No	nullable
`consumeTypeId`	`string`	No	-
`hsnCode`	`string`	No	-
`batchNumber`	`string`	No	-
`expiryDate`	`string`	No	format: YYYY-MM-DD
`dosage`	`string`	No	-
`prescriptionType`	`string`	No	-
`sideEffects`	`array<object>`	No	-
`safetyAdvice`	`array<object>`	No	-
`currency`	`string`	No	-
`organizationId`	`string`	No	-
`departmentId`	`string`	No	-
`doctorId`	`string`	No	-
`gender`	`array<string>`	No	-
`consultationTypes`	`array<string>`	No	-
`isHomeCollectionAvailable`	`boolean`	No	nullable
`sampleType`	`string`	No	-
`videoUrl`	`array<string>`	No	-
`faq`	`array<object>`	No	-
`metadata`	`object`	No	nullable
`isActive`	`boolean`	No	nullable
`isPublic`	`boolean`	No	nullable

Nested Field Structures

`sideEffects` item

Field	Type	Required	Constraints
`title`	`string`	No	-
`description`	`string`	No	-

`safetyAdvice` item

Field	Type	Required	Constraints
`type`	`string`	No	-
`status`	`string`	No	-
`message`	`string`	No	-

`metadata`

Field	Type	Required	Constraints
`sampleType`	`string`	No	-
`turnaroundTime`	`string`	No	format: HH:mm
`manufacturer`	`string`	No	-
`dosageForm`	`string`	No	-
`strength`	`string`	No	-
`composition`	`string`	No	-
`packSize`	`string`	No	-
`modality`	`string`	No	-
`bodyPart`	`string`	No	-
`locationId`	`string`	No	-
`category`	`string`	No	-
`durationMinutes`	`integer`	No	nullable
`modelNumber`	`string`	No	-
`specifications`	`string`	No	-
`stockQuantity`	`number`	No	nullable
`reorderLevel`	`number`	No	nullable
`lastStockUpdate`	`number`	No	nullable

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": "services",
  "apiName": "v1Create",
  "data": {
    "organizationId": "org_123",
    "id": "id_123",
    "doctorId": "doctor_123",
    "name": "value",
    "sideEffects": [
      {
        "title": "value",
        "description": "value"
      }
    ],
    "safetyAdvice": [
      {
        "type": "general",
        "status": "scheduled",
        "message": "value"
      }
    ],
    "metadata": {
      "sampleType": "general",
      "turnaroundTime": "10:30",
      "manufacturer": "value",
      "dosageForm": "value",
      "strength": "value",
      "composition": "value",
      "packSize": "value",
      "modality": "value",
      "bodyPart": "value",
      "locationId": "location_123",
      "category": "value",
      "durationMinutes": 1,
      "modelNumber": "value",
      "specifications": "value",
      "stockQuantity": 1,
      "reorderLevel": 1,
      "lastStockUpdate": "2026-03-12"
    }
  }
}'

Example Response

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

`v1ListByOrganization`

Source: backend/endpoints/services/v1/list-by-organization

Input Fields

Field	Type	Required	Constraints
`organizationId`	`string`	Yes	-
`type`	`string`	No	-
`search`	`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": "services",
  "apiName": "v1ListByOrganization",
  "data": {
    "organizationId": "org_123"
  }
}'

Example Response

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

`v1ListConsultationServices`

Source: backend/endpoints/services/v1/list-consultation-services

Input Fields

Field	Type	Required	Constraints
`search`	`string`	No	-
`type`	`string`	No	-
`isActive`	`boolean`	No	nullable
`page`	`integer`	No	-
`pageSize`	`integer`	No	-
`page_size`	`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": "services",
  "apiName": "v1ListConsultationServices",
  "data": {
    "search": "value",
    "type": "general",
    "isActive": true,
    "page": 1,
    "pageSize": 1,
    "page_size": 1
  }
}'

Example Response

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

`v1ListDiagnosticCatalog`

Source: backend/endpoints/services/v1/list-diagnostic-catalog

Input Fields

Field	Type	Required	Constraints
`search`	`string`	No	-
`page`	`integer`	No	-
`pageSize`	`integer`	No	-
`page_size`	`integer`	No	-
`categoryId`	`string`	No	-
`categoryIds`	`array<string>`	No	-
`category_id`	`string`	No	-
`category_ids`	`array<string>`	No	-
`categoryName`	`string`	No	-
`categoryNames`	`array<string>`	No	-
`category_name`	`string`	No	-
`category_names`	`array<string>`	No	-
`organizationId`	`string`	No	-
`organizationIds`	`array<string>`	No	-
`organization_id`	`string`	No	-
`organization_ids`	`array<string>`	No	-
`minPrice`	`number`	No	nullable
`maxPrice`	`number`	No	nullable
`min_price`	`number`	No	nullable
`max_price`	`number`	No	nullable
`minAge`	`integer`	No	nullable
`maxAge`	`integer`	No	nullable
`min_age`	`integer`	No	nullable
`max_age`	`integer`	No	nullable
`averageRatings`	`number`	No	nullable
`average_ratings`	`number`	No	nullable
`sortBy`	`string`	No	-
`sort_by`	`string`	No	-
`labTestNames`	`array<string>`	No	-
`lab_test_names`	`array<string>`	No	-
`itemTypes`	`array<string>`	No	-
`item_types`	`array<string>`	No	-
`types`	`array<string>`	No	-
`type`	`string`	No	-
`gender`	`array<string>`	No	-
`genders`	`array<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": "services",
  "apiName": "v1ListDiagnosticCatalog",
  "data": {
    "organizationId": "org_123"
  }
}'

Example Response

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

`v1Update`

Source: backend/endpoints/services/v1/update

Input Fields

Field	Type	Required	Constraints
`id`	`string`	Yes	-
`organizationId`	`string`	No	-
`name`	`string`	No	-
`code`	`string`	No	-
`description`	`string`	No	-
`type`	`string`	No	-
`categoryId`	`string`	No	-
`categoryIds`	`array<string>`	No	-
`platformCategoryIds`	`array<string>`	No	-
`imageUrl`	`array<string>`	No	-
`imageUrls`	`array<string>`	No	-
`basePrice`	`number`	No	nullable
`mrp`	`number`	No	nullable
`minAge`	`integer`	No	nullable
`maxAge`	`integer`	No	nullable
`consumeTypeId`	`string`	No	-
`hsnCode`	`string`	No	-
`batchNumber`	`string`	No	-
`expiryDate`	`string`	No	format: YYYY-MM-DD
`dosage`	`string`	No	-
`prescriptionType`	`string`	No	-
`sideEffects`	`array<object>`	No	-
`safetyAdvice`	`array<object>`	No	-
`currency`	`string`	No	-
`departmentId`	`string`	No	-
`gender`	`array<string>`	No	-
`isHomeCollectionAvailable`	`boolean`	No	nullable
`sampleType`	`string`	No	-
`videoUrl`	`array<string>`	No	-
`faq`	`array<object>`	No	-
`metadata`	`object`	No	nullable
`isActive`	`boolean`	No	nullable
`isPublic`	`boolean`	No	nullable

Nested Field Structures

`sideEffects` item

Field	Type	Required	Constraints
`title`	`string`	No	-
`description`	`string`	No	-

`safetyAdvice` item

Field	Type	Required	Constraints
`type`	`string`	No	-
`status`	`string`	No	-
`message`	`string`	No	-

`metadata`

Field	Type	Required	Constraints
`sampleType`	`string`	No	-
`turnaroundTime`	`string`	No	format: HH:mm
`manufacturer`	`string`	No	-
`dosageForm`	`string`	No	-
`strength`	`string`	No	-
`composition`	`string`	No	-
`packSize`	`string`	No	-
`modality`	`string`	No	-
`bodyPart`	`string`	No	-
`locationId`	`string`	No	-
`category`	`string`	No	-
`durationMinutes`	`integer`	No	nullable
`modelNumber`	`string`	No	-
`specifications`	`string`	No	-
`stockQuantity`	`number`	No	nullable
`reorderLevel`	`number`	No	nullable
`lastStockUpdate`	`number`	No	nullable

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": "services",
  "apiName": "v1Update",
  "data": {
    "id": "id_123"
  }
}'

Example Response

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

Service Reviews Sleep Logs

Services

checkServiceDependencies

Input Fields

Example Request

Example Response

create

Input Fields

Nested Field Structures

organization

category

platformCategory

department

platformDepartment

sideEffects item

safetyAdvice item

doctorProfile

user

metadata

feedbacks item

Example Request

Example Response

delete

Input Fields

Example Request

Example Response

getById

Input Fields

Example Request

Example Response

getPharmacyCatalogPublic

Input Fields

Example Request

Example Response

getStats

Input Fields

Example Request

Example Response

getSystemServiceById

Input Fields

Example Request

Example Response

list

Input Fields

Example Request

Example Response

listActiveLabServices

Input Fields

Example Request

Example Response

listAllActiveServices

Input Fields

Nested Field Structures

nearBy

Filter Notes

Example Request

Example Response

listByCategory

Input Fields

Example Request

Example Response

listByOrganization

Input Fields

Example Request

Example Response

listDiagnosticTests

Input Fields

Example Request

Example Response

listPharmacyCatalogPublic

Input Fields

Example Request

Example Response

listPlatformCategories

Input Fields

Example Request

Example Response

listSystemServices

Input Fields

Example Request

Example Response

`checkServiceDependencies`

`create`

`organization`

`category`

`platformCategory`

`department`

`platformDepartment`

`sideEffects` item

`safetyAdvice` item

`doctorProfile`

`user`

`metadata`

`feedbacks` item

`delete`

`getById`

`getPharmacyCatalogPublic`

`getStats`

`getSystemServiceById`

`list`

`listActiveLabServices`

`listAllActiveServices`

`nearBy`

`listByCategory`

`listByOrganization`

`listDiagnosticTests`

`listPharmacyCatalogPublic`

`listPlatformCategories`

`listSystemServices`

`softDelete`

`update`

`sideEffects` item

`safetyAdvice` item

`metadata`

`v1Create`

`sideEffects` item

`safetyAdvice` item

`metadata`

`v1ListByOrganization`

`v1ListConsultationServices`

`v1ListDiagnosticCatalog`

`v1Update`

`sideEffects` item

`safetyAdvice` item

`metadata`