Get Appointment Categories¶

Retrieve available appointment categories for a specific clinic.

Endpoint¶

GET /apis/v1/appointment/category

Parameters¶

Query Parameters¶

Parameter	Type	Required	Default	Description
`clinic_id`	integer	Yes	-	The unique identifier of the clinic

Request¶

curl --location --request GET '{base_url}/v1/appointment/category?clinic_id={clinic_id}' \
--header 'Authorization: Bearer YOUR_TOKEN'

Response¶

Success Response¶

Code: 200 OK

{
    "code": 2000,
    "data": [
        {
            "category_id": 3403,
            "clinic_id": 526,
            "name": "Initial Evaluation",
            "minutes": 30,
            "enabled": true,
            "price": 1.0,
            "description": null,
            "default_category": false,
            "color_code": {
                "created_date": "2024-07-17T07:53:38",
                "updated_date": null,
                "id": 97,
                "primary_color": "#ffb304",
                "secondary_color": "#ffc236",
                "text_color": "#000000"
            },
            "appointment_category_conf": {
                "appointmentCategory": {
                    "name": "Initial Evaluation",
                    "clinicName": "Initial Evaluation"
                },
                "billing": {
                    "payableAmount": 175,
                    "payMethod": [
                        "self",
                        "insurance"
                    ],
                    "selfPayUpfrontCollection": true,
                    "insurancePayUpfrontCollection": true,
                    "upfrontCollectionAmount": 0,
                    "selfPayChargeCalcFormat": "APPOINTMENT_RATE"
                },
                "soap": {
                    "subNoteRequired": {
                        "subjective": true,
                        "objective": true,
                        "assesment": true,
                        "planning": true
                    }
                },
                "speciality": "MSK"
            },
            "is_billable": null,
            "speciality": null,
            "equipment_types": [],
            "is_exclusive": null
        } // other categories
    ]
}

Response Schema¶

Appointment Category Object¶

Field	Type	Description
`category_id`	integer	Unique identifier for the category
`clinic_id`	integer	ID of the associated clinic
`name`	string	Name of the appointment category
`minutes`	integer	Duration of appointment in minutes
`enabled`	boolean	Whether category is currently active
`price`	number	Base price for the appointment
`description`	string	Description of the category
`default_category`	boolean	Whether this is the default category
`color_code`	object	Color configuration for UI display
`appointment_category_conf`	object	Detailed configuration settings
`is_billable`	boolean	Whether appointments are billable
`speciality`	string	Medical speciality associated
`equipment_types`	array	Required equipment types
`is_exclusive`	boolean	Whether category is exclusive

Color Code Object¶

Field	Type	Description
`id`	integer	Color scheme identifier
`primary_color`	string	Primary color in hex format
`secondary_color`	string	Secondary color in hex format
`text_color`	string	Text color in hex format
`created_date`	string	ISO 8601 timestamp
`updated_date`	string	ISO 8601 timestamp

Appointment Category Configuration Object¶

Field	Type	Description
`appointmentCategory`	object	Basic category information
`billing`	object	Billing configuration
`soap`	object	SOAP note requirements
`speciality`	string	Associated medical speciality

Billing Configuration Object¶

Field	Type	Description
`payableAmount`	number	Amount to be paid
`payMethod`	array	Accepted payment methods
`selfPayUpfrontCollection`	boolean	Collect self-pay upfront
`insurancePayUpfrontCollection`	boolean	Collect insurance pay upfront
`upfrontCollectionAmount`	number	Upfront collection amount
`selfPayChargeCalcFormat`	string	Self-pay calculation format

SOAP Configuration Object¶

Field	Type	Description
`subNoteRequired`	object	Required SOAP note sections