- Auth
- ForgotPassword
- Profile
- Family Members
- Address
- Languages
- Products
- Permissions
- Config
- Appointment Schedule
- Test Tags
- Test Parameters
- Category
- Device
- File
- Appointment
- Reports
- Staff
- Patient
- Notifications
Get Appointment by ID
Developing
GET
/api/service/v1/appointments/{id}
Request
Path Params
id
string
required
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/' \
--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
slot_timing
object
required
status
string
required
family_members
array[string]
required
reports
array [object {9}]
required
is_deleted
integer
required
items
array [object {10}]
required
status_activity
array [object {5}]
required
user
string
required
payment_mode
string
required
technician
string
required
address
string
required
gender_preference
string
required
coupon_code
string
required
currency
string
required
fee
integer
required
total
integer
required
final_total
integer
required
created_at
string
required
updated_at
string
required
id
string
required
Example
{
"error": false,
"status_code": 200,
"message": "",
"data": {
"slot_timing": {
"date": "2025-01-26T00:00:00.000Z",
"start_time": "09:00",
"end_time": "10:00"
},
"status": "order_confirmed",
"family_members": [],
"reports": [
{
"is_deleted": 0,
"file": {
"original_name": "Screenshot from 2025-01-09 19-15-20.png",
"file_name": "DEFAULT/private/appointments/reports/40430a1d-00cb-4d56-9fe0-a640053306aa_1739258904350_Screenshot_from_2025-01-09_19-15-20.png",
"path": "https://afyahealth.doctodoor.com.s3.us-east-1.amazonaws.com/DEFAULT/private/appointments/reports/40430a1d-00cb-4d56-9fe0-a640053306aa_1739258904350_Screenshot_from_2025-01-09_19-15-20.png",
"size": 65277,
"mimeType": "image/png",
"created_at": "2025-02-11T07:28:26.046Z",
"updated_at": "2025-02-11T07:28:26.046Z",
"id": "67aafc1a2fbff95f9bf6cc44",
"media_url": "https://d3ektmb2e4ajpb.cloudfront.net/DEFAULT/private/appointments/reports/40430a1d-00cb-4d56-9fe0-a640053306aa_1739258904350_Screenshot_from_2025-01-09_19-15-20.png"
},
"family_member": "67aaf94bdda840588315f62f",
"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"
},
"appointment": "67a9f1581c069b9f8322d5aa",
"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-02-11T07:16:27.156Z",
"family_members": [
{
"name": "test2",
"gender": "male",
"birth_date": "2000-01-01T00:00:00.000Z",
"updated_at": "2025-02-11T07:16:27.156Z",
"created_at": "2025-02-11T07:16:27.156Z",
"id": "67aaf94bdda840588315f62f"
}
],
"id": "677bb5bd4291b96cd0623ef2"
},
"created_at": "2025-02-11T07:28:26.049Z",
"updated_at": "2025-02-11T09:57:59.974Z",
"id": "67aafc1a2fbff95f9bf6cc46"
}
],
"is_deleted": 0,
"items": [
{
"discount_amount": 0,
"title": "test 1 ##",
"estimated_report_delivery_time": "0",
"product": {
"items": [
{
"items": [],
"test_parameters": [
{
"tags": [
{
"is_deleted": 0,
"title": {
"en": "en title edit",
"ar": "ar title edit"
},
"created_at": "2025-01-16T06:49:07.666Z",
"updated_at": "2025-01-16T06:49:07.666Z",
"id": "6788abe33fd2424ae6a4db87"
}
],
"is_deleted": 1,
"title": {
"en": "this is en title edited",
"ar": "this is ar title"
},
"description": {
"en": "this is en title edited",
"ar": "this is ar title"
},
"created_at": "2025-01-16T07:06:58.981Z",
"updated_at": "2025-01-16T10:04:28.856Z",
"id": "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-02-10T12:30:16.173Z",
"updated_at": "2025-02-10T12:30:16.173Z",
"id": "67a9f1581c069b9f8322d5ad"
}
],
"status_activity": [
{
"date": "2025-02-10T12:30:16.171Z",
"status": "order_confirmed",
"created_at": "2025-02-10T12:30:16.173Z",
"updated_at": "2025-02-10T12:30:16.173Z",
"id": "67a9f1581c069b9f8322d5b1"
},
{
"date": null,
"status": "lab_agent_arrived",
"created_at": "2025-02-10T12:30:16.173Z",
"updated_at": "2025-02-10T12:30:16.173Z",
"id": "67a9f1581c069b9f8322d5b2"
},
{
"date": null,
"status": "sample_collected",
"created_at": "2025-02-10T12:30:16.173Z",
"updated_at": "2025-02-10T12:30:16.173Z",
"id": "67a9f1581c069b9f8322d5b3"
},
{
"date": null,
"status": "completed",
"created_at": "2025-02-10T12:30:16.173Z",
"updated_at": "2025-02-10T12:30:16.173Z",
"id": "67a9f1581c069b9f8322d5b4"
},
{
"date": null,
"status": "cancelled",
"created_at": "2025-02-10T12:30:16.173Z",
"updated_at": "2025-02-10T12:30:16.173Z",
"id": "67a9f1581c069b9f8322d5b5"
}
],
"user": "6798c1d7ff455c7ed97625f0",
"payment_mode": "cod",
"technician": "677bb5bd4291b96cd0623ee6",
"address": "678a433390b9c678ccb677f6",
"gender_preference": "male",
"coupon_code": "ABC",
"currency": "AED",
"fee": 10,
"total": 420,
"final_total": 320,
"created_at": "2025-02-10T12:30:16.173Z",
"updated_at": "2025-02-10T12:30:16.173Z",
"id": "67a9f1581c069b9f8322d5aa"
}
}