Afya-Health
  1. Appointment
Afya-Health
  • Auth
    • Login
      POST
    • Signup
      POST
  • ForgotPassword
    • Verify OTP
      POST
    • ForgotPassword
      POST
    • ResetPassword
      POST
  • Profile
    • Get User Profile
      GET
    • Update user profile
      POST
  • Family Members
    • Add Family Member
      POST
    • Update Family Members
      PUT
    • Delete Family Member
      DELETE
  • Address
    • Get User address
      GET
    • Add Address
      POST
    • Update address
      PUT
    • Delete Address
      DELETE
  • Languages
    • List AppLabels
      GET
    • Add/Update Label
      POST
    • List Languages
      GET
  • Products
    • Get Products
    • Create Product
    • Update Product
    • Delete Product
    • Update product items
  • Permissions
    • Get Permissions
  • Config
    • List Practice Config
    • Add Update Config
    • List Master Config
    • Add Update Master Config
  • Appointment Schedule
    • Create Schedule
    • Update Schedule
    • Delete Schedule
    • Get Schedule by ID
    • Get Schedule list
  • Test Tags
    • Get Test Tags
    • Create Test Tag
    • Update Test Tag
    • Delete Test Tag
  • Test Parameters
    • Get Test Parameters
    • Create Test Parameters
    • Update Test Parameters
    • Delete Test Parameters
  • Category
    • Get Category
    • Create Category
    • Update Category
    • Delete Category
  • Device
    • Register Device
  • File
    • Upload File
  • Appointment
    • Create Appointment Order
      POST
    • Get Appointments List
      GET
    • Update Appointment Status
      POST
    • Get Appointment by ID
      GET
    • Get Appointment Slots
      POST
    • GetStartJourneyDirection
      POST
  • Reports
    • Upload Report
    • List All Reports
    • List Reports By Appointment
    • Delete Report
    • Update Report File
  • Staff
    • Add Staff Member
    • List Staff Member
    • Update Staff Member
    • Delete Staff Member
    • Get Staff member by ID
  • Patient
    • List Patients
    • Add Patient
    • Update Patient
    • Delete Patient
    • Get patient by ID
  • Notifications
    • List User Notifications
    • Update Notification read status
  1. Appointment

Get Appointments List

Developing
GET
/api/service/v1/appointments

Request

Query Params
page_size
string 
optional
Example:
3
page
string 
optional
Example:
1
u_id
string 
optional
user id
Example:
677bb5bd4291b96cd0623ef2
t_id
string 
optional
technician id
Example:
677bb5bd4291b96cd0623ee6
st
string 
optional
order status;
Example:
order_confirmed
from_date
string 
optional
Example:
2025-03-06
to_date
string 
optional
Example:
2025-03-15
Header Params
Accept
string 
optional
Example:
application/json
Content-Type
string 
optional
Example:
application/json
practice-code
string 
optional
Example:
DEFAULT
Authorization
string 
optional
Example:
{{token}}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://afyahealth.doctodoor.com:5600/api/service/v1/appointments?page_size=3&page=1&u_id=677bb5bd4291b96cd0623ef2&t_id=677bb5bd4291b96cd0623ee6&st=order_confirmed&from_date=2025-03-06&to_date=2025-03-15' \
--header 'Accept: application/json' \
--header 'practice-code: DEFAULT' \
--header 'Authorization:  eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjY3YjJkZmZlNWJmMjdlMzk1NTUzMjE0MyIsImVtYWlsIjoiZGVlcC5tYXJzb25pYUBwbGVuYXJ0ZWNoLmNvbSIsInN1YiI6IjY3YjJkZmZlNWJmMjdlMzk1NTUzMjE0MyIsImlhdCI6MTc0MTc4MjA4NCwiZXhwIjoxNzQ5NTU4MDg0fQ.KAMsweSbJPDxpLijKdjgp3YEFauw8KYLLumCBpqQfAA' \
--header 'Content-Type: application/json'

Responses

🟢200Success
application/json
Body
error
boolean 
required
status_code
integer 
required
message
string 
required
data
object 
required
appointments
array [object {19}] 
required
total
integer 
required
Example
{
    "error": false,
    "status_code": 200,
    "message": "",
    "data": {
        "appointments": [
            {
                "slot_timing": {
                    "date": "2025-01-26T00:00:00.000Z",
                    "start_time": "09:00",
                    "end_time": "10:00"
                },
                "status": "order_confirmed",
                "family_members": [],
                "is_deleted": 0,
                "items": [
                    {
                        "discount_amount": 0,
                        "title": "test 1 ##",
                        "estimated_report_delivery_time": "0",
                        "product": {
                            "items": [
                                {
                                    "items": [],
                                    "test_parameters": [
                                        "6788b0121322454d3e643f64"
                                    ],
                                    "sample_requirements": [
                                        "blood"
                                    ],
                                    "estimated_report_delivery_time": 0,
                                    "is_deleted": 0,
                                    "title": {
                                        "en": "test 1 ##"
                                    },
                                    "subtitle": {
                                        "en": "Sub ttile"
                                    },
                                    "description": {
                                        "en": "desriptin "
                                    },
                                    "prerequisites": {
                                        "en": "prerquu ui"
                                    },
                                    "type": "test",
                                    "category": "6788c93bd798f459e8c8d7cc",
                                    "price": 420,
                                    "currency": "INR",
                                    "discount_amount": 100,
                                    "discount_type": "flat",
                                    "service_category": "6790d7c19975d85c7b447c53",
                                    "created_at": "2025-01-24T10:14:33.704Z",
                                    "updated_at": "2025-01-24T10:14:33.704Z",
                                    "id": "6793680981770556165f150d"
                                }
                            ],
                            "test_parameters": [
                                "6788b0121322454d3e643f64"
                            ],
                            "sample_requirements": [
                                "blood"
                            ],
                            "estimated_report_delivery_time": 0,
                            "is_deleted": 0,
                            "title": {
                                "en": "test 1 ##"
                            },
                            "subtitle": {
                                "en": "Sub ttile"
                            },
                            "description": {
                                "en": "desriptin "
                            },
                            "prerequisites": {
                                "en": "prerquu ui"
                            },
                            "type": "package",
                            "category": "6788c93bd798f459e8c8d7cc",
                            "price": 420,
                            "currency": "INR",
                            "discount_amount": 100,
                            "discount_type": "flat",
                            "service_category": "6790d7c19975d85c7b447c53",
                            "image": "6797541deb8b1053d7d780c1",
                            "created_at": "2025-01-27T09:48:20.218Z",
                            "updated_at": "2025-01-27T09:52:49.777Z",
                            "id": "67975664eb8b1053d7d780c8"
                        },
                        "total": 420,
                        "discount_type": "flat",
                        "final_total": 320,
                        "created_at": "2025-01-31T06:30:10.319Z",
                        "updated_at": "2025-01-31T06:30:10.319Z",
                        "id": "679c6df24b9d1136097d4d26"
                    }
                ],
                "status_activity": [
                    {
                        "date": "2025-01-31T06:30:10.317Z",
                        "status": "order_confirmed",
                        "created_at": "2025-01-31T06:30:10.320Z",
                        "updated_at": "2025-01-31T06:30:10.320Z",
                        "id": "679c6df24b9d1136097d4d2a"
                    },
                    {
                        "date": null,
                        "status": "lab_agent_arrived",
                        "created_at": "2025-01-31T06:30:10.320Z",
                        "updated_at": "2025-01-31T06:30:10.320Z",
                        "id": "679c6df24b9d1136097d4d2b"
                    },
                    {
                        "date": null,
                        "status": "sample_collected",
                        "created_at": "2025-01-31T06:30:10.320Z",
                        "updated_at": "2025-01-31T06:30:10.320Z",
                        "id": "679c6df24b9d1136097d4d2c"
                    },
                    {
                        "date": null,
                        "status": "completed",
                        "created_at": "2025-01-31T06:30:10.320Z",
                        "updated_at": "2025-01-31T06:30:10.320Z",
                        "id": "679c6df24b9d1136097d4d2d"
                    },
                    {
                        "date": null,
                        "status": "cancelled",
                        "created_at": "2025-01-31T06:30:10.320Z",
                        "updated_at": "2025-01-31T06:30:10.320Z",
                        "id": "679c6df24b9d1136097d4d2e"
                    }
                ],
                "user": {
                    "roles": [
                        "677bb5bd4291b96cd0623e9a"
                    ],
                    "is_master_admin": 1,
                    "is_temporary_password": 0,
                    "is_deleted": 0,
                    "is_active": 1,
                    "deleted_at": null,
                    "language_code": "en",
                    "first_name": "Deep",
                    "middle_name": "",
                    "last_name": "Marsonia",
                    "full_name": "Deep Marsonia",
                    "email": "deep.marsonia+lt1@plenartech.com",
                    "created_at": "2025-01-06T10:51:41.468Z",
                    "updated_at": "2025-01-06T10:51:41.468Z",
                    "family_members": [],
                    "id": "677bb5bd4291b96cd0623ef2"
                },
                "payment_mode": "cod",
                "technician": {
                    "roles": [
                        "677bb5bd4291b96cd0623e9a"
                    ],
                    "is_master_admin": 1,
                    "is_temporary_password": 0,
                    "is_deleted": 0,
                    "is_active": 1,
                    "deleted_at": null,
                    "language_code": "en",
                    "first_name": "Hardik",
                    "middle_name": "",
                    "last_name": "Shah",
                    "full_name": "Hardik Shah",
                    "email": "hardik+lt1@plenartech.com",
                    "created_at": "2025-01-06T10:51:41.424Z",
                    "updated_at": "2025-01-06T10:51:41.424Z",
                    "family_members": [],
                    "id": "677bb5bd4291b96cd0623ee6"
                },
                "address": {
                    "is_deleted": 0,
                    "user": "677bb5bd4291b96cd0623eea",
                    "title": "primary addres ",
                    "long": 74.23,
                    "lat": 72.4545,
                    "address": "123 street, india",
                    "created_at": "2025-01-17T11:46:59.450Z",
                    "updated_at": "2025-01-17T11:46:59.450Z",
                    "id": "678a433390b9c678ccb677f6"
                },
                "gender_preference": "male",
                "coupon_code": "ABC",
                "currency": "AED",
                "fee": 10,
                "total": 420,
                "final_total": 320,
                "created_at": "2025-01-31T06:30:10.320Z",
                "updated_at": "2025-01-31T06:30:10.320Z",
                "id": "679c6df24b9d1136097d4d23"
            }
        ],
        "total": 1
    }
}
Previous
Create Appointment Order
Next
Update Appointment Status
Built with