Afya-Health
  1. Appointment Schedule
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
      GET
    • Create Product
      POST
    • Update Product
      PUT
    • Delete Product
      DELETE
    • Update product items
      PUT
  • Permissions
    • Get Permissions
  • Config
    • List Practice Config
    • Add Update Config
    • List Master Config
    • Add Update Master Config
  • Appointment Schedule
    • Create Schedule
      POST
    • Update Schedule
      PUT
    • Delete Schedule
      DELETE
    • Get Schedule by ID
      GET
    • Get Schedule list
      GET
  • 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
    • Get Appointments List
    • Update Appointment Status
    • Get Appointment by ID
    • Get Appointment Slots
    • GetStartJourneyDirection
  • 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 Schedule

Get Schedule list

Developing
GET
/api/service/v1/appointment/schedule

Request

Query Params
u_id
string 
optional
user id
Example:
677bb5bd4291b96cd0623eea
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/appointment/schedule?u_id=677bb5bd4291b96cd0623eea' \
--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
array [object {13}] 
required
services
array [object {8}] 
required
buffer_minutes
integer 
required
is_deleted
integer 
required
override_dates
array [object {6}] 
required
schedules
array [object {8}] 
required
user
object 
required
name
string 
required
start
string 
required
end
null 
required
timezone
string 
required
created_at
string 
required
updated_at
string 
required
id
string 
required
Example
{
    "error": false,
    "status_code": 200,
    "message": "",
    "data": [
        {
            "services": [
                {
                    "parent": null,
                    "is_deleted": 0,
                    "title": {
                        "en": "this is title2",
                        "ar": "arabic title2"
                    },
                    "type": "service",
                    "color": "#FFAAEE",
                    "created_at": "2025-01-22T11:34:25.801Z",
                    "updated_at": "2025-01-22T11:34:25.801Z",
                    "id": "6790d7c19975d85c7b447c53"
                }
            ],
            "buffer_minutes": 0,
            "is_deleted": 0,
            "override_dates": [
                {
                    "date": "2024-12-30T00:00:00.000Z",
                    "start_time": "13:00",
                    "end_time": "14:00",
                    "created_at": "2025-02-12T13:21:58.414Z",
                    "updated_at": "2025-02-12T13:21:58.414Z",
                    "id": "67aca076afe14ba9bb405107"
                }
            ],
            "schedules": [
                {
                    "day": 1,
                    "isOn": true,
                    "startTime": "09:00",
                    "endTime": "15:00",
                    "breaks": [
                        {
                            "start": "10:00",
                            "end": "11:00",
                            "created_at": "2025-02-12T13:21:58.414Z",
                            "updated_at": "2025-02-12T13:21:58.414Z",
                            "id": "67aca076afe14ba9bb4050fa"
                        }
                    ],
                    "created_at": "2025-02-12T13:21:58.414Z",
                    "updated_at": "2025-02-12T13:21:58.414Z",
                    "id": "67aca076afe14ba9bb4050f9"
                },
                {
                    "day": 2,
                    "isOn": true,
                    "startTime": "09:00",
                    "endTime": "15:00",
                    "breaks": [
                        {
                            "start": "10:00",
                            "end": "11:00",
                            "created_at": "2025-02-12T13:21:58.414Z",
                            "updated_at": "2025-02-12T13:21:58.414Z",
                            "id": "67aca076afe14ba9bb4050fc"
                        }
                    ],
                    "created_at": "2025-02-12T13:21:58.414Z",
                    "updated_at": "2025-02-12T13:21:58.414Z",
                    "id": "67aca076afe14ba9bb4050fb"
                },
                {
                    "day": 3,
                    "isOn": true,
                    "startTime": "09:00",
                    "endTime": "15:00",
                    "breaks": [
                        {
                            "start": "14:00",
                            "end": "15:00",
                            "created_at": "2025-02-12T13:21:58.414Z",
                            "updated_at": "2025-02-12T13:21:58.414Z",
                            "id": "67aca076afe14ba9bb4050fe"
                        }
                    ],
                    "created_at": "2025-02-12T13:21:58.414Z",
                    "updated_at": "2025-02-12T13:21:58.414Z",
                    "id": "67aca076afe14ba9bb4050fd"
                },
                {
                    "day": 4,
                    "isOn": true,
                    "startTime": "09:00",
                    "endTime": "15:00",
                    "breaks": [
                        {
                            "start": "10:00",
                            "end": "11:00",
                            "created_at": "2025-02-12T13:21:58.414Z",
                            "updated_at": "2025-02-12T13:21:58.414Z",
                            "id": "67aca076afe14ba9bb405100"
                        }
                    ],
                    "created_at": "2025-02-12T13:21:58.414Z",
                    "updated_at": "2025-02-12T13:21:58.414Z",
                    "id": "67aca076afe14ba9bb4050ff"
                },
                {
                    "day": 5,
                    "isOn": true,
                    "startTime": "09:00",
                    "endTime": "15:00",
                    "breaks": [
                        {
                            "start": "10:00",
                            "end": "11:00",
                            "created_at": "2025-02-12T13:21:58.414Z",
                            "updated_at": "2025-02-12T13:21:58.414Z",
                            "id": "67aca076afe14ba9bb405102"
                        }
                    ],
                    "created_at": "2025-02-12T13:21:58.414Z",
                    "updated_at": "2025-02-12T13:21:58.414Z",
                    "id": "67aca076afe14ba9bb405101"
                },
                {
                    "day": 6,
                    "isOn": true,
                    "startTime": "09:00",
                    "endTime": "15:00",
                    "breaks": [
                        {
                            "start": "10:00",
                            "end": "11:00",
                            "created_at": "2025-02-12T13:21:58.414Z",
                            "updated_at": "2025-02-12T13:21:58.414Z",
                            "id": "67aca076afe14ba9bb405104"
                        }
                    ],
                    "created_at": "2025-02-12T13:21:58.414Z",
                    "updated_at": "2025-02-12T13:21:58.414Z",
                    "id": "67aca076afe14ba9bb405103"
                },
                {
                    "day": 7,
                    "isOn": true,
                    "startTime": "09:00",
                    "endTime": "15:00",
                    "breaks": [
                        {
                            "start": "10:00",
                            "end": "11:00",
                            "created_at": "2025-02-12T13:21:58.414Z",
                            "updated_at": "2025-02-12T13:21:58.414Z",
                            "id": "67aca076afe14ba9bb405106"
                        }
                    ],
                    "created_at": "2025-02-12T13:21:58.414Z",
                    "updated_at": "2025-02-12T13:21:58.414Z",
                    "id": "67aca076afe14ba9bb405105"
                }
            ],
            "user": {
                "roles": [
                    "677bb5bd4291b96cd0623e9e"
                ],
                "is_master_admin": 1,
                "is_temporary_password": 0,
                "is_deleted": 0,
                "is_active": 1,
                "deleted_at": null,
                "language_code": "en",
                "first_name": "deep edit",
                "middle_name": "",
                "last_name": "lastname ",
                "full_name": "deep edit lastname ",
                "email": "deep.marsonia@plenartech.com",
                "created_at": "2025-01-06T10:51:41.439Z",
                "updated_at": "2025-01-23T10:21:01.735Z",
                "family_members": [
                    {
                        "name": "test1",
                        "gender": "male",
                        "birth_date": "2000-01-01T00:00:00.000Z",
                        "id": "679217b51c4f6665b1c096e0"
                    }
                ],
                "birth_date": "2000-01-01T00:00:00.000Z",
                "id": "677bb5bd4291b96cd0623eea"
            },
            "name": "update THis is my Schedule name",
            "start": "2024-12-19T00:00:00.000Z",
            "end": null,
            "timezone": "Asia/Kolkata",
            "created_at": "2025-02-12T13:21:58.414Z",
            "updated_at": "2025-02-12T13:21:58.414Z",
            "id": "67aca076afe14ba9bb4050f8"
        },
        {
            "services": [
                {
                    "parent": null,
                    "is_deleted": 0,
                    "title": {
                        "en": "this is title2",
                        "ar": "arabic title2"
                    },
                    "type": "service",
                    "color": "#FFAAEE",
                    "created_at": "2025-01-22T11:34:25.801Z",
                    "updated_at": "2025-01-22T11:34:25.801Z",
                    "id": "6790d7c19975d85c7b447c53"
                }
            ],
            "buffer_minutes": 0,
            "is_deleted": 0,
            "override_dates": [
                {
                    "date": "2024-12-30T00:00:00.000Z",
                    "start_time": "13:00",
                    "end_time": "14:00",
                    "created_at": "2025-02-12T13:22:59.837Z",
                    "updated_at": "2025-02-12T13:22:59.837Z",
                    "id": "67aca0b327f568ae367c574a"
                }
            ],
            "schedules": [
                {
                    "day": 1,
                    "isOn": true,
                    "startTime": "09:00",
                    "endTime": "15:00",
                    "breaks": [
                        {
                            "start": "10:00",
                            "end": "11:00",
                            "created_at": "2025-02-12T13:22:59.837Z",
                            "updated_at": "2025-02-12T13:22:59.837Z",
                            "id": "67aca0b327f568ae367c573d"
                        }
                    ],
                    "created_at": "2025-02-12T13:22:59.837Z",
                    "updated_at": "2025-02-12T13:22:59.837Z",
                    "id": "67aca0b327f568ae367c573c"
                },
                {
                    "day": 2,
                    "isOn": true,
                    "startTime": "09:00",
                    "endTime": "15:00",
                    "breaks": [
                        {
                            "start": "10:00",
                            "end": "11:00",
                            "created_at": "2025-02-12T13:22:59.837Z",
                            "updated_at": "2025-02-12T13:22:59.837Z",
                            "id": "67aca0b327f568ae367c573f"
                        }
                    ],
                    "created_at": "2025-02-12T13:22:59.837Z",
                    "updated_at": "2025-02-12T13:22:59.837Z",
                    "id": "67aca0b327f568ae367c573e"
                },
                {
                    "day": 3,
                    "isOn": true,
                    "startTime": "09:00",
                    "endTime": "15:00",
                    "breaks": [
                        {
                            "start": "14:00",
                            "end": "15:00",
                            "created_at": "2025-02-12T13:22:59.837Z",
                            "updated_at": "2025-02-12T13:22:59.837Z",
                            "id": "67aca0b327f568ae367c5741"
                        }
                    ],
                    "created_at": "2025-02-12T13:22:59.837Z",
                    "updated_at": "2025-02-12T13:22:59.837Z",
                    "id": "67aca0b327f568ae367c5740"
                },
                {
                    "day": 4,
                    "isOn": true,
                    "startTime": "09:00",
                    "endTime": "15:00",
                    "breaks": [
                        {
                            "start": "10:00",
                            "end": "11:00",
                            "created_at": "2025-02-12T13:22:59.837Z",
                            "updated_at": "2025-02-12T13:22:59.837Z",
                            "id": "67aca0b327f568ae367c5743"
                        }
                    ],
                    "created_at": "2025-02-12T13:22:59.837Z",
                    "updated_at": "2025-02-12T13:22:59.837Z",
                    "id": "67aca0b327f568ae367c5742"
                },
                {
                    "day": 5,
                    "isOn": true,
                    "startTime": "09:00",
                    "endTime": "15:00",
                    "breaks": [
                        {
                            "start": "10:00",
                            "end": "11:00",
                            "created_at": "2025-02-12T13:22:59.837Z",
                            "updated_at": "2025-02-12T13:22:59.837Z",
                            "id": "67aca0b327f568ae367c5745"
                        }
                    ],
                    "created_at": "2025-02-12T13:22:59.838Z",
                    "updated_at": "2025-02-12T13:22:59.838Z",
                    "id": "67aca0b327f568ae367c5744"
                },
                {
                    "day": 6,
                    "isOn": true,
                    "startTime": "09:00",
                    "endTime": "15:00",
                    "breaks": [
                        {
                            "start": "10:00",
                            "end": "11:00",
                            "created_at": "2025-02-12T13:22:59.838Z",
                            "updated_at": "2025-02-12T13:22:59.838Z",
                            "id": "67aca0b327f568ae367c5747"
                        }
                    ],
                    "created_at": "2025-02-12T13:22:59.838Z",
                    "updated_at": "2025-02-12T13:22:59.838Z",
                    "id": "67aca0b327f568ae367c5746"
                },
                {
                    "day": 7,
                    "isOn": true,
                    "startTime": "09:00",
                    "endTime": "15:00",
                    "breaks": [
                        {
                            "start": "10:00",
                            "end": "11:00",
                            "created_at": "2025-02-12T13:22:59.838Z",
                            "updated_at": "2025-02-12T13:22:59.838Z",
                            "id": "67aca0b327f568ae367c5749"
                        }
                    ],
                    "created_at": "2025-02-12T13:22:59.838Z",
                    "updated_at": "2025-02-12T13:22:59.838Z",
                    "id": "67aca0b327f568ae367c5748"
                }
            ],
            "user": {
                "roles": [
                    "677bb5bd4291b96cd0623e9e"
                ],
                "is_master_admin": 1,
                "is_temporary_password": 0,
                "is_deleted": 0,
                "is_active": 1,
                "deleted_at": null,
                "language_code": "en",
                "first_name": "deep edit",
                "middle_name": "",
                "last_name": "lastname ",
                "full_name": "deep edit lastname ",
                "email": "deep.marsonia@plenartech.com",
                "created_at": "2025-01-06T10:51:41.439Z",
                "updated_at": "2025-01-23T10:21:01.735Z",
                "family_members": [
                    {
                        "name": "test1",
                        "gender": "male",
                        "birth_date": "2000-01-01T00:00:00.000Z",
                        "id": "679217b51c4f6665b1c096e0"
                    }
                ],
                "birth_date": "2000-01-01T00:00:00.000Z",
                "id": "677bb5bd4291b96cd0623eea"
            },
            "name": "update THis is my Schedule name",
            "start": "2024-12-19T00:00:00.000Z",
            "end": null,
            "timezone": "Asia/Kolkata",
            "created_at": "2025-02-12T13:22:59.838Z",
            "updated_at": "2025-02-12T13:22:59.838Z",
            "id": "67aca0b327f568ae367c573b"
        },
        {
            "services": [
                {
                    "parent": null,
                    "is_deleted": 0,
                    "title": {
                        "en": "this is title2",
                        "ar": "arabic title2"
                    },
                    "type": "service",
                    "color": "#FFAAEE",
                    "created_at": "2025-01-22T11:34:25.801Z",
                    "updated_at": "2025-01-22T11:34:25.801Z",
                    "id": "6790d7c19975d85c7b447c53"
                }
            ],
            "buffer_minutes": 0,
            "is_deleted": 0,
            "override_dates": [
                {
                    "date": "2024-12-30T00:00:00.000Z",
                    "start_time": "13:00",
                    "end_time": "14:00",
                    "created_at": "2025-02-12T13:27:16.314Z",
                    "updated_at": "2025-02-12T13:27:16.314Z",
                    "id": "67aca1b4f36c72af0b2656d2"
                }
            ],
            "schedules": [
                {
                    "day": 1,
                    "isOn": true,
                    "startTime": "09:00",
                    "endTime": "15:00",
                    "breaks": [
                        {
                            "start": "10:00",
                            "end": "11:00",
                            "created_at": "2025-02-12T13:27:16.314Z",
                            "updated_at": "2025-02-12T13:27:16.314Z",
                            "id": "67aca1b4f36c72af0b2656c5"
                        }
                    ],
                    "created_at": "2025-02-12T13:27:16.314Z",
                    "updated_at": "2025-02-12T13:27:16.314Z",
                    "id": "67aca1b4f36c72af0b2656c4"
                },
                {
                    "day": 2,
                    "isOn": true,
                    "startTime": "09:00",
                    "endTime": "15:00",
                    "breaks": [
                        {
                            "start": "10:00",
                            "end": "11:00",
                            "created_at": "2025-02-12T13:27:16.314Z",
                            "updated_at": "2025-02-12T13:27:16.314Z",
                            "id": "67aca1b4f36c72af0b2656c7"
                        }
                    ],
                    "created_at": "2025-02-12T13:27:16.314Z",
                    "updated_at": "2025-02-12T13:27:16.314Z",
                    "id": "67aca1b4f36c72af0b2656c6"
                },
                {
                    "day": 3,
                    "isOn": true,
                    "startTime": "09:00",
                    "endTime": "15:00",
                    "breaks": [
                        {
                            "start": "14:00",
                            "end": "15:00",
                            "created_at": "2025-02-12T13:27:16.314Z",
                            "updated_at": "2025-02-12T13:27:16.314Z",
                            "id": "67aca1b4f36c72af0b2656c9"
                        }
                    ],
                    "created_at": "2025-02-12T13:27:16.314Z",
                    "updated_at": "2025-02-12T13:27:16.314Z",
                    "id": "67aca1b4f36c72af0b2656c8"
                },
                {
                    "day": 4,
                    "isOn": true,
                    "startTime": "09:00",
                    "endTime": "15:00",
                    "breaks": [
                        {
                            "start": "10:00",
                            "end": "11:00",
                            "created_at": "2025-02-12T13:27:16.314Z",
                            "updated_at": "2025-02-12T13:27:16.314Z",
                            "id": "67aca1b4f36c72af0b2656cb"
                        }
                    ],
                    "created_at": "2025-02-12T13:27:16.314Z",
                    "updated_at": "2025-02-12T13:27:16.314Z",
                    "id": "67aca1b4f36c72af0b2656ca"
                },
                {
                    "day": 5,
                    "isOn": true,
                    "startTime": "09:00",
                    "endTime": "15:00",
                    "breaks": [
                        {
                            "start": "10:00",
                            "end": "11:00",
                            "created_at": "2025-02-12T13:27:16.314Z",
                            "updated_at": "2025-02-12T13:27:16.314Z",
                            "id": "67aca1b4f36c72af0b2656cd"
                        }
                    ],
                    "created_at": "2025-02-12T13:27:16.314Z",
                    "updated_at": "2025-02-12T13:27:16.314Z",
                    "id": "67aca1b4f36c72af0b2656cc"
                },
                {
                    "day": 6,
                    "isOn": true,
                    "startTime": "09:00",
                    "endTime": "15:00",
                    "breaks": [
                        {
                            "start": "10:00",
                            "end": "11:00",
                            "created_at": "2025-02-12T13:27:16.315Z",
                            "updated_at": "2025-02-12T13:27:16.315Z",
                            "id": "67aca1b4f36c72af0b2656cf"
                        }
                    ],
                    "created_at": "2025-02-12T13:27:16.315Z",
                    "updated_at": "2025-02-12T13:27:16.315Z",
                    "id": "67aca1b4f36c72af0b2656ce"
                },
                {
                    "day": 7,
                    "isOn": true,
                    "startTime": "09:00",
                    "endTime": "15:00",
                    "breaks": [
                        {
                            "start": "10:00",
                            "end": "11:00",
                            "created_at": "2025-02-12T13:27:16.315Z",
                            "updated_at": "2025-02-12T13:27:16.315Z",
                            "id": "67aca1b4f36c72af0b2656d1"
                        }
                    ],
                    "created_at": "2025-02-12T13:27:16.315Z",
                    "updated_at": "2025-02-12T13:27:16.315Z",
                    "id": "67aca1b4f36c72af0b2656d0"
                }
            ],
            "user": {
                "roles": [
                    "677bb5bd4291b96cd0623e9e"
                ],
                "is_master_admin": 1,
                "is_temporary_password": 0,
                "is_deleted": 0,
                "is_active": 1,
                "deleted_at": null,
                "language_code": "en",
                "first_name": "deep edit",
                "middle_name": "",
                "last_name": "lastname ",
                "full_name": "deep edit lastname ",
                "email": "deep.marsonia@plenartech.com",
                "created_at": "2025-01-06T10:51:41.439Z",
                "updated_at": "2025-01-23T10:21:01.735Z",
                "family_members": [
                    {
                        "name": "test1",
                        "gender": "male",
                        "birth_date": "2000-01-01T00:00:00.000Z",
                        "id": "679217b51c4f6665b1c096e0"
                    }
                ],
                "birth_date": "2000-01-01T00:00:00.000Z",
                "id": "677bb5bd4291b96cd0623eea"
            },
            "name": "update THis is my Schedule name",
            "start": "2024-12-19T00:00:00.000Z",
            "end": null,
            "timezone": "Asia/Kolkata",
            "created_at": "2025-02-12T13:23:14.213Z",
            "updated_at": "2025-02-12T13:27:16.315Z",
            "id": "67aca0c2f36c72af0b2656a8"
        }
    ]
}
Previous
Get Schedule by ID
Next
Get Test Tags
Built with