{ "variable": [ { "id": "baseUrl", "key": "baseUrl", "type": "string", "name": "string", "value": "https:\/\/staging.prescribery.com" } ], "info": { "name": "Prescribery", "_postman_id": "9cc4ef57-b00b-4293-bef6-e1c3856907f0", "description": "", "schema": "https:\/\/schema.getpostman.com\/json\/collection\/v2.1.0\/collection.json" }, "item": [ { "name": "Agents", "description": "", "item": [ { "name": "List Agents", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/agents", "query": [ { "key": "role", "value": "%22sales-agent%22", "description": "Optional. Filter agents by their role.", "disabled": false }, { "key": "date", "value": "%222023-09-10%22", "description": "Optional. Filter agents by available slot date (YYYY-MM-DD).", "disabled": false }, { "key": "page", "value": "1", "description": "Optional. Page number for pagination. Defaults to 1.", "disabled": false }, { "key": "per_page", "value": "10", "description": "Optional. Number of records per page. Defaults to 10.", "disabled": false }, { "key": "sort_column", "value": "%22created_date%22", "description": "Optional. Column used for sorting. Valid options: member_id, full_name, first_name, last_name, email, mobile, city, state, country, created_date.", "disabled": false }, { "key": "sort_order", "value": "%22D%22", "description": "Optional. Sorting direction: \"D\" (descending) or \"A\" (ascending).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v2\/agents?role=%22sales-agent%22&date=%222023-09-10%22&page=1&per_page=10&sort_column=%22created_date%22&sort_order=%22D%22" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Retrieves a paginated list of agents with optional filters and sorting capabilities.\n\nThis endpoint provides detailed profile information for agents. Clients can filter results by license state, role, or available slot date, sort by specific fields, and paginate the response." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"member_id\": 1001,\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"full_name\": \"John Doe\",\n \"prefix\": \"Mr.\",\n \"degree\": \"PhD\",\n \"email\": \"agent@example.com\",\n \"mobile\": \"987-654-3210\",\n \"home_phone\": \"123-456-7890\",\n \"gender\": \"Male\",\n \"introduction\": \"Experienced insurance agent.\",\n \"specialization\": \"Life Insurance\",\n \"npi\": \"NPI-123456\",\n \"zuid\": \"ZUID-001\",\n \"is_member_photo_available\": \"yes\",\n \"address_line1\": \"123 Main St\",\n \"address_line2\": \"Suite 100\",\n \"city\": \"Los Angeles\",\n \"state\": \"CA\",\n \"zip_code\": \"90001\",\n \"country\": \"USA\",\n \"created_date\": \"2025-09-10T10:00:00Z\",\n \"dtg\": \"DTG Info\"\n }\n ],\n \"pagination\": {\n \"page\": 1,\n \"per_page\": \"10\",\n \"has_more_page\": true,\n \"sort_column\": \"created_date\",\n \"sort_order\": \"D\"\n }\n}", "name": "" }, { "header": [], "code": 401, "body": "{\n \"message\": \"Unauthenticated\"\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"message\": \"Resource not found\"\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"message\": \"Resource not found\"\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"message\": \"Internal server error\"\n}", "name": "" } ] }, { "name": "Get Agent Availability", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/agent\/:agentId\/availability", "query": [ { "key": "from_date", "value": "2025-09-12T00%3A00%3A00Z", "description": "datetime Start of the date range (inclusive). Format: YYYY-MM-DDTHH:MM:SSZ.", "disabled": false }, { "key": "to_date", "value": "2025-09-19T23%3A59%3A59Z", "description": "datetime End of the date range (inclusive). Format: YYYY-MM-DDTHH:MM:SSZ.", "disabled": false }, { "key": "time_slot", "value": "2", "description": "Optional time slot to filter by (e.g., morning=1, afternoon=2, evening=3).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v2\/agent\/:agentId\/availability?from_date=2025-09-12T00%3A00%3A00Z&to_date=2025-09-19T23%3A59%3A59Z&time_slot=2", "variable": [ { "id": "agentId", "key": "agentId", "value": "42", "description": "The ID of the agent to check availability for." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Retrieve the available time slots for a specific agent within a given date range.\nYou can optionally filter by a specific time slot (e.g., morning, afternoon, evening).\n\nThis endpoint requires authentication using a bearer token." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"available_slots\": [\n \"2025-09-14T10:30:00Z\",\n \"2025-09-15T11:00:00Z\"\n ],\n \"facility_id\": \"abc123\",\n \"from_date\": \"2025-09-12T00:00:00Z\",\n \"to_date\": \"2025-09-19T23:59:59Z\",\n \"member_id\": \"member_001\",\n \"working_days\": \"Monday-Friday\"\n }\n}", "name": "" }, { "header": [], "code": 401, "body": "{\n \"message\": \"Unauthenticated.\"\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"message\": \"Agent not found.\"\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"message\": \"Internal server error.\"\n}", "name": "" } ] } ] }, { "name": "Appointments", "description": "", "item": [ { "name": "List Appointments", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/appointment\/list", "query": [ { "key": "start_date", "value": "2025-09-01", "description": "date filter results by start date.", "disabled": false }, { "key": "end_date", "value": "2025-09-30", "description": "date filter results by end date.", "disabled": false }, { "key": "status_type", "value": "sync", "description": "filter results by appointment status.", "disabled": false }, { "key": "page", "value": "1", "description": "Optional. Page number for pagination. Defaults to 1.", "disabled": false }, { "key": "per_page", "value": "10", "description": "Optional. Number of records per page. Defaults to 10.", "disabled": false }, { "key": "sort_column", "value": "%22created_date%2C+start_date%22", "description": "Optional. Column used for sorting. Valid options: created_date.", "disabled": false }, { "key": "sort_order", "value": "%22D%22", "description": "Optional. Sorting direction: \"D\" (descending) or \"A\" (ascending).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v2\/appointment\/list?start_date=2025-09-01&end_date=2025-09-30&status_type=sync&page=1&per_page=10&sort_column=%22created_date%2C+start_date%22&sort_order=%22D%22" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Retrieves a list of all patient appointments, optionally filtered by date and status." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"appointment_mode\": \"in-person\",\n \"category\": \"general\",\n \"created_at\": \"2025-09-01T10:00:00Z\",\n \"date_preference\": \"any\",\n \"date_type\": \"2025-09-15\",\n \"doctor_id\": 12,\n \"duration\": 30,\n \"end_at\": \"2025-09-15T10:30:00Z\",\n \"end_date\": \"2025-09-15\",\n \"end_date_time\": \"2025-09-15T10:30:00Z\",\n \"facility\": \"Main Clinic\",\n \"frequency\": 1,\n \"from_date\": \"2025-09-15\",\n \"from_time\": \"10:00\",\n \"from_time_period\": \"AM\",\n \"id\": 101,\n \"message_to_patient\": \"Please arrive 15 minutes early.\",\n \"original_datetime_tz\": \"PST\",\n \"patient_id\": 45,\n \"pharmacy_id\": \"RX123\",\n \"reason\": \"Checkup\",\n \"reason_for_cancellation\": null,\n \"scheduled_by\": \"staff\",\n \"source_id\": 1,\n \"specific_date_option_1\": \"2025-09-15\",\n \"specific_date_option_2\": \"2025-09-16\",\n \"specific_date_option_3\": \"2025-09-17\",\n \"status\": \"confirmed\",\n \"start_at\": \"2025-09-15T10:00:00Z\",\n \"start_date\": \"2025-09-15\",\n \"start_date_time\": \"2025-09-15T10:00:00Z\",\n \"start_time\": \"10:00\",\n \"start_time_period\": \"AM\",\n \"status_type\": \"upcoming\",\n \"time_preference\": \"morning\",\n \"to_date\": \"2025-09-15\",\n \"to_time\": \"10:30\",\n \"to_time_period\": \"AM\",\n \"updated_at\": \"2025-09-10T12:00:00Z\",\n \"visit_type\": \"consultation\",\n \"zoom_link\": \"https:\/\/zoom.us\/j\/abc123\"\n }\n ],\n \"pagination\": {\n \"page\": 1,\n \"per_page\": \"15\",\n \"has_more_page\": true,\n \"sort_column\": \"start_date\",\n \"sort_order\": \"asc\"\n }\n}", "name": "" }, { "header": [], "code": 401, "body": "{\n \"message\": \"Unauthenticated.\"\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"message\": \"Resource Not Found\"\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"message\": \"Internal Server Error\"\n}", "name": "" } ] }, { "name": "Store Prescribed Medicines (ERX) for an Appointment", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/appointment\/:appointmentId\/prescription", "query": [], "raw": "{{baseUrl}}\/api\/v2\/appointment\/:appointmentId\/prescription", "variable": [ { "id": "appointmentId", "key": "appointmentId", "value": "1", "description": "" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"medicine_id\":[1,2,3],\"subscription_plan_id\":5}" }, "description": "This endpoint allows you to associate one or more prescribed medicines (ERX) with a specific patient appointment.\n\nThe medicine data can be stored in two ways:\n- If a valid subscription plan is provided and contains prescription details, the medicines are stored under that plan.\n- Otherwise, the medicines are directly associated with the appointment." }, "response": [ { "header": [], "code": 200, "body": "{\n \"message\": \"Appointment updated with medicine successfully.\"\n}", "name": "" }, { "header": [], "code": 200, "body": "{\n \"message\": \"Subscription data stored successfully.\"\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"message\": \"Medicine not found in our record.\"\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"message\": \"failed\",\n \"reason\": {\n \"medicine_id\": [\"The medicine_id field is required.\"]\n }\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"message\": \"Internal Server Error.\"\n}", "name": "" } ] }, { "name": "Appointment Status", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/appointment\/:appointmentId\/status\/:patientId", "query": [], "raw": "{{baseUrl}}\/api\/v2\/appointment\/:appointmentId\/status\/:patientId", "variable": [ { "id": "appointmentId", "key": "appointmentId", "value": "456", "description": "The ID of the appointment." }, { "id": "patientId", "key": "patientId", "value": "123", "description": "The ID of the patient fetch from the patients endpoint." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get patient appointment status by patient ID and appointment ID." }, "response": [ { "header": [], "code": 200, "body": "{\n \"message\": \"Appointment status retrieved successfully\",\n \"appointment_status\": {\n \"status\": \"confirmed\"\n }\n}", "name": "" }, { "header": [], "code": 401, "body": "{\n \"message\": \"Unauthenticated\"\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"message\": \"Resource Not Found\"\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"message\": \"Internal Server Error\"\n}", "name": "" } ] }, { "name": "Cancel an appointment", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/appointment\/:appointmentId\/cancel", "query": [], "raw": "{{baseUrl}}\/api\/v2\/appointment\/:appointmentId\/cancel", "variable": [ { "id": "appointmentId", "key": "appointmentId", "value": "123", "description": "The ID of the appointment." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"patient_id\":456,\"reason_for_cancellation\":\"\\\"Patient unavailable\\\"\"}" }, "description": "This endpoint allows a patient to cancel a previously booked appointment.\n\nIt is typically used when a patient no longer wishes to attend a scheduled session or needs to reschedule.\nCancellation requests must include the appointment ID and patient ID to ensure that only the rightful\nowner of the appointment can cancel it. A reason for cancellation must also be provided to help with\nanalytics or policy enforcement (e.g., identifying frequent no-shows).\n\nOn success, the appointment is marked as canceled in the system, and may be made available for rebooking.\nIf the appointment has already occurred or is invalid, the system will return an appropriate error response.\n\nThe request requires a valid authentication token." }, "response": [ { "header": [], "code": 200, "body": "{\n \"message\": \"Appointment cancelled successfully\"\n}", "name": "" }, { "header": [], "code": 400, "body": "{\n \"message\": \"Bad Request\"\n}", "name": "" }, { "header": [], "code": 401, "body": "{\n \"message\": \"Unauthenticated\"\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"message\": \"Internal Server Error\"\n}", "name": "" } ] }, { "name": "Hold an appointment slot", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/appointment\/hold-slot", "query": [], "raw": "{{baseUrl}}\/api\/v2\/appointment\/hold-slot" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"member_id\":2345,\"start_time\":\"02:30\",\"start_date\":\"2025-09-20\",\"duration_in_minutes\":\"30\",\"start_time_period\":\"PM\",\"timezone\":\"America\\\/Los_Angeles\"}" }, "description": "This endpoint temporarily holds an appointment slot for a specific member (user\/patient).\n\nIt is typically used during the booking process to prevent race conditions or double-booking,\nespecially in systems with high concurrency. Once a slot is held, it is reserved for a short duration\n(e.g., 5\u201315 minutes) while the user completes the full booking workflow.\n\nThe held slot data includes:\n- `member_id`: The ID of the member requesting the appointment.\n- `start_time`: The starting time of the appointment (in 24-hour format).\n- `start_date`: The date of the appointment.\n- `duration_in_minutes`: The length of the appointment in minutes.\n\nOn success, the response includes the held appointment ID and a success message.\nIf the slot is already taken or invalid input is provided, appropriate error messages are returned." }, "response": [ { "header": [], "code": 200, "body": "{\n \"slot_id\": \"APT56789\"\n}", "name": "" }, { "header": [], "code": 400, "body": "{\n \"message\": \"Bad Request\"\n}", "name": "" }, { "header": [], "code": 401, "body": "{\n \"message\": \"Unauthenticated\"\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"message\": \"Internal Server Error\"\n}", "name": "" } ] }, { "name": "Reschedule Appointment", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/appointment\/:appointmentId\/reschedule", "query": [], "raw": "{{baseUrl}}\/api\/v2\/appointment\/:appointmentId\/reschedule", "variable": [ { "id": "appointmentId", "key": "appointmentId", "value": "20", "description": "The ID of the appointment to be rescheduled." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"patient_id\":1,\"doctor_id\":35,\"source_id\":21,\"reason\":\"\\\"Patient request\\\"\",\"appointment_mode\":\"\\\"Video Call\\\"\",\"category\":\"\\\"consultation\\\"\",\"status_type\":\"\\\"sync\\\"\",\"start_date\":\"\\\"2025-09-20\\\"\",\"start_time\":\"\\\"11:00\\\"\",\"start_time_period\":\"\\\"AM\\\"\",\"visitor_id\":75,\"timezone\":\"\\\"America\\\/Los_Angeles\\\"\"}" }, "description": "This endpoint allows rescheduling an existing appointment by providing a new date, time, and related details.\nIt requires the `appointmentId` as a path parameter, and the request body must contain key information such as patient, doctor, reason, and timing details.\n\nUse this endpoint to update the appointment schedule when changes are needed by either the patient or the doctor." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"id\": \"11968\"\n }\n}", "name": "" }, { "header": [], "code": 401, "body": "{\n \"message\": \"Unauthenticated\"\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"message\": \"Validation failed\",\n \"errors\": { \"field\": [\"Error message\"] }\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"message\": \"Appointment not found\"\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"message\": \"Internal Server Error\"\n}", "name": "" } ] }, { "name": "Get patient's last appointment mode", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/appointment\/last-appointment-mode", "query": [ { "key": "patient_id", "value": "23", "description": "The ID of the patient.", "disabled": false }, { "key": "source_id", "value": "12", "description": "The ID of the source\/template.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v2\/appointment\/last-appointment-mode?patient_id=23&source_id=12" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This endpoint retrieves the mode (e.g., in-person, video call, phone) of the **most recent appointment**\nfor a specific patient. It is useful for prefilling or suggesting the preferred mode when the patient\nis booking a new appointment, especially in systems with multiple modes of consultation.\n\nThe request requires both:\n- `patient_id`: The unique identifier of the patient whose appointment mode is being requested.\n- `source_id`: An identifier used to scope or filter the data (e.g., related to the appointment template or source system).\n\nThe response returns the last used `appointment_mode` for that patient, if available." }, "response": [ { "header": [], "code": 200, "body": "{\n \"appointment_mode\": \"video\"\n}", "name": "" }, { "header": [], "code": 401, "body": "{\n \"message\": \"Unauthenticated\"\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"message\": \"Patient or appointment data not found\"\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"message\": \"Internal Server Error\"\n}", "name": "" } ] }, { "name": "Get Appointment Details", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/appointment\/:appointmentId\/details", "query": [], "raw": "{{baseUrl}}\/api\/v2\/appointment\/:appointmentId\/details", "variable": [ { "id": "appointmentId", "key": "appointmentId", "value": "456", "description": "The ID of the appointment to retrieve details for." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Retrieve detailed information about a specific appointment by appointment ID.\n\nThis endpoint provides comprehensive information about the appointment, including:\n- Appointment mode (e.g., online, in-person)\n- Associated doctor and patient information\n- Date and time details (start\/end)\n- Status and type of the appointment\n- Zoom link (if applicable)\n- Any custom messages or notes sent to the patient\n\nIt is useful for:\n- Displaying appointment details in patient or doctor dashboards\n- Admin review of scheduled appointments\n- Debugging or auditing purposes\n\nRequires authentication via a valid token." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"appointment_mode\": \"Video Call\",\n \"category\": \"appointment\",\n \"created_at\": \"2025-09-15 06:54:44\",\n \"date_preference\": null,\n \"date_type\": \"single_date\",\n \"doctor_id\": 35,\n \"duration\": 30,\n \"end_date\": \"2025-09-20\",\n \"end_date_time\": \"2025-09-20 11:30:00\",\n \"facility\": null,\n \"frequency\": null,\n \"from_date\": null,\n \"from_time\": null,\n \"from_time_period\": null,\n \"id\": 11968,\n \"message_to_patient\": null,\n \"original_datetime_tz\": \"2025-09-20 11:00 AM PST\",\n \"patient_id\": 1,\n \"pharmacy_id\": 22,\n \"reason\": \"Fox\",\n \"reason_for_cancellation\": \"I am not intresed\",\n \"scheduled_by\": null,\n \"source_id\": 21,\n \"specific_date_option_1\": null,\n \"specific_date_option_2\": null,\n \"specific_date_option_3\": null,\n \"status\": \"cancelled\",\n \"start_date\": \"2025-09-20\",\n \"start_date_time\": \"2025-09-20 11:00:00\",\n \"start_time\": \"11:00:00\",\n \"start_time_period\": \"AM\",\n \"status_type\": \"sync\",\n \"time_preference\": null,\n \"to_date\": null,\n \"to_time\": null,\n \"to_time_period\": null,\n \"updated_at\": \"2025-09-16 02:14:58\",\n \"visit_type\": \"5\",\n \"zoom_link\": \"\",\n \"zoom_join_link\": \"https:\/\/zoom.us\/j\/xyz\",\n \"member_name\": \"Prescribery Provider\",\n \"type\": \"doctor\",\n \"member_picture\": \"https:\/\/s3.us-east-2.amazonaws.com\/stagingdtg\/profile_pic\/image1740566253.png\",\n \"service_title\": \"DietDoc\",\n \"start_at\": \"2025-09-20 11:00:00\",\n \"end_at\": \"2025-09-20 11:30:00\",\n \"parsed_start_time\": \"11:00:00\",\n \"zoom_join_copy_link\": \"https:\/\/zoom.us\/j\/xyz\",\n \"parsed_start_date\": \"2025-09-20\",\n \"parsed_start_period\": \"AM\"\n }\n}", "name": "" }, { "header": [], "code": 401, "body": "{\n \"message\": \"Unauthenticated\"\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"message\": \"Appointment not found\"\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"message\": \"Internal Server Error\"\n}", "name": "" } ] }, { "name": "Retrieve Patient Appointment Stats", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/appointment\/patient-stats", "query": [ { "key": "client_id", "value": "1", "description": "The ID of the client for which the appointment statistics are retrieved.", "disabled": false }, { "key": "source_id", "value": "21", "description": "Optional Filter appointments by source ID.", "disabled": false }, { "key": "from_date", "value": "%222024-12-01%22", "description": "Optional Filter appointments from this date (format: YYYY-MM-DD).", "disabled": false }, { "key": "to_date", "value": "%222024-12-10%22", "description": "Optional Filter appointments up to this date (format: YYYY-MM-DD).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v2\/appointment\/patient-stats?client_id=1&source_id=21&from_date=%222024-12-01%22&to_date=%222024-12-10%22" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This endpoint retrieves a list of patient appointment details associated with a given client.\nIt supports optional filters such as `source_id`, `from_date`, and `to_date` to narrow down results.\nThe response includes appointment status, appointment date, synchronization type, appointment ID, and patient record ID.\n\nUse this endpoint to track appointment histories, check appointment statuses, and retrieve identifiers useful for reporting or integrations." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"status\": \"completed\",\n \"appointment_date\": \"2024\/01\/25\",\n \"status_type\": \"sync\",\n \"appointment_id\": 123,\n \"patient_record_id\": \"PR12345\"\n }\n ]\n}", "name": "" }, { "header": [], "code": 400, "body": "{\n \"message\": \"Invalid input parameters\"\n}", "name": "" }, { "header": [], "code": 401, "body": "{\n \"message\": \"Unauthenticated\"\n}", "name": "" }, { "header": [], "code": 403, "body": "{\n \"message\": \"Forbidden\"\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"message\": \"Resource Not Found\"\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"message\": \"Internal Server Error\"\n}", "name": "" } ] }, { "name": "Store Appointment Discount", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/appointment\/:appointmentId\/discount", "query": [], "raw": "{{baseUrl}}\/api\/v2\/appointment\/:appointmentId\/discount", "variable": [ { "id": "appointmentId", "key": "appointmentId", "value": "11968", "description": "The ID of the appointment." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"patient_id\":1,\"discount_label\":\"\\\"Referral Discount\\\"\",\"amount\":25.5}" }, "description": "This endpoint stores discount related to a specific appointment in the database.\nUse this to apply a discount to an appointment with the necessary details such as patient, appointment ID, discount label, and amount." }, "response": [ { "header": [], "code": 200, "body": "{\n \"message\": \"Discount data stored successfully\"\n}", "name": "" }, { "header": [], "code": 400, "body": "{\n \"message\": \"Bad Request - Missing required fields or invalid data\"\n}", "name": "" }, { "header": [], "code": 401, "body": "{\n \"message\": \"Unauthenticated - Invalid token or missing authentication\"\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"message\": \"Internal Server Error\"\n}", "name": "" } ] }, { "name": "Book Appointment", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/appointments", "query": [], "raw": "{{baseUrl}}\/api\/v2\/appointments" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"source_id\":21,\"member_id\":887,\"patient_id\":5,\"mode\":\"audio\",\"reason\":\"Routine check-up\",\"patient_state\":\"california\",\"repetition\":\"Period\",\"start_time\":\"12:30\",\"start_time_period\":\"AM\",\"start_date\":\"2026-05-20\",\"duration_in_minutes\":30,\"video_link\":\"https:\\\/\\\/zoom.us\\\/j\\\/xyz\",\"order_id\":\"ORD12345\",\"order_type\":\"lab_test\",\"coupon_code\":\"SAVE20\",\"coupon_type\":\"percent\",\"coupon_value\":20,\"pharmacy_id\":22,\"message_to_patient\":\"Please join 5 mins early.\",\"timezone\":\"PST\",\"consultation_fee\":\"100.00\",\"medicine_ids\":[1,5,8]}" }, "description": "Store appointment data in the database for a patient. This includes appointment details, timing, prescription info, and optional coupon or subscription data." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"appointment_id\": \"A123456\"\n }\n}", "name": "" }, { "header": [], "code": 400, "body": "{\n \"message\": \"Bad Request\"\n}", "name": "" }, { "header": [], "code": 401, "body": "{\n \"message\": \"Unauthenticated\"\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"message\": \"Internal Server Error\"\n}", "name": "" } ] }, { "name": "List Patient Appointments", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/patient\/:patientId\/appointments", "query": [ { "key": "type", "value": "upcoming", "description": "The appointment status filter. Allowed values: cancelled, completed, upcoming.", "disabled": false }, { "key": "from_date", "value": "2025-09-10", "description": "Optional Start date filter in date-time format (e.g., \"2025-09-10\")", "disabled": false }, { "key": "to_date", "value": "2025-09-20", "description": "Optional End date filter in date-time format (e.g., \"2025-09-20\")", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v2\/patient\/:patientId\/appointments?type=upcoming&from_date=2025-09-10&to_date=2025-09-20", "variable": [ { "id": "patientId", "key": "patientId", "value": "1", "description": "The ID of the patient fetch from the patients endpoint." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Retrieves a list of appointments for a specific patient filtered by type and optionally by date range.\n\nThe available `type` filter values are:\n- `cancelled`: Returns appointments that have been cancelled\n- `completed`: Returns past completed appointments\n- `upcoming`: Returns future scheduled appointments\n\nUseful for displaying appointment history and upcoming appointments in patient dashboards.\nSupports optional filtering by `from_date` and `to_date` for custom date ranges.\n\nRequires authentication via a valid token." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"id\": 11776,\n \"facility\": \"doctalkgo\",\n \"category\": \"appointment\",\n \"patient_id\": 3269,\n \"doctor_id\": 34,\n \"source_id\": 97,\n \"pharmacy_id\": null,\n \"status\": \"processing\",\n \"appointment_mode\": \"Phone Call\",\n \"date_type\": \"single_date\",\n \"original_datetime_tz\": \"2025-12-31 07:20 AM PST\",\n \"start_date_time\": \"2025-12-31 07:20:00\",\n \"end_date_time\": \"2025-12-31 07:30:00\",\n \"duration\": 10,\n \"reason\": \"test1234556\",\n \"status_type\": \"sync\",\n \"zoom_link\": \"\",\n \"zoom_join_link\": \"\",\n \"zoom_response\": \"\",\n \"tenant_id\": \"392ab90f-3094-407d-8510-529008ce3fd4\",\n \"rx_tracker_status\": \"in_progress\",\n \"patient_state\": \"California\",\n \"created_at\": \"2025-08-07 09:18:29\",\n \"updated_at\": \"2025-08-07 09:19:08\",\n \"member_name\": \"TEST TEST\",\n \"type\": \"therapist\",\n \"member_picture\": null,\n \"service_title\": \"Wellcore\",\n \"start_at\": null,\n \"end_at\": null,\n \"parsed_start_time\": \"07:20:00\",\n \"zoom_join_copy_link\": \"\",\n \"parsed_start_date\": \"2025-12-31\",\n \"parsed_start_period\": \"AM\"\n }\n ]\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"message\": \"No appointments found\"\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"message\": \"Internal Server Error\"\n}", "name": "" } ] }, { "name": "Get Patient Medication Status", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/appointment\/patient-medication-status", "query": [ { "key": "patient_id", "value": "45", "description": "The ID of the patient.", "disabled": false }, { "key": "product_ids", "value": "%22148%2C149%22", "description": "Comma-separated list of product IDs.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v2\/appointment\/patient-medication-status?patient_id=45&product_ids=%22148%2C149%22" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Calculate medication status (rest period, active days, etc.) for a patient across multiple products." }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"data\": {\n \"148\": {\n \"Enclomiphene\": {\n \"can_order\": false,\n \"reason\": \"Patient is in rest period\",\n \"rest_days_remaining\": 5,\n \"can_order_date\": \"2026-05-19\",\n \"days_passed\": 25,\n \"days_of_supply\": 30\n }\n }\n }\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"success\": false,\n \"message\": \"patient_id is required\"\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"message\": \"Internal Server Error\"\n}", "name": "" } ] } ] }, { "name": "Authentication", "description": "", "item": [ { "name": "Generate Access Token Using API Key", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/access-token", "query": [], "raw": "{{baseUrl}}\/api\/v2\/access-token" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"api_key\":\"optio\"}" }, "description": "This endpoint is used to authenticate a client application using a valid API key,\nand in return, it generates a short-lived access token (JWT) and a long-lived refresh token.\nThe access token must be included in the Authorization header for all protected API requests.\n\n### How it works:\n- Clients make a POST request to this endpoint, supplying their API key in the request body.\n- The API key is validated against the system's credentials.\n- If the key is valid:\n - A JWT access token is issued with a predefined expiration (e.g., 1 hour).\n - A refresh token is also returned, allowing the client to request a new access token after expiration.\n- If the key is invalid or missing, an appropriate error response is returned.\n\n### When to use:\n- This endpoint should be called when the client application is first initializing,\n or when it needs to re-authenticate using a known API key.\n- It is typically used in server-to-server integrations, mobile apps, or services that do not rely on\n user login but need secure access to protected endpoints.\n\n### Tokens explained:\n- `access_token`: A JWT (JSON Web Token) that must be used in the `Authorization` header\n of subsequent API calls as `Bearer `. It has an expiration (e.g., 3600 seconds).\n- `refresh_token`: A secure token that can be used to obtain a new access token without re-submitting\n the API key. This is useful when the access token expires.\n- `token_type`: Typically \"Bearer\", which defines the scheme used in the `Authorization` header.\n\n### Example Authorization Header:\n```\nAuthorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOi...\n```", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"token_type\": \"Bearer\",\n \"expires_in\": 3600,\n \"access_token\": \"eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9...\",\n \"refresh_token\": \"def50200d06fe59a4ba37aca6f0fd5d5a50c05a4fe683e3c...\"\n }\n}", "name": "" }, { "header": [], "code": 401, "body": "{\n \"message\": \"Unauthorized\"\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"message\": \"The api_key field is required.\",\n \"errors\": {\n \"api_key\": [\n \"The api_key field is required.\"\n ]\n }\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"message\": \"Failed to generate token.\"\n}", "name": "" } ] }, { "name": "Refresh Access Token", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/refresh-token", "query": [ { "key": "refresh_token", "value": "6ZbQWnFuJ8dLbgZOEQ%3D%3D", "description": "The refresh token used to request a new access token.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v2\/refresh-token?refresh_token=6ZbQWnFuJ8dLbgZOEQ%3D%3D" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-Custom-Decode", "value": "boolean Optional. If `true`, the refresh token will be decrypted before use. Example: true" } ], "body": null, "description": "This endpoint allows clients to obtain a new access token by using a previously issued **refresh token**.\nIt is part of the OAuth 2.0 token lifecycle and is used when the original access token has expired or is about to expire.\n\n### How it works:\n- Clients send a request to this endpoint with a valid `refresh_token`.\n- If the token is valid and hasn't expired, a **new access token** and **new refresh token** are issued.\n- If the token is invalid or expired, the server returns a `401 Unauthorized` response." }, "response": [ { "header": [], "code": 200, "body": "{\n \"access_token\": \"encrypted_access_token_value\",\n \"refresh_token\": \"encrypted_refresh_token_value\"\n}", "name": "" }, { "header": [], "code": 401, "body": "{\n \"message\": \"unauthorized\"\n}", "name": "" } ] } ] }, { "name": "Clients", "description": "", "item": [ { "name": "Get Client Addon Consultation Fees", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/client\/:id\/addon-consultation-fees", "query": [], "raw": "{{baseUrl}}\/api\/v2\/client\/:id\/addon-consultation-fees", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the client." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns the addon consultation fee for a specific client.\nIf the client has a specific fee set, it will be returned; otherwise, the default global fee will be used." }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": true,\n \"addon_consultation_fee\": 10.0\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"message\": \"Client not found\"\n}", "name": "" } ] } ] }, { "name": "Labs", "description": "", "item": [ { "name": "Create Lab Test Order", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/lab\/:clientId\/save-test-order", "query": [], "raw": "{{baseUrl}}\/api\/v2\/lab\/:clientId\/save-test-order", "variable": [ { "id": "clientId", "key": "clientId", "value": "1", "description": "" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"patient_id\":1,\"order\":[\"et\"],\"source_id\":21,\"service_id\":3,\"reason\":\"\\\"Routine checkup\\\"\",\"payment_status\":\"paid\",\"payment_amount\":250.75,\"charge_id\":\"ch_123456\",\"payment_method\":\"card\"}" }, "description": "This endpoint creates a lab test order associated with the specified client ID.\nIt accepts patient ID, an array of lab test orders, and other optional metadata like service ID, source ID, and reason for the order." }, "response": [ { "header": [], "code": 200, "body": "{\n \"token\": \"generated-token-string\"\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"message\": \"Validation failed\",\n \"errors\": { \"field_name\": [\"Error message\"] }\n}", "name": "" }, { "header": [], "code": 401, "body": "{\n \"message\": \"Unauthenticated - Invalid or missing token\"\n}", "name": "" }, { "header": [], "code": 400, "body": "{\n \"message\": \"Bad Request - Invalid data provided\"\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"message\": \"Internal Server Error\"\n}", "name": "" } ] }, { "name": "Get Lab Test Details", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/lab\/:token\/test-details", "query": [], "raw": "{{baseUrl}}\/api\/v2\/lab\/:token\/test-details", "variable": [ { "id": "token", "key": "token", "value": "%22abc123xyz%22", "description": "The unique token returned from the `save-test-order` endpoint." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Retrieve detailed lab test information using the token generated from the `save-test-order` endpoint.\nThis endpoint returns the lab name, test details, charges, and total amount for the order." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"total_amount\": 1200,\n \"lab_charges\": 200,\n \"lab_test_details\": [\n {\n \"lab_name\": \"City Diagnostic Center\",\n \"lab_tests\": \"Blood Test, Urine Test\"\n }\n ]\n }\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"message\": \"The token is invalid or expired.\"\n}", "name": "" }, { "header": [], "code": 401, "body": "{\n \"message\": \"Unauthenticated - Invalid or missing token\"\n}", "name": "" }, { "header": [], "code": 400, "body": "{\n \"message\": \"Bad Request - Invalid data provided\"\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"message\": \"Internal Server Error\"\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"message\": \"Sorry! lab test detail not found.\"\n}", "name": "" } ] }, { "name": "Update Lab Order Details", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/lab\/update-order-details", "query": [], "raw": "{{baseUrl}}\/api\/v2\/lab\/update-order-details" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"patient_id\":101,\"token\":\"abc123xyz\",\"amount\":1500,\"charge_id\":\"ch_123456\"}" }, "description": "Update specific details of a Lab Order (such as amount, charges, or associated patient) using the provided token." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"order_id\": 5001,\n \"updated_amount\": 1500,\n \"updated_charge_id\": 12\n }\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"message\": \"Validation failed\",\n \"errors\": {\n \"amount\": [\n \"The amount must be a number.\"\n ]\n }\n}", "name": "" }, { "header": [], "code": 401, "body": "{\n \"message\": \"Unauthenticated\"\n}", "name": "" }, { "header": [], "code": 400, "body": "{\n \"message\": \"Bad Request\"\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"message\": \"Internal Server Error\"\n}", "name": "" } ] }, { "name": "Upload Patient Lab Reports", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/lab\/upload-report-documents", "query": [], "raw": "{{baseUrl}}\/api\/v2\/lab\/upload-report-documents" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart\/form-data" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "formdata", "formdata": [ { "key": "source_id", "value": 21, "type": "text", "description": "The source ID related to the patient\u2019s lab order." }, { "key": "patient_id", "value": 101, "type": "text", "description": "The ID of the patient the lab reports belong to." }, { "key": "json_response", "value": "{\"lab_name\": \"Quest Diagnostics\", \"test_type\": \"Blood Test\"}", "type": "text", "description": "optional A JSON payload for additional lab report metadata." }, { "key": "report_files[]", "src": [], "type": "file" } ] }, "description": "Upload one or more lab report documents for a patient.\nThe uploaded files will be stored in S3 and recorded in the Kulbersh order table." }, "response": [ { "header": [], "code": 200, "body": "{\n \"message\": \"Lab reports uploaded successfully\"\n}", "name": "" }, { "header": [], "code": 400, "body": "{\n \"message\": \"Bad Request\"\n}", "name": "" }, { "header": [], "code": 401, "body": "{\n \"message\": \"Unauthenticated\"\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"message\": \"Internal Server Error\"\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"message\": \"Patient not found\"\n}", "name": "" } ] }, { "name": "Get Lab Test List by Client", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/lab\/list\/:clientId\/:method", "query": [], "raw": "{{baseUrl}}\/api\/v2\/lab\/list\/:clientId\/:method", "variable": [ { "id": "clientId", "key": "clientId", "value": "2", "description": "The ID of the client to filter labs." }, { "id": "method", "key": "method", "value": "1", "description": "Optional method to filter the labs using the medyhod id (1 for Kulbersh, 2 for Tasso, 3 for Scarlet qnd 4 for MyDirectLabs)." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Retrieves the list of labs filtered by the specified client ID.\nThe client ID is Required.\nAn optional method parameter can be provided to filter labs by method type (default is 1).\n\nRequires authentication via bearer token." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"id\": 101,\n \"user_id\": 23,\n \"name\": \"LabCorp\",\n \"soft_delete\": 0,\n \"selected\": \"yes\",\n \"lab_test\": {\n \"id\": 201,\n \"user_id\": 23,\n \"website\": 1,\n \"lab_id\": 101,\n \"test_id\": 301,\n \"test_description\": \"Blood sugar test\",\n \"price\": \"50.00\",\n \"soft_delete\": 0,\n \"status\": 1,\n \"test\": {\n \"id\": 301,\n \"user_id\": 23,\n \"name\": \"Blood Sugar\",\n \"code\": \"BSG123\",\n \"soft_delete\": 0,\n \"status\": 1\n }\n }\n }\n}", "name": "" }, { "header": [], "code": 401, "body": "{\n \"message\": \"Unauthenticated.\"\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"message\": \"Resource Not Found.\"\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"message\": \"Unprocessable Entity.\"\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"message\": \"Internal Server Error.\"\n}", "name": "" } ] }, { "name": "Get Lab Orders By Client", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/lab\/:clientId\/lab-orders", "query": [ { "key": "patient_id", "value": "7", "description": "optional The unique ID of the patient to filter labs by. If not provided, labs for all patients of the client will be returned fetch patient id from the patients endpoint.", "disabled": false }, { "key": "page", "value": "1", "description": "optional Page number for pagination. Default is 1.", "disabled": false }, { "key": "per_page", "value": "10", "description": "optional Number of records per page for pagination. Default is 10. maximum is 100.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v2\/lab\/:clientId\/lab-orders?patient_id=7&page=1&per_page=10", "variable": [ { "id": "clientId", "key": "clientId", "value": "123", "description": "The unique ID of the client whose patient labs are being retrieved." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Fetches all lab orders of a client, or for a specific patient if patientId is provided.\nSupports pagination." }, "response": [ { "header": [], "code": 200, "body": "{\n \"code\": \"success\",\n \"data\": [\n {\n \"id\": 1,\n \"serial_no\": 123,\n \"order_amount\": 100.50,\n \"panel\": \"Basic Metabolic Panel\",\n \"patient_id\": \"1\",\n \"patient_name\": \"John Doe\",\n \"payment_status\": \"paid\",\n \"client_name\": \"paid\",\n \"order_date\": \"2025-07-10 10:00:00\",\n \"results_status\": \"pending\",\n }\n ],\n \"page\": \"1\",\n \"number_of_page\": 11,\n \"total_record\": 11\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n\"message\": \"clientId is required\"\n }", "name": "" }, { "header": [], "code": 404, "body": "{\n\"message\": \"Client not found\"\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n\"message\": \"Internal Server Error\"\n}", "name": "" } ] } ] }, { "name": "Leads", "description": "", "item": [ { "name": "Store Lead", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/lead\/create", "query": [], "raw": "{{baseUrl}}\/api\/v2\/lead\/create" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"\\\"John Doe\\\"\",\"email\":\"\\\"johndoe@example.com\\\"\",\"source_id\":\"21\",\"phone_number\":\"\\\"+1234567890\\\"\",\"zip_code\":\"\\\"94105\\\"\",\"referred_by\":\"\\\"Google Ads\\\"\",\"state\":\"\\\"CA\\\"\",\"referral_code\":\"\\\"REF123\\\"\",\"source\":\"\\\"Facebook, Product Type, Site\\\"\",\"sign_up_reason\":\"\\\"Product name\\\"\"}" }, "description": "This endpoint allows you to create and store a new lead record in the system.\nLeads typically represent potential patients, clients, or customers who are\ninterested in your services.\n\nA lead can include identifying details such as name, email, phone number,\nstate, and ZIP code, along with optional referral information (e.g., referral\ncode or referred_by). This data can be used for follow-ups, sales tracking,\nand marketing attribution.\n\nOn successful creation, the API returns a confirmation message along with the\nstored lead details." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"lead_id\": 101,\n \"user_id\": \"65\",\n \"affiliate_referral_id\": \"94105\",\n }\n}", "name": "" }, { "header": [], "code": 400, "body": "{\n \"message\": \"Bad Request\"\n}", "name": "" }, { "header": [], "code": 401, "body": "{\n \"message\": \"Unauthenticated\"\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"message\": \"Internal Server Error\"\n}", "name": "" } ] }, { "name": "Add Lead Agent Appointment", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/lead\/agent-appointment", "query": [], "raw": "{{baseUrl}}\/api\/v2\/lead\/agent-appointment" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"lead_id\":101,\"member_id\":45,\"reason\":\"\\\"Initial Consultation\\\"\",\"start_date\":\"\\\"2025-09-25\\\"\",\"start_time\":\"\\\"02:30 PM\\\"\",\"duration_in_minutes\":60}" }, "description": "This endpoint creates a new appointment for a specific lead with an assigned agent (member).\nAppointments are typically scheduled when a lead expresses interest in services, and this allows\ntracking of meetings, consultations, or follow-up calls.\n\nThe appointment includes key details such as the reason for the meeting, the date and time (in PST),\nand the optional duration. Once created, the system returns the unique appointment ID along with\na confirmation message." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"appointment_id\": \"APT-20250918-12345\",\n \"lead_id\": 101,\n \"member_id\": 45,\n \"reason\": \"Initial Consultation\",\n \"start_date\": \"2025-09-25\",\n \"start_time\": \"14:30\",\n \"duration_in_minutes\": 60,\n \"timezone\": \"PST\"\n }\n}", "name": "" }, { "header": [], "code": 400, "body": "{\n \"message\": \"Bad Request\"\n}", "name": "" }, { "header": [], "code": 401, "body": "{\n \"message\": \"Unauthenticated\"\n}", "name": "" }, { "header": [], "code": 409, "body": "{\n \"message\": \"This time-slot is already booked.\"\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"message\": \"Lead not found\"\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"message\": \"Validation error\",\n \"errors\": {\n \"lead_id\": [\"The lead_id field is required.\"],\n \"start_date\": [\"The start_date field must be a valid date.\"]\n }\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"message\": \"Internal Server Error\"\n}", "name": "" } ] }, { "name": "Update a Lead", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/lead\/:leadId\/update", "query": [], "raw": "{{baseUrl}}\/api\/v2\/lead\/:leadId\/update", "variable": [ { "id": "leadId", "key": "leadId", "value": "42", "description": "The ID of the lead to update." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"sign_up_reason\":\"\\\"Product Name\\\"\",\"zip_code\":\"\\\"94016\\\"\",\"term_service\":\"\\\"yes\\\"\",\"status\":\"quis\",\"agent_id\":10,\"email\":\"stokes.destiney@example.org\",\"source\":\"\\\"Facebook\\\"\"}" }, "description": "This endpoint updates an existing lead\u2019s information in the system.\nYou can modify fields such as the reason for sign-up, the zip code, and the acceptance of terms of service.\nTypically used after a lead has been created to update or correct their details." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"lead\": {\n \"lead_id\": 212,\n \"user_id\": 458,\n }\n },\n}", "name": "" }, { "header": [], "code": 400, "body": "{\n \"message\": \"Bad Request\"\n}", "name": "" }, { "header": [], "code": 401, "body": "{\n \"message\": \"Unauthenticated\"\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"message\": \"Lead not found\"\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"message\": \"Validation error\",\n \"errors\": {\n \"zip_code\": [\"The zip_code must be a valid format.\"]\n }\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"message\": \"Internal Server Error\"\n}", "name": "" } ] } ] }, { "name": "Members", "description": "", "item": [ { "name": "Members", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/members", "query": [ { "key": "source_id", "value": "21", "description": "The ID of the source is fetch from get client active sources to filter members.", "disabled": false }, { "key": "license_state", "value": "California", "description": "The license state to filter members (e.g., California).", "disabled": false }, { "key": "medicine_check", "value": "1", "description": "Optional. Filter by whether the member has passed a medicine check.", "disabled": false }, { "key": "availability_type", "value": "sync", "description": "Optional. Filter by availability type. Acceptable values: \"sync\", \"async\".", "disabled": false }, { "key": "page", "value": "1", "description": "Optional. The page number to retrieve. Defaults to 1 if not provided.", "disabled": false }, { "key": "per_page", "value": "10", "description": "Optional. Number of members to return per page. Defaults to 10.", "disabled": false }, { "key": "sort_column", "value": "created_date", "description": "Optional. The column name to sort the results by (e.g., created_date).", "disabled": false }, { "key": "sort_order", "value": "D", "description": "Optional. The sorting order. Acceptable values: \"D\" for descending, \"A\" for ascending.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v2\/members?source_id=21&license_state=California&medicine_check=1&availability_type=sync&page=1&per_page=10&sort_column=created_date&sort_order=D" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Fetch a paginated list of members with optional filtering, sorting, and availability checks.\n\nThis endpoint returns a list of members based on provided query parameters such as source ID, license state, availability type, and more. It supports pagination and allows sorting by specified fields." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"member_id\": 1001,\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"full_name\": \"Jane Doe\",\n \"prefix\": \"Dr.\",\n \"degree\": \"MD\",\n \"email\": \"member@example.com\",\n \"mobile\": \"555-987-6543\",\n \"home_phone\": \"555-123-4567\",\n \"gender\": \"Female\",\n \"address_line1\": \"123 Main St\",\n \"address_line2\": \"Apt 4B\",\n \"city\": \"Los Angeles\",\n \"state\": \"CA\",\n \"zip_code\": \"90001\",\n \"country\": \"USA\",\n \"specialization\": \"Pediatrics\",\n \"npi\": \"NPI-987654\",\n \"zuid\": \"ZUID-12345\",\n \"dtg\": \"Some DTG Info\",\n \"introduction\": \"Experienced member in healthcare.\",\n \"is_member_photo_available\": \"yes\",\n \"created_date\": \"2025-09-10T10:00:00Z\"\n }\n ],\n \"pagination\": {\n \"page\": 1,\n \"per_page\": \"10\",\n \"has_more_page\": true,\n \"sort_column\": \"created_date\",\n \"sort_order\": \"D\"\n }\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"message\": \"Resource Not Found\"\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"source_id\": [\n \"The source id field is required.\"\n ],\n \"license_state\": [\n \"The license state field is required.\"\n ]\n }\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"message\": \"Internal Server Error\"\n}", "name": "" } ] }, { "name": "Check Member Availability", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/members\/:memberId\/availability", "query": [ { "key": "from_date", "value": "%222025-09-15%22", "description": "The start of the availability, Format: YYYY-MM-DD..", "disabled": false }, { "key": "to_date", "value": "%222025-09-15%22", "description": "The end of the availability, Format: YYYY-MM-DD.. Example.", "disabled": false }, { "key": "time_slot", "value": "5", "description": "Optional. Specific time slot to filter the results. If provided, only availability for that slot will be returned.", "disabled": false }, { "key": "timezone", "value": "%22America%2FPhoenix%22", "description": "Optional. Specify the timezone for the availability. Acceptable values include \"PST\" or \"America\/Phoenix\". Defaults to PST if not specified.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v2\/members\/:memberId\/availability?from_date=%222025-09-15%22&to_date=%222025-09-15%22&time_slot=5&timezone=%22America%2FPhoenix%22", "variable": [ { "id": "memberId", "key": "memberId", "value": "123", "description": "The unique identifier of the member whose availability is being queried." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns available time slots for a specific member within a specified date and time range.\n\nThis endpoint allows clients to check when a member is available between two date-time values. Optional filters such as time slot ID and timezone can be provided for more refined results." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"member_id\": \"123\",\n \"facility_id\": \"FAC-001\",\n \"from_date\": \"2025-09-15T09:00:00Z\",\n \"to_date\": \"2025-09-15T17:00:00Z\",\n \"working_days\": \"Mon-Fri\",\n \"available_slots\": [\n \"2025-09-15T09:30:00Z\",\n \"2025-09-15T10:00:00Z\",\n \"2025-09-15T11:30:00Z\"\n ]\n }\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"message\": \"Resource Not Found\"\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"from_date\": [\n \"The from date field is required.\"\n ],\n \"to_date\": [\n \"The to date field is required.\"\n ]\n }\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"message\": \"Internal Server Error\"\n}", "name": "" } ] }, { "name": "Retrieve Member Details", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/members\/:memberId\/details", "query": [], "raw": "{{baseUrl}}\/api\/v2\/members\/:memberId\/details", "variable": [ { "id": "memberId", "key": "memberId", "value": "123", "description": "The unique identifier of the member whose details are being requested." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Fetches detailed profile information for a specific member by their unique ID.\n\nThis endpoint returns personal and contact details of the member, including name, email, phone number, and profile avatar. Useful for displaying member profiles in applications." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"id\": 1,\n \"full_name\": \"John Doe\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"email\": \"john@example.com\",\n \"avatar\": \"https:\/\/example.com\/avatar.jpg\",\n \"phone_number\": \"1234567890\"\n }\n}", "name": "" }, { "header": [], "code": 401, "body": "{\n \"message\": \"Unauthenticated.\"\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"message\": \"Member Not Found\"\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"message\": \"The member was not found.\",\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"message\": \"Internal Server Error\"\n}", "name": "" } ] }, { "name": "Members Available Slots", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/members\/availableslots", "query": [ { "key": "source_id", "value": "21", "description": "The unique source identifier to filter members fetch from get client active sources.", "disabled": false }, { "key": "license_state", "value": "California", "description": "The license state to filter members by. (e.g., \"California\").", "disabled": false }, { "key": "from_date", "value": "2025-11-20", "description": "date Optional. The start date of the availability (format: YYYY-MM-DD). If not provided, defaults to today.", "disabled": false }, { "key": "to_date", "value": "2025-11-25", "description": "date Optional. The end date of the availability (format: YYYY-MM-DD). If not provided, defaults to 7 days after `from_date`.", "disabled": false }, { "key": "time_slot", "value": "10", "description": "Optional. Specific time slot to narrow down results.", "disabled": false }, { "key": "timezone", "value": "America%2FPhoenix", "description": "Optional. The timezone in which to evaluate availability. Acceptable values include time zone abbreviations (e.g., \"PST\") or full identifiers (e.g., \"America\/Phoenix\"). Defaults to PST.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v2\/members\/availableslots?source_id=21&license_state=California&from_date=2025-11-20&to_date=2025-11-25&time_slot=10&timezone=America%2FPhoenix" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Retrieve available time slots for multiple members based on filter criteria such as source ID, license state, date range, time slot, and timezone.\n\nThis endpoint allows clients to query for available appointment slots for all matching members. The response groups available slots by date and includes the associated member IDs." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"2023-11-20\": [\n {\n \"start_time\": \"09:00\",\n \"end_time\": \"10:00\",\n \"member_id\": \"member123\"\n },\n {\n \"start_time\": \"10:00\",\n \"end_time\": \"11:00\",\n \"member_id\": \"member456\"\n }\n ],\n \"2023-11-21\": [\n {\n \"start_time\": \"13:00\",\n \"end_time\": \"14:00\",\n \"member_id\": \"member789\"\n }\n ]\n }\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"message\": \"Resource Not Found\"\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"source_id\": [\n \"The source id field is required.\"\n ],\n \"license_state\": [\n \"The license state field is required.\"\n ]\n }\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"message\": \"Internal Server Error\"\n}", "name": "" } ] } ] }, { "name": "Patients", "description": "", "item": [ { "name": "Get Active Patients (Paginated)", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/patients", "query": [ { "key": "search", "value": "est", "description": "Optional search term to filter by name, email, or record ID. Example:", "disabled": false }, { "key": "with_terms", "value": "1", "description": "Optional flag to include whether the patient accepted terms.", "disabled": false }, { "key": "sort_column", "value": "first_name", "description": "Column to sort by created_at, first_name, last_name, gender, dob. Default: created_at.", "disabled": false }, { "key": "sort_order", "value": "D", "description": "Sort direction. \"A\" = Ascending, \"D\" = Descending. Default: D.", "disabled": false }, { "key": "page", "value": "1", "description": "Page number for pagination. Default: 1.", "disabled": false }, { "key": "per_page", "value": "10", "description": "Number of results per page. Default: 10.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v2\/patients?search=est&with_terms=1&sort_column=first_name&sort_order=D&page=1&per_page=10" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Retrieves a paginated list of active patients, supporting filtering, sorting, and pagination.\n\nYou can filter by `search` (full name, email, or record ID) and request additional flags such as whether the patient has accepted terms.\nIf the authenticated user belongs to a company, the results are scoped to that client." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"gender\": \"female\",\n \"first_name\": \"Alice\",\n \"last_name\": \"Smith\",\n \"full_name\": \"Alice Smith\",\n \"email\": \"alice@example.com\",\n \"mobile\": \"9876543210\",\n \"dob\": \"1990-05-01\",\n \"record_id\": \"PAT1023\",\n \"patient_id\": 42,\n \"created_time\": \"2025-07-09 10:32:00\",\n \"created_date\": \"2025-07-09 10:32:00\",\n \"active\": \"active\",\n \"postal_code\": \"10001\",\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"height\": \"5\",\n \"weight\": \"60\",\n \"font_color\": \"#333333\",\n \"term_service\": 1,\n \"identifier\": {\n \"use\": \"usual\",\n \"value\": 42\n },\n \"stripe_customer_id\": \"cus_abc123\"\n }\n ],\n \"input\": {\n \"search\": \"Alice\",\n \"sort_column\": \"created_at\",\n \"sort_order\": \"D\"\n },\n \"pagination\": {\n \"page\": 1,\n \"per_page\": 10,\n \"has_more_page\": \"true\",\n \"sort_column\": \"created_at\",\n \"sort_order\": \"D\"\n }\n}", "name": "" }, { "header": [], "code": 401, "body": "{\n \"message\": \"Unauthenticated\"\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"message\": \"Internal Server Error.\",\n}", "name": "" } ] }, { "name": "Create Patient", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/patients", "query": [], "raw": "{{baseUrl}}\/api\/v2\/patients" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"first_name\":\"John\",\"last_name\":\"Doe\",\"dob\":\"1990-01-01\",\"gender\":\"male\",\"email\":\"john.doe@example.com\",\"mobile\":\"9898989898\",\"billing_address\":{\"address_line1\":\"123 Elm St\",\"address_line2\":\"Apt 4B\",\"city\":\"California city\",\"state\":\"California\",\"postal_code\":\"90001\",\"country\":\"us\"},\"driver_license_number\":\"ABC123456\",\"language\":\"English\",\"communication_type\":\"phone\",\"referred_by\":\"Facebook\",\"term_service\":true,\"informed_consent\":true,\"height\":\"180\",\"weight\":\"70\",\"shipping_address\":{\"address_line1\":\"500 Market Street\",\"address_line2\":\"Suite 8\",\"city\":\"San Francisco\",\"state\":\"California\",\"country\":\"us\",\"postal_code\":\"94105\"}}" }, "description": "Store a patient record.\n\nThis endpoint registers a new patient with first name, last name, dob(date of birth in `Y-m-d` format), gender, billing and shipping address, unique email and phone number." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"identifier\": {\n \"use\": \"usual\",\n \"value\": 105\n },\n \"id\": \"105\",\n \"record_id\": \"PAT105\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"dob\": \"1990-01-01\",\n \"address_line1\": \"123 Elm Street\",\n \"address_licne2\": \"Apt 4B\",\n \"city\": \"Los Angeles\",\n \"state\": \"Califrnia\",\n \"country\": \"us\",\n \"postal_code\": \"90001\",\n \"district\": null,\n \"email\": \"john.doe@example.com\",\n \"mobile\": \"9876543210\",\n \"smoking_status\": \"\",\n \"marital_status\": \"\",\n \"employment_status\": \"\",\n \"gender\": \"male\",\n \"height\": \"5\",\n \"weight\": \"70\",\n \"status\": \"active\",\n \"blood_group\": null,\n \"profile_img\": null,\n \"communication_type\": \"phone\",\n \"language\": \"English\",\n \"shipping_address_line1\": null,\n \"shipping_address_line2\": null,\n \"shipping_city\": null,\n \"shipping_state\": \"California\",\n \"shipping_postal_code\": \"90001\",\n \"term_service\": 0,\n \"informed_consent\": 0,\n }\n ],\n}", "name": "" }, { "header": [], "code": 401, "body": "{\n \"message\": \"Unauthenticated\"\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"message\": \"failed\",\n \"reason\": {\n \"email\": [\"The email field is required.\"],\n \"dob\": [\"The dob field is required.\"]\n }\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"message\": \"Internal Server Error.\",\n}", "name": "" } ] }, { "name": "Check User Qualification", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/patients\/check-qualification", "query": [], "raw": "{{baseUrl}}\/api\/v2\/patients\/check-qualification" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"email\":\"johndoe@example.com\",\"dob\":\"1990-05-12\",\"medications\":\"Aspirin,Metformin\"}" }, "description": "This endpoint verifies whether a patient qualifies based on the provided information:\nemail, date of birth (DOB), and current medications." }, "response": [ { "header": [], "code": 200, "body": "{\n \"message\": \"User qualifies based on provided information\"\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"email\": [\"The email field is required.\"],\n \"dob\": [\"The dob field is required.\"],\n \"medications\": [\"The medications field is required.\"]\n }\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"message\": \"Internal Server Error\"\n}", "name": "" } ] }, { "name": "Update Patient", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/patients\/:patientId", "query": [], "raw": "{{baseUrl}}\/api\/v2\/patients\/:patientId", "variable": [ { "id": "patientId", "key": "patientId", "value": "12+or+PAT000001", "description": "or id required The ID or Record ID of the patient fetch from the patients endpoint. Use `id` or `record_id` as literal string to trigger field-based lookup." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"first_name\":\"John\",\"last_name\":\"Doe\",\"dob\":\"1990-01-01\",\"gender\":\"male\",\"email\":\"john.doe@example.com\",\"mobile\":\"9876543210\",\"billing_address\":{\"address_line1\":\"123 Elm Street\",\"address_line2\":\"Apt 4B\",\"city\":\"California city\",\"state\":\"California\",\"postal_code\":\"90001\",\"country\":\"us\"},\"driver_license_number\":\"ABC123456\",\"language\":\"English\",\"communication_type\":\"phone\",\"referred_by\":\"Google Ads\",\"term_service\":true,\"informed_consent\":true,\"height\":\"175\",\"weight\":\"70\",\"shipping_address\":{\"address_line1\":\"500 Market Street\",\"address_line2\":\"Suite 8\",\"city\":\"San Francisco\",\"state\":\"CA\",\"country\":\"us\",\"postal_code\":\"94105\"}}" }, "description": "Update an existing patient.\n\nThis endpoint updates the details of an existing patient using validated input.\nUpon success, it returns the updated patient resource wrapped in a standardized JSON structure, along with the original input and pagination metadata." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"gender\": \"female\",\n \"first_name\": \"Alice\",\n \"email\": \"alice@example.com\",\n \"created_time\": \"2025-07-10 09:20:00\",\n \"mobile\": \"9876543210\",\n \"last_name\": \"Smith\",\n \"active\": \"active\",\n \"record_id\": \"PAT1023\",\n \"full_name\": \"Alice Smith\",\n \"patient_id\": 42,\n \"dob\": \"1990-05-01\",\n \"postal_code\": \"10001\",\n \"state\": \"NY\",\n \"city\": \"New York\",\n \"address_line1\": \"123 Elm Street\",\n \"height\": \"5\",\n \"weight\": \"60\",\n \"created_date\": \"2025-07-10 09:20:00\",\n },\n }\n ],\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"reason\": {\n \"email\": [\"The email field is required.\"],\n \"dob\": [\"The dob must be a valid date.\"]\n }\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"message\": \"Internal Server Error\"\n}", "name": "" } ] }, { "name": "Upload a document for a patient.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/patients\/:patientId\/documents", "query": [], "raw": "{{baseUrl}}\/api\/v2\/patients\/:patientId\/documents", "variable": [ { "id": "patientId", "key": "patientId", "value": "1", "description": "The ID or Record ID of the patient fetch from the patients endpoint." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"title\":\"Driving License\",\"document_file\":\"data:image\\\/jpeg;base64,\\\/9j\\\/4AAQSkZJRgABAQAAAQABAAD...\",\"document_file_back\":\"data:image\\\/png;base64,iVBORw0KGgoAAAANSUhEUgAA...\"}" }, "description": "Upload and store a patient's document (front + optional back). Accepts base64-encoded image or PDF data." }, "response": [ { "header": [], "code": 200, "body": "{\n \"documents\": [\n {\n \"document_id\": 5,\n \"patient_id\": 1,\n \"document_title\": \"Blood Report\",\n \"document_file\": \"https:\/\/s3.amazonaws.com\/bucket\/document.pdf\",\n \"document_thumb\": \"https:\/\/s3.amazonaws.com\/bucket\/thumbnail.jpg\",\n \"document_date\": \"2024-06-01 10:23:00\"\n }\n ]\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"title\": [\"The title field is required.\"],\n \"document_file\": [\"The document_file must be a valid base64-encoded file of type: jpg, jpeg, png, or pdf.\"]\n }\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"message\": \"Internal Server Error\",\n}", "name": "" } ] }, { "name": "Get patient questionnaires", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/patients\/:patientId\/questionnaires", "query": [ { "key": "per_page", "value": "10", "description": "Number of results per page.", "disabled": false }, { "key": "page", "value": "1", "description": "Page number.", "disabled": false }, { "key": "questionnaire_name_startswith", "value": "A", "description": "Filter by title starting with...", "disabled": false }, { "key": "questionnaire_name_contains", "value": "Diabetes", "description": "Filter by title containing...", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v2\/patients\/:patientId\/questionnaires?per_page=10&page=1&questionnaire_name_startswith=A&questionnaire_name_contains=Diabetes", "variable": [ { "id": "patientId", "key": "patientId", "value": "nulla", "description": "The ID of the patient fetch from the patients endpoint." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get a list of questionnaires answered by the patient" }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"ques_map_id\": 12,\n \"questionnaire_id\": 5,\n \"questionnaire_name\": \"Diabetes Checkup\",\n \"is_submitted\": true,\n \"is_saved\": true\n }\n ],\n \"pagination\": {\n \"page\": 1,\n \"per_page\": 10,\n \"has_more_page\": true,\n \"search_criteria\": {\n \"column_name\": \"questionnaire_name\",\n \"search_text\": \"Dia\",\n \"comparator\": \"contains\"\n }\n }\n}", "name": "" }, { "header": [], "code": 401, "body": "{\n \"message\": \"Unauthenticated.\"\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"message\": \"Internal Server Error\"\n}", "name": "" } ] }, { "name": "Get patient's questionnaire answers", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/patients\/patient-questionnaire-answer", "query": [ { "key": "record_id", "value": "abc123", "description": "The patient's record ID fetch from the patients endpoint.", "disabled": false }, { "key": "template_id", "value": "45", "description": "The ID of the questionnaire template fetch from the questionnaire list endpoint.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v2\/patients\/patient-questionnaire-answer?record_id=abc123&template_id=45" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This endpoint returns a list of answers submitted by a patient for a given template.\n\nRequires authentication and role-based access (e.g. company users)." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"id\": 12,\n \"template_id\": 45,\n \"answers\": [\n {\n \"question\": \"Do you have any allergies?\",\n \"answer\": \"Peanuts, Pollen\"\n },\n {\n \"question\": \"Medications\",\n \"answer\": \"Aspirin, Ibuprofen\"\n }\n ]\n }\n ]\n}", "name": "" }, { "header": [], "code": 401, "body": "{\n \"message\": \"Unauthenticated.\"\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"message\": \"Questionnaire not found.\"\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"message\": \"Internal Server Error.\"\n}", "name": "" } ] }, { "name": "Retrieve patient prescriptions", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/patients\/:patientId\/prescriptions", "query": [ { "key": "from_date", "value": "2025-03-01", "description": "date optional Filter prescriptions starting from this date. Format: `YYYY-MM-DD`. Defaults to today.", "disabled": false }, { "key": "to_date", "value": "2025-03-05", "description": "date optional Filter prescriptions up to this date. Format: `YYYY-MM-DD`. Defaults to today.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v2\/patients\/:patientId\/prescriptions?from_date=2025-03-01&to_date=2025-03-05", "variable": [ { "id": "patientId", "key": "patientId", "value": "123", "description": "The unique ID of the patient whose prescriptions are being retrieved fetch from the patients endpoint." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This endpoint fetches a list of prescriptions for a specific patient.\nYou can optionally provide a date range (`from_date` and `to_date`) to filter prescriptions.\nIf no date range is given, it defaults to today\u2019s prescriptions." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"drug\": \"Amoxicillin\",\n \"status\": \"transmit\",\n \"dispense\": 30,\n \"dispense_unit\": \"mg\",\n \"refills\": 2,\n \"drug_type\": \"Antibiotic\",\n \"directions\": \"Take one tablet every 8 hours\",\n \"note_to_pharmacy\": \"Urgent delivery required\",\n \"pharmacy_name\": \"ABC Pharmacy\",\n \"renewal_at\": \"01 Mar 2025\"\n }\n ]\n}", "name": "" }, { "header": [], "code": 400, "body": "{\n \"message\": \"Bad Request\"\n}", "name": "" }, { "header": [], "code": 401, "body": "{\n \"message\": \"Unauthenticated\"\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"message\": \"Patient not found\"\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"message\": \"Internal Server Error\"\n}", "name": "" } ] }, { "name": "Verify Patient from Idology", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/patients\/:patientId\/verify-from-idology", "query": [], "raw": "{{baseUrl}}\/api\/v2\/patients\/:patientId\/verify-from-idology", "variable": [ { "id": "patientId", "key": "patientId", "value": "123", "description": "The unique ID of the patient to verify fetch from the patients endpoint." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This endpoint verifies patient details using Idology based on the provided patient ID." }, "response": [ { "header": [], "code": 200, "body": "{\n \"response\": [\n \"Verification successful\",\n \"Additional verification info if any\"\n ]\n}", "name": "" }, { "header": [], "code": 400, "body": "{\n \"message\": \"Bad Request - Invalid patient ID\"\n}", "name": "" }, { "header": [], "code": 401, "body": "{\n \"message\": \"Unauthenticated - Token missing or invalid\"\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"message\": \"Patient not found\"\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"message\": \"Internal Server Error\"\n}", "name": "" } ] }, { "name": "Patient document detail", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/patients\/:patientId\/documents\/:documentId", "query": [], "raw": "{{baseUrl}}\/api\/v2\/patients\/:patientId\/documents\/:documentId", "variable": [ { "id": "patientId", "key": "patientId", "value": "officia", "description": "The ID of the patient fetch from the patients endpoint." }, { "id": "documentId", "key": "documentId", "value": "atque", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get a list of document data by the patient id and document id" }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"id\": 1642,\n \"patient_id\": 11,\n \"title\": \"dummy\",\n \"document_file\": \"https:\/\/example.com\",\n \"status\": 0,\n \"verified\": null,\n \"document_expiry_date\": null,\n \"s3_upload\": 1,\n \"created_at\":2023-09-15 11:59:43,\n \"mode_of_upload\": null,\n \"who_upload_document\": null,\n \"rotate_deg\": null,\n \"document_file_back\": null,\n \"is_edit\": 1,\n \"file_name\": \"Image1633342069.jpeg\"\n }\n ],\n}", "name": "" }, { "header": [], "code": 401, "body": "{\n \"message\": \"Unauthenticated.\"\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"message\": \"Internal Server Error\"\n}", "name": "" } ] }, { "name": "Get patient documents", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/patients\/:patientId\/documents", "query": [ { "key": "per_page", "value": "10", "description": "Number of results per page.", "disabled": false }, { "key": "page", "value": "1", "description": "Page number.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v2\/patients\/:patientId\/documents?per_page=10&page=1", "variable": [ { "id": "patientId", "key": "patientId", "value": "1", "description": "The ID of the patient fetch from the patients endpoint." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get a list of patient documents by the patient" }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"id\": 1642,\n \"patient_id\": 5,\n \"title\": \"dummy\",\n \"document_file\": \"https:\/\/example.com\",\n \"status\": 0,\n \"verified\": null,\n \"document_expiry_date\": null,\n \"s3_upload\": 1,\n \"created_at\": \"2023-09-15 11:59:43\",\n \"mode_of_upload\": null,\n \"who_upload_document\": null,\n \"rotate_deg\": null,\n \"document_file_back\": null,\n \"is_edit\": 1,\n \"file_name\": \"Image1633342069.jpeg\"\n }\n ],\n \"pagination\": {\n \"page\": 1,\n \"per_page\": 10,\n \"has_more_page\": true,\n }\n}", "name": "" }, { "header": [], "code": 401, "body": "{\n \"message\": \"Unauthenticated.\"\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"message\": \"Internal Server Error\"\n}", "name": "" } ] }, { "name": "Get Patient Details", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/patients\/:patientId", "query": [], "raw": "{{baseUrl}}\/api\/v2\/patients\/:patientId", "variable": [ { "id": "patientId", "key": "patientId", "value": "123", "description": "The unique ID of the patient." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This endpoint retrieves the details of a specific patient using the provided patient ID." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"id\": 42,\n \"gender\": \"female\",\n \"first_name\": \"Alice\",\n \"email\": \"alice@example.com\",\n \"created_time\": \"2025-07-09 10:32:00\",\n \"mobile\": \"9876543210\",\n \"last_name\": \"Smith\",\n \"full_name\": \"Alice Smith\",\n \"dob\": \"1990-05-01\",\n \"record_id\": \"PAT1023\",\n \"patient_id\": 42,\n \"created_time\": \"2025-07-09 10:32:00\",\n \"created_date\": \"2025-07-09 10:32:00\",\n \"active\": \"active\",\n \"postal_code\": \"10001\",\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"height\": \"5\",\n \"weight\": \"60\",\n \"privacy_policy\": \"Policy content...<\/html>\",\n \"client_logo\": \"https:\/\/example.com\/storage\/logo.png\",\n \"primary_color\": \"#1E90FF\",\n \"font_color\": \"#333333\",\n \"term_service\": 1,\n \"status\": \"active\",\n \"is_verified\": true,\n \"driver_license_number\": \"ABC123456\",\n \"language\": \"English\",\n \"communication_type\": \"phone\",\n \"referred_by\": \"Facebook\",\n \"informed_consent\": true,\n \"shipping_address_line1\": \"3555 Front St\",\n \"shipping_address_line2\": \"3555 Front St\",\n \"shipping_city\": \"San Diego\",\n \"shipping_state\": \"California\",\n \"shipping_country\": \"us\",\n \"shipping_postal_code\": null\n }\n ]\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"message\": \"Patient not found\"\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"message\": \"Patient id field is required\"\n}", "name": "" }, { "header": [], "code": 401, "body": "{\n \"message\": \"Unauthenticated - Token missing or invalid\"\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"message\": \"Internal Server Error\"\n}", "name": "" } ] }, { "name": "Get Privacy Policy \/ Terms of Use", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/patients\/privacy-policy\/:clientId", "query": [], "raw": "{{baseUrl}}\/api\/v2\/patients\/privacy-policy\/:clientId", "variable": [ { "id": "clientId", "key": "clientId", "value": "5", "description": "Optional client ID to fetch consent\/terms for a specific client." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns the privacy policy or consent\/terms content for a client.\n\nIf `clientId` is provided, the API returns the consent content\nassociated with that client. Otherwise, it attempts to resolve\nthe client using the current subdomain.\n\nIf no client-specific consent exists, the default privacy policy is returned." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": \"Your privacy policy or terms of use content here...\"\n}", "name": "" }, { "header": [], "code": 401, "body": "{\n \"message\": \"Unauthenticated - Token missing or invalid\"\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"message\": \"Terms of use not found for the given client\"\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"message\": \"Internal Server Error\"\n}", "name": "" } ] }, { "name": "Get Informed Consent", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/patients\/informed-consent", "query": [], "raw": "{{baseUrl}}\/api\/v2\/patients\/informed-consent" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns the informed consent content for compounded or non-FDA-approved\npeptide treatment from the config file." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": \"Informed Consent for Compounded or Non-FDA-Approved Peptide Treatment...\"\n}", "name": "" }, { "header": [], "code": 401, "body": "{\n \"message\": \"Unauthenticated - Token missing or invalid\"\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"message\": \"Internal Server Error\"\n}", "name": "" } ] } ] }, { "name": "Payments", "description": "", "item": [ { "name": "Create Braintree Customer", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/patients\/payments\/braintree\/customer", "query": [], "raw": "{{baseUrl}}\/api\/v2\/patients\/payments\/braintree\/customer" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"patient_id\":1,\"nonce\":\"fake-valid-nonce\"}" }, "description": "This endpoint creates a Braintree customer for the given patient.\nIf the customer already exists, it returns the existing Braintree customer ID and nonce.\nOtherwise, it creates a new Braintree customer using the provided payment method nonce and stores the credentials." }, "response": [ { "header": [], "code": 200, "body": "{\n \"braintree_customer_id\": \"abcdef123456\",\n \"braintree_nonce\": \"a1b2c3d4e5f6\"\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"patient_id\": [\n \"Patient ID is required.\"\n ],\n \"nonce\": [\n \"Payment nonce is required.\"\n ]\n }\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"message\": \"Internal Server Error.\"\n}", "name": "" } ] }, { "name": "Get Braintree Client Token", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/patients\/payments\/braintree\/token", "query": [], "raw": "{{baseUrl}}\/api\/v2\/patients\/payments\/braintree\/token" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"source_id\":21,\"client_id\":5}" }, "description": "This endpoint generates a Braintree client token using default or dynamic gateway credentials.\nIf `source_id` or `client_id` is passed, the token is generated using their specific Braintree settings." }, "response": [ { "header": [], "code": 200, "body": "{\n \"token\": \"sandbox_f252zhq7_hh4cpc39zq4rgjcg\",\n \"gateway_id\": \"client_braintree_id_001\",\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"message\": \"Client not found\"\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"message\": \"Internal Server Error.\"\n}", "name": "" } ] }, { "name": "Initiate Braintree Payment", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/patients\/payments\/braintree\/initiate", "query": [], "raw": "{{baseUrl}}\/api\/v2\/patients\/payments\/braintree\/initiate" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"patient_id\":1,\"nonce\":\"fake-valid-nonce\",\"amount\":\"250\",\"order_id\":\"ORDER123\",\"source_id\":3,\"gateway_id\":\"cli_gw_001\",\"qb_channel\":\"online\",\"aptType\":\"async\"}" }, "description": "This endpoint initiates a Braintree payment for a patient using a nonce and amount.\nOptionally stores card info and generates a QuickBooks invoice if applicable." }, "response": [ { "header": [], "code": 200, "body": "{\n \"transaction_id\": \"bt_txn_123456\",\n \"gateway_id\": \"braintree_abc\"\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"errors\": {\n \"patient_id\": [\n \"The patient id field is required.\"\n ],\n \"nonce\": [\n \"The nonce field is required.\"\n ],\n \"amount\": [\n \"The amount field is required.\"\n ]\n }\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"message\": \"Internal Server Error.\"\n}", "name": "" } ] }, { "name": "Store Card Details on Braintree", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/patients\/payments\/braintree\/card", "query": [], "raw": "{{baseUrl}}\/api\/v2\/patients\/payments\/braintree\/card" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"patient_id\":1,\"nonce\":\"fake-valid-nonce\",\"source_id\":2}" }, "description": "Saves a card for the patient to Braintree and stores the customer ID and token." }, "response": [ { "header": [], "code": 200, "body": "{\n \"braintree_nonce\": \"abc123xyz\",\n \"braintree_customer_id\": \"cust_456def\",\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"message\": \"Patient not found\"\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"message\": \"The nonce field is required.\"\n}", "name": "" } ] }, { "name": "Store PayPal Payment Details", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/patients\/payments\/paypal\/store", "query": [], "raw": "{{baseUrl}}\/api\/v2\/patients\/payments\/paypal\/store" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"patient_id\":1,\"agent_id\":12,\"transection_id\":\"PAYPAL_TXN_123\",\"payment_mode\":\"paypal\",\"amount\":\"250.50\",\"billing_address\":\"\\\"123 Main St, NY\\\"\",\"payment_status\":\"success\",\"channel\":\"lab_test\"}" }, "description": "Stores payment details for a PayPal transaction. Optionally triggers a PayPal charged event." }, "response": [ { "header": [], "code": 200, "body": "{\n \"message\": \"Your payment detail has been stored!\"\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"message\": \"Something went wrong.\"\n}", "name": "" } ] }, { "name": "Get Patient Transactions", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/patients\/:patientId\/transactions", "query": [ { "key": "from_date", "value": "2026-05-01", "description": "date optional Filter payments from this date (based on updated_at). Format: YYYY-MM-DD.", "disabled": false }, { "key": "to_date", "value": "2026-05-31", "description": "date optional Filter payments up to this date (based on updated_at). Format: YYYY-MM-DD.", "disabled": false }, { "key": "status", "value": "success", "description": "optional Filter payments by status.", "disabled": false }, { "key": "page", "value": "1", "description": "Current page number for pagination.", "disabled": false }, { "key": "per_page", "value": "15", "description": "Number of records per page.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v2\/patients\/:patientId\/transactions?from_date=2026-05-01&to_date=2026-05-31&status=success&page=1&per_page=15", "variable": [ { "id": "patientId", "key": "patientId", "value": "1", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns the complete payment history for a specified patient.\nSupports optional filters for date range and payment status." }, "response": [ { "header": [], "code": 200, "body": "{\n \"current_page\": 1,\n \"data\": [\n {\n \"transaction_id\": \"TXN123456\",\n \"patient_id\": \"PAT1023\",\n \"name\": \"John Doe\",\n \"product\": \"encounter\",\n \"amount\": \"150.00\",\n \"status\": \"success\",\n \"reason\": \"test\",\n \"updated_at\": \"2026-05-10 12:45:00\"\n \"date_of_the_refund\": \"2026-05-10 12:45:00\",\n }\n ],\n \"from\": 1,\n \"last_page\": 1,\n \"per_page\": 10,\n \"has_more_page\": 1,\n \"total\": \"false\"\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"message\": \"Patient not found with this ID\",\n \"status\": \"error\"\n}", "name": "" }, { "header": [], "code": 401, "body": "{\n \"message\": \"Unauthenticated - Token missing or invalid\"\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"message\": \"Validation failed\"\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"message\": \"Internal Server Error\"\n}", "name": "" } ] }, { "name": "Get Client Payments Details", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/transactions", "query": [ { "key": "clientId", "value": "123", "description": "The ID of the client.", "disabled": false }, { "key": "from_date", "value": "2026-05-01", "description": "date optional Filter payments from this date (based on updated_at). Format: YYYY-MM-DD.", "disabled": false }, { "key": "to_date", "value": "2026-05-31", "description": "date optional Filter payments up to this date (based on updated_at). Format: YYYY-MM-DD.", "disabled": false }, { "key": "status", "value": "success", "description": "optional Filter payments by status.", "disabled": false }, { "key": "search", "value": "John", "description": "optional Filter payments by patient transaction_id or patient name.", "disabled": false }, { "key": "page", "value": "1", "description": "Current page number for pagination.", "disabled": false }, { "key": "per_page", "value": "15", "description": "Number of records per page.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v2\/transactions?clientId=123&from_date=2026-05-01&to_date=2026-05-31&status=success&search=John&page=1&per_page=15" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This endpoint retrieves all payment records associated with a specific client (via their active sources).\nIt supports filtering by date range, payment status, and search keyword." }, "response": [ { "header": [], "code": 200, "body": "{\n \"current_page\": 1,\n \"data\": [\n {\n \"transaction_id\": \"txn_3Nxxxxxxxxxxx\",\n \"patient_id\": 412,\n \"name\": \"Jane Doe\",\n \"product\": \"Consultation\",\n \"amount\": 100.00,\n \"status\": \"success\",\n \"reason\": null,\n \"updated\": \"2026-05-18 12:00:00\",\n \"date_of_the_refund\": null\n }\n ],\n \"last_page\": 1,\n \"per_page\": 15,\n \"total\": 1,\n \"has_more_page\": false\n}", "name": "" }, { "header": [], "code": 401, "body": "{\n \"message\": \"Unauthenticated.\"\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"message\": \"Client not found\"\n}", "name": "" } ] } ] }, { "name": "Pharmacy", "description": "", "item": [ { "name": "Get Pharmacies", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/pharmacy\/list", "query": [ { "key": "pharmacy_name", "value": "%22Doespot%22", "description": "The name (or partial name) of the pharmacy to search for.", "disabled": false }, { "key": "state", "value": "%22CA%22", "description": "The state to filter pharmacies by.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v2\/pharmacy\/list?pharmacy_name=%22Doespot%22&state=%22CA%22" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This endpoint retrieves a list of pharmacies filtered by pharmacy name and state.\nIt returns detailed information about each pharmacy, including contact details, address, and configuration options." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"id\": 1,\n \"pharmacy_name\": \"Doespot Pharmacy\",\n \"phone_number\": \"123-456-7890\",\n \"email\": \"info@doespot.com\",\n \"primary_option\": \"Option A\",\n \"api_name\": \"default\",\n \"status\": 1,\n \"type\": \"default\",\n \"ndc\": 123456,\n \"daw_code\": 0,\n \"attach_questionnaire\": 0,\n \"created_at\": \"2025-09-15T06:51:23Z\",\n \"updated_at\": \"2025-09-15T06:51:23Z\",\n \"faxable_name\": \"Doespot Fax\",\n \"states\": \"CA\",\n \"is_doctalkgo_pharmacy\": 0,\n \"contact_number\": \"123-456-7890\",\n \"soft_delete\": 0,\n \"npi_number\": \"1234567890\",\n \"ppi_name\": \"Primary PPI\",\n \"address_line1\": \"123 Main St\",\n \"address_line2\": \"\",\n \"city\": \"Los Angeles\",\n \"state\": \"CA\",\n \"country\": \"USA\",\n \"postal_code\": \"90001\",\n \"ncpdp\": \"987654\",\n \"dosespot_pharmacy_id\": \"DS12345\",\n \"webhook\": \"https:\/\/example.com\/webhook\",\n \"tenant_id\": \"392ab90f-3094-407d-8510-529008ce3fd4\",\n \"api_configuration\": \"default\",\n \"show_contact\": 1\n }\n ]\n}", "name": "" }, { "header": [], "code": 401, "body": "{\n \"message\": \"Unauthenticated - Token missing or invalid\"\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"message\": \"No pharmacies found matching the criteria\"\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"pharmacy_name\": [\n \"The pharmacy name field is required.\"\n ],\n \"state\": [\n \"The state field is required.\"\n ]\n }\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"message\": \"Internal Server Error\"\n}", "name": "" } ] }, { "name": "Search Pharmacies on Dosespot", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/pharmacy\/search-on-dosespot", "query": [ { "key": "name", "value": "%22Dosespot%22", "description": "required. The name (or partial name) of the pharmacy to search for. Must be at least 3 characters long.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v2\/pharmacy\/search-on-dosespot?name=%22Dosespot%22" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This endpoint allows searching for pharmacies by name. If no name is provided, it may return all pharmacies or a default list." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"Dosespot Pharmacy\",\n \"address\": \"123 Main Street\",\n \"city\": \"Los Angeles\",\n \"state\": \"CA\",\n \"zip_code\": \"90001\"\n }\n ]\n}", "name": "" }, { "header": [], "code": 401, "body": "{\n \"message\": \"Unauthenticated\"\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"message\": \"No pharmacies found\"\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"message\": \"Invalid query parameters\"\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"message\": \"Internal Server Error\"\n}", "name": "" } ] } ] }, { "name": "Providers", "description": "", "item": [ { "name": "Sign Up a Provider", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/provider\/signup", "query": [], "raw": "{{baseUrl}}\/api\/v2\/provider\/signup" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart\/form-data" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "formdata", "formdata": [ { "key": "first_name", "value": "John", "type": "text", "description": "First name of the provider." }, { "key": "last_name", "value": "Doe", "type": "text", "description": "Last name of the provider." }, { "key": "date_of_birth", "value": "1985-05-15", "type": "text", "description": "Provider's date of birth." }, { "key": "city", "value": "New York", "type": "text", "description": "City." }, { "key": "zip_code", "value": "10001", "type": "text", "description": "ZIP code." }, { "key": "state", "value": "NY", "type": "text", "description": "State." }, { "key": "country", "value": "USA", "type": "text", "description": "Country." }, { "key": "email", "value": "john.doe@example.com", "type": "text", "description": "Email address." }, { "key": "password", "value": "Password@123", "type": "text", "description": "Password." }, { "key": "password_confirmation", "value": "Password@123", "type": "text", "description": "Confirm password." }, { "key": "phone_number", "value": "1234567890", "type": "text", "description": "Contact number." }, { "key": "address", "value": "123 Main St, New York, NY", "type": "text", "description": "Full address." }, { "key": "gender", "value": "Male", "type": "text", "description": "Must be one of: Male, Female." }, { "key": "license_type", "value": "MD", "type": "text", "description": "Must be one of: MD, DO, PA, NP, RN." }, { "key": "birth_place", "value": "Los Angeles", "type": "text", "description": "Place of birth." }, { "key": "social_security_number", "value": "123-45-6789", "type": "text", "description": "SSN." }, { "key": "practice_experience", "value": "10", "type": "text", "description": "Years or details of experience." }, { "key": "board_certified", "value": "Yes", "type": "text", "description": "Board certification status." }, { "key": "certifying_board", "value": "American Board of Internal Medicine", "type": "text", "description": "Name of the certifying board." }, { "key": "npi_number", "value": "1234567890", "type": "text", "description": "string NPI number." }, { "key": "taxonomy", "value": "207R00000X", "type": "text", "description": "Taxonomy code." }, { "key": "caqh_number", "value": "12345678", "type": "text", "description": "CAQH ID." }, { "key": "medicare_patn", "value": "PTN123456", "type": "text", "description": "Medicare Provider Transaction Number." }, { "key": "medicaid_number", "value": "MC123456", "type": "text", "description": "Medicaid Number." }, { "key": "malpractice_history", "value": "None", "type": "text", "description": "Malpractice details." }, { "key": "hours_availabilty", "value": "8", "type": "text", "description": "Available working hours." }, { "key": "specialist[0]", "value": "Urology", "type": "text", "description": "" }, { "key": "specialist[1]", "value": "Dermatology", "type": "text", "description": "" }, { "key": "sub_specialist[0]", "value": "Allergy and immunology", "type": "text", "description": "" }, { "key": "active_dea_substance_certificate[0]", "value": "California", "type": "text", "description": "" }, { "key": "active_state_medical_licenses[0]", "value": "Alaska", "type": "text", "description": "" }, { "key": "active_state_medical_licenses[1]", "value": "Colorado", "type": "text", "description": "" }, { "key": "available_days[0]", "value": 1, "type": "text", "description": "" }, { "key": "available_days[1]", "value": 3, "type": "text", "description": "" }, { "key": "available_days[2]", "value": 5, "type": "text", "description": "" }, { "key": "current_cv", "src": [], "type": "file" }, { "key": "medical_degree[][]", "src": [], "type": "file" }, { "key": "training_certificate[][]", "src": [], "type": "file" }, { "key": "board_certificate[][]", "src": [], "type": "file" }, { "key": "driver_license[][]", "src": [], "type": "file" }, { "key": "medical_license[][]", "src": [], "type": "file" }, { "key": "substance_certificate[][]", "src": [], "type": "file" }, { "key": "certificate_insurance[][]", "src": [], "type": "file" } ] }, "description": "Register a new healthcare provider with all required details and documents." }, "response": [ { "header": [], "code": 200, "body": "{\n \"message\": \"Free\"\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"email\": [\"The email has already been taken.\"]\n }\n}", "name": "" }, { "header": [], "code": 401, "body": "{\n \"message\": \"Unauthenticated.\"\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"message\": \"Resource not found\"\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"message\": \"Internal server error\"\n}", "name": "" } ] }, { "name": "Check slot availability for a provider.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/provider\/slot\/status", "query": [ { "key": "doctor_id", "value": "15", "description": "The ID of the provider (doctor).", "disabled": false }, { "key": "start_date", "value": "2025-09-25", "description": "date The date of the appointment in YYYY-MM-DD format. Must be today or a future date.", "disabled": false }, { "key": "start_time", "value": "09%3A00%3A00", "description": "The start time in HH:MM:SS format.", "disabled": false }, { "key": "end_time", "value": "09%3A30%3A00", "description": "The end time in HH:MM:SS format.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v2\/provider\/slot\/status?doctor_id=15&start_date=2025-09-25&start_time=09%3A00%3A00&end_time=09%3A30%3A00" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This endpoint checks whether a given time slot for a provider (doctor) is available for booking.\nIt validates the input, verifies the provider exists and has the correct role, then checks for any overlapping appointments." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": \"[]\"\n}", "name": "" }, { "header": [], "code": 401, "body": "{\n \"message\": \"Unauthenticated.\"\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"message\": \"Provider not found\"\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"message\": \"Internal server error\"\n}", "name": "" } ] } ] }, { "name": "Questionnaires", "description": "", "item": [ { "name": "Get a paginated list of questionnaires\/templates", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/questionnaires", "query": [ { "key": "sort_column", "value": "created_time", "description": "Optional. The column to sort by. Possible values: `template_id`, `questionnaire_name`, `created_time` default created_time.", "disabled": false }, { "key": "sort_order", "value": "D", "description": "Optional. The sort direction. Either `A` for ascending or `D` for descending default D.", "disabled": false }, { "key": "per_page", "value": "10", "description": "Optional. The number of results per page.", "disabled": false }, { "key": "page", "value": "1", "description": "Optional. The page number to retrieve.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v2\/questionnaires?sort_column=created_time&sort_order=D&per_page=10&page=1" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This endpoint retrieves a list of questionnaires or templates for the current authenticated user. The list supports pagination, sorting, and filters based on the user's role and tenant." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"template_id\": 1,\n \"questionnaire_name\": \"Health Survey\",\n \"questionnaire_type\": \"General Questionnaire\",\n \"created_time\": 1694334025,\n \"source_id\": \"3,5\"\n },\n ],\n\n \"pagination\": {\n \"page\": 1,\n \"per_page\": 10,\n \"has_more_page\": \"true\",\n \"sort_column\": \"created_time\",\n \"sort_order\": \"D\"\n }\n}", "name": "" }, { "header": [], "code": 401, "body": "{\n \"message\": \"Unauthenticated.\"\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"message\": \"Internal Server Error.\"\n}", "name": "" } ] }, { "name": "Submit Questionnaire", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/questionnaires\/answers", "query": [], "raw": "{{baseUrl}}\/api\/v2\/questionnaires\/answers" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"template_id\":5643,\"patient_id\":5,\"answers\":\"eum\",\"ques_map_id\":5,\"coupon_code\":\"\\\"FREEMED2025\\\"\",\"ip_address\":\"\\\"192.168.1.1\\\"\",\"questionnaire_id\":12,\"service_ids\":\"1,2,3\"}" }, "description": "This endpoint allows you to submit answers to a specific questionnaire template for a given patient.\nIt supports updates and creations of new responses, logs responses from email links,\nand stores associated metadata such as coupon codes, appointment types, medications, and allergies." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"ques_map_id\": 123\n }\n}", "name": "" }, { "header": [], "code": 401, "body": "{\n \"message\": \"Unauthenticated.\"\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"message\": \"failed\",\n \"reason\": {\n \"template_id\": [\"The template id is required.\"],\n \"patient_id\": [\"The patient Id is required.\"],\n \"answers\": [\"Answers are required.\"]\n }\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"message\": \"Something went wrong.\"\n}", "name": "" } ] }, { "name": "Questionnaire", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/questionnaires\/:templateId", "query": [ { "key": "group_questionnaire", "value": "", "description": "Whether to return grouped questionnaire format.", "disabled": true }, { "key": "service_ids", "value": "1%2C2%2C3", "description": "Optional Service IDs fetch from the get client services endpoint.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v2\/questionnaires\/:templateId?group_questionnaire=&service_ids=1%2C2%2C3", "variable": [ { "id": "templateId", "key": "templateId", "value": "5643", "description": "The id of the template fetch from the questionnaire list endpoint (e.g., 5643)." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This endpoint returns the Questionnaires JSON for the given template ID and type. It can optionally retrieve a specific version of the template's questionnaires.\n\nRequires authentication. Behavior changes based on user role (`company` role limits results to source-matched templates)." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"notes\": \"test\",\n \"inline\": false,\n \"value\": [\n \"Yes\",\n \"No\"\n ],\n \"type\": \"radio-group\",\n \"conditions\": \"\",\n \"group_questionnaire\": \"\",\n \"isConditional\": \"\",\n \"title\": \"\",\n \"subTitle\": \"\",\n \"flow\": \"\",\n \"notes_type\": \"Question with Options\",\n \"is_multi_choice\": \"\",\n \"options\": [],\n \"is_deleted\": \"\",\n \"template_id\": \"4\",\n \"is_mandatory\": \"\",\n \"position\": 3,\n \"entry_id\": \"\",\n \"className\": \"\",\n \"description\": \"\",\n \"placeholder\": \"\",\n \"dqReason\": \"\",\n \"dqVal\": \"Yes\",\n \"upload_file_type\": \"\",\n \"allow_multiple_files\": \"\"\n }\n ]\n}", "name": "" }, { "header": [], "code": 401, "body": "{\n \"message\": \"Unauthenticated.\"\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"message\": \"Internal Server Error.\",\n}", "name": "" } ] }, { "name": "Client Questionnaire Report Webhook", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/questionnaires\/client-report-webhook", "query": [ { "key": "client_id", "value": "1", "description": "The ID of the client.", "disabled": false }, { "key": "source_id", "value": "5", "description": "Optional. The ID of the source.", "disabled": false }, { "key": "from_date", "value": "2023-01-01", "description": "date Optional. The start date in YYYY-MM-DD format. Defaults to today if not provided.", "disabled": false }, { "key": "to_date", "value": "2023-12-31", "description": "date Optional. The end date in YYYY-MM-DD format. Defaults to today if not provided.", "disabled": false }, { "key": "is_test_data_required", "value": "1", "description": "Optional. Whether to include test data. Use \"true\" or \"false\". Defaults to false.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v2\/questionnaires\/client-report-webhook?client_id=1&source_id=5&from_date=2023-01-01&to_date=2023-12-31&is_test_data_required=1" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Fetches questionnaire answers filtered by client, source, and date range.\nReturns a structured list of patient-submitted questions and answers, along with metadata such as age range, gender, zip code, and UTM tracking data." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"template_id\": 23,\n \"questionnaire\": [\n {\n \"question\": \"Do you have allergies?\",\n \"answer\": \"Pollen, Dust\"\n }\n ],\n \"created_at\": \"2024-01-01T12:00:00Z\",\n \"updated_at\": \"2024-01-01T12:00:00Z\",\n \"patient\": null,\n \"patient_age_range\": \"21 to 30\",\n \"patient_gender\": \"male\",\n \"patient_zip_code\": \"123\",\n \"visitor\": {\n \"utm_params\": {\n \"utm_source\": \"Google\",\n \"utm_medium\": \"cpc\",\n \"utm_content\": \"spring_campaign\"\n }\n },\n \"version\": \"1.0\"\n }\n ]\n}", "name": "" }, { "header": [], "code": 401, "body": "{\n \"message\": \"Unauthenticated.\"\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"message\": \"Something went wrong.\"\n}", "name": "" } ] } ] }, { "name": "Services", "description": "", "item": [ { "name": "Get Services", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/services", "query": [ { "key": "client_id", "value": "123", "description": "The ID of the client.", "disabled": false }, { "key": "id", "value": "12", "description": "Optional. Filter by specific service ID.", "disabled": false }, { "key": "search", "value": "dental", "description": "Optional. Search services by keyword (service title).", "disabled": false }, { "key": "type", "value": "consultation", "description": "Optional. Filter by service type title.", "disabled": false }, { "key": "category", "value": "diagnostics", "description": "Optional. Filter by category name.", "disabled": false }, { "key": "action", "value": "categorywise", "description": "Optional. Use `categorywise` for category-specific listing. Defaults to `default`.", "disabled": false }, { "key": "page", "value": "1", "description": "Optional. Page number to return. Defaults to 1.", "disabled": false }, { "key": "per_page", "value": "10", "description": "Optional. Number of items per page. Defaults to 10.", "disabled": false }, { "key": "sort_column", "value": "title", "description": "Optional. Column to sort by title, created_at, status. Defaults to created_at.", "disabled": false }, { "key": "sort_order", "value": "A", "description": "Optional. Sort direction. Only \"A\" (ascending) is supported.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v2\/services?client_id=123&id=12&search=dental&type=consultation&category=diagnostics&action=categorywise&page=1&per_page=10&sort_column=title&sort_order=A" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Retrieve a paginated list of services, optionally filtered and sorted by various parameters." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"Category Name\",\n \"services\": [\n {\n \"id\": 101,\n \"title\": \"Service Title\",\n \"description\": \"Service description\",\n \"amount\": \"100.00\",\n \"after_approval_amount\": \"80.00\",\n \"background_color\": \"#FFFFFF\",\n \"booking_with\": \"online\",\n \"created_date\": \"2025-08-11T10:00:00Z\",\n \"icon\": \"icon.png\",\n \"status\": 1,\n \"source_id\": 5,\n \"template_id\": 2,\n \"precautions\": \"No food before service\",\n \"diagnosis\": \"N\/A\",\n \"treatments\": \"Basic Cleaning\",\n \"starting_price\": \"150.00\"\n }\n ]\n }\n ],\n \"pagination\": {\n \"page\": 1,\n \"per_page\": \"10\",\n \"has_more_page\": true,\n \"sort_column\": \"created_date\",\n \"sort_order\": \"D\"\n }\n}", "name": "" }, { "header": [], "code": 401, "body": "{\n \"message\": \"Unauthenticated.\"\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"message\": \"Resource Not Found\"\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"message\": \"Internal Server Error\"\n}", "name": "" } ] }, { "name": "Get client services", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/clients\/:clientId\/services", "query": [], "raw": "{{baseUrl}}\/api\/v2\/clients\/:clientId\/services", "variable": [ { "id": "clientId", "key": "clientId", "value": "46", "description": "The id of the client (e.g., 46)." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Fetch a list of services available for a specific client, including details\nfrom related `appointment_sources` and optionally the related subscription plan.\n\nOnly services marked as visible on the website (`website = 1`) are returned.\nResults are ordered by the `services.order` field." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"id\": 156,\n \"title\": \"001Test\",\n \"description\": \"

Test<\/p>\",\n \"precautions\": \"

Test<\/p>\",\n \"diagnosis\": \"

Test<\/p>\",\n \"treatments\": \"

Test<\/p>\",\n \"amount\": \"0.00\",\n \"after_approval_amount\": \"0.00\",\n \"background_color\": \"A odit excepturi cor\",\n \"booking_with\": \"nutritionist\",\n \"created_at\": \"2024-02-22T17:37:54.000000Z\",\n \"status\": 0,\n \"source_id\": 61,\n \"template_id\": 24,\n \"subscription_id\": 112,\n \"sales_agent_role_name\": null,\n \"icon\": null,\n \"icon_full_url\": null,\n \"role_info\": null,\n \"subscription_plan\": {\n \"id\": 112,\n \"plan_id\": \"2ab\",\n \"plan_name\": \"04_06_2024_test_1\",\n \"description\": \"test\",\n \"clients\": \"1\",\n \"sources\": \"12\",\n \"price_per_cycle\": 1,\n \"price_calculated\": 1,\n \"frequency\": \"1\",\n \"max_cycles\": 1,\n \"has_prescription\": 1,\n \"rpm_subscription\": 0,\n \"initial\": 0,\n \"category_id\": \"1\",\n \"sub_category_id\": \"1\",\n \"discount_type\": null,\n \"discount\": null,\n \"deleted_at\": null,\n \"created_at\": \"2024-06-04T19:04:51.000000Z\",\n \"updated_at\": \"2024-06-04T19:04:51.000000Z\",\n \"deactivated\": null,\n \"excluded_states\": null,\n \"gateway_id\": null,\n \"qb_service\": null,\n \"qb_class\": null,\n \"qb_company_id\": null\n }\n }\n ]\n}", "name": "" }, { "header": [], "code": 401, "body": "{\n \"message\": \"Unauthenticated.\"\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"message\": \"Resource Not Found\"\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"message\": \"Internal Server Error\"\n}", "name": "" } ] }, { "name": "Get Service by Client and Category", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/services\/by-client-and-category", "query": [ { "key": "client_id", "value": "123", "description": "The ID of the client.", "disabled": false }, { "key": "category_id", "value": "5", "description": "The ID of the category type.", "disabled": false }, { "key": "service_for", "value": "both", "description": "optional The intended user type for the service.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v2\/services\/by-client-and-category?client_id=123&category_id=5&service_for=both" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This endpoint retrieves a list of active services for a given client and category.\nIf a service doesn\u2019t have a questionnaire template assigned, the system will attempt to fetch one\nbased on its source ID." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"id\": 1,\n \"client_id\": 123,\n \"template_id\": 1,\n \"type_id\": 1,\n \"title\": \"abc\",\n \"description\": \"abc\",\n \"source_id\": 1,\n \"status\": 1,\n \"booking_with\": \"doctor\",\n \"price\": 150.00,\n \"product_and_price\": \"[]\",\n \"add_on\": \"[]\",\n \"service_for\": \"both\",\n \"charge_consultation\": 1,\n \"labs\": [\n {\n \"lab_id\": 12,\n \"name\": \"abc\"\n }\n ],\n \"sales_agent_role_name\": \"abc\",\n \"icon_full_url\": \"abc\",\n \"role_info\": \"abc\"\n }\n ]\n}", "name": "" }, { "header": [], "code": 401, "body": "{\n \"message\": \"Unauthenticated.\"\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"message\": \"Internal Server Error\"\n}", "name": "" } ] }, { "name": "Get Service Product and Prices", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/services\/:serviceId\/product-and-prices", "query": [], "raw": "{{baseUrl}}\/api\/v2\/services\/:serviceId\/product-and-prices", "variable": [ { "id": "serviceId", "key": "serviceId", "value": "6", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This endpoint retrieves a service based on the provided service ID.\nIt returns details such as service info, add-ons, labs data, product pricing, and more." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"id\": 1,\n \"client_id\": 1,\n \"template_id\": null,\n \"type_id\": 2,\n \"title\": \"Sample Service\",\n \"description\": \"This is a sample service.\",\n \"source_id\": 1,\n \"status\": \"active\",\n \"booking_with\": \"online\",\n \"price\": 99.99,\n \"product_and_price\": \"[]\",\n \"add_on\": \"[]\",\n \"labs\": \"[]\",\n \"charge_consultation\": 10.00,\n \"sales_agent_role_name\": null,\n \"icon_full_url\": null,\n \"role_info\": null\n }\n}", "name": "" }, { "header": [], "code": 401, "body": "{\n \"message\": \"Unauthenticated.\"\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"message\": \"Internal Server Error\"\n}", "name": "" } ] }, { "name": "Services Listing for Sub Category", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/:clientId\/:subcategoryId\/services", "query": [ { "key": "service_for", "value": "both", "description": "optional The type of service.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v2\/:clientId\/:subcategoryId\/services?service_for=both", "variable": [ { "id": "clientId", "key": "clientId", "value": "123", "description": "The ID of the client." }, { "id": "subcategoryId", "key": "subcategoryId", "value": "123", "description": "The ID of the subcategory." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This endpoint retrieves a list of services based on the given client ID and subcategory ID.\nYou can optionally specify the `service_for` type (`regular`, `premium`, or `both`)." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"id\": 1,\n \"client_id\": 1,\n \"template_id\": 1,\n \"type_id\": 1,\n \"title\": \"abc\",\n \"sub_title\": \"abc\",\n \"description\": \"

abc<\/p>\",\n \"starting_price\": \"abc\",\n \"icon\": \"http:\/\/abc.jpeg\",\n \"background_color\": null,\n \"medication\": \"

abc<\/p>\",\n \"membership\": \"

abc<\/p>\",\n \"medication_detail\": \"

abc<\/p>\",\n \"status\": 1,\n \"source_id\": 1,\n \"booking_with\": \"abc\",\n \"sales_agent_role\": 16,\n \"created_at\": \"2023-11-29T03:50:32.000000Z\",\n \"updated_at\": \"2024-07-18T22:00:13.000000Z\",\n \"soft_delete\": \"0\",\n \"category_ids\": \"36\",\n \"tenant_id\": \"392ab90f\",\n \"excluded_states\": \"[]\",\n \"short_description\": \"abc\",\n \"price\": null,\n \"product_and_price\": \"[]\",\n \"precautions\": \"

abc<\/p>\",\n \"diagnosis\": \"

abc<\/p>\",\n \"treatments\": \"

abc<\/p>\",\n \"add_on\": null,\n \"website\": 1,\n \"is_multiple\": 0,\n \"is_prevail_membership\": 1,\n \"prevail_membership_fee\": 9.99,\n \"order\": null,\n \"labs\": \"[]\",\n \"service_for\": \"both\",\n \"is_appt_on_lab_order\": \"yes\",\n \"subscription_id\": null,\n \"renewal_template_id\": null,\n \"patient_portal_visible\": 0,\n \"renewal_source_id\": null,\n \"charge_consultation\": 0,\n \"s3_upload\": 0,\n \"allow_lead_signup\": 0,\n \"patient_dashboard_visible\": 0,\n \"is_shipping\": 0,\n \"shipping_label\": \"shipping\",\n \"shipping_price\": 0,\n \"health_benefits\": null,\n \"gender\": null,\n \"sales_agent_role_name\": \"abc\",\n \"icon_full_url\": \"http:\/\/abc.jpeg\",\n \"pivot\": {\n \"type_id\": 1,\n \"service_id\": 1\n },\n \"role_info\": {\n \"id\": 16,\n \"label\": \"abc\",\n \"name\": \"abc\",\n \"guard_name\": \"web\",\n \"created_at\": \"2021-11-02T19:18:45.000000Z\",\n \"updated_at\": \"2022-09-16T17:12:21.000000Z\",\n \"soft_delete\": 0,\n \"related_to\": 0,\n \"tenant_id\": \"392ab90f\",\n \"disable_role\": 0,\n \"client_id\": null\n }\n }\n ]\n}", "name": "" }, { "header": [], "code": 401, "body": "{\n \"message\": \"Unauthenticated.\"\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"message\": \"Internal Server Error\"\n}", "name": "" } ] }, { "name": "Get Service Details", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/services\/:serviceId", "query": [], "raw": "{{baseUrl}}\/api\/v2\/services\/:serviceId", "variable": [ { "id": "serviceId", "key": "serviceId", "value": "143", "description": "The id of the service fetch from the services endpoint (e.g., 143)." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Retrieves details of a specific service by its ID.\n\nThis endpoint returns a detailed view of the service, including information about the service's associated subscription plan, products, add-ons, lab tests, and lab charges." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"id\": 10,\n \"client_id\": 1,\n \"template_id\": 27,\n \"type_id\": 2,\n \"title\": \"Cholesterol\",\n \"sub_title\": null,\n \"description\": \"

test<\/p>\",\n \"starting_price\": null,\n \"icon\": \"http:\/\/abc.png\",\n \"background_color\": \"#000000ff\",\n \"medication\": \"

test<\/p>\",\n \"membership\": \"

test<\/p>\",\n \"status\": 0,\n \"source_id\": 21,\n \"booking_with\": \"provider\",\n \"sales_agent_role\": null,\n \"created_at\": \"2020-12-16T13:22:31.000000Z\",\n \"updated_at\": \"2024-07-18T20:14:43.000000Z\",\n \"soft_delete\": \"0\",\n \"link_with_ids\": \"1\",\n \"category_ids\": \"2\",\n \"tenant_id\": \"392ab90f\",\n \"excluded_states\": \"[]\",\n \"short_description\": \"abc\",\n \"price\": null,\n \"product_and_price\": \"[]\",\n \"precautions\": \"

abc<\/p>\",\n \"diagnosis\": \"

abc<\/p>\",\n \"treatments\": \"

abc<\/p>\",\n \"add_on\": null,\n \"website\": 0,\n \"is_multiple\": 0,\n \"is_prevail_membership\": 0,\n \"prevail_membership_fee\": null,\n \"order\": null,\n \"labs\": \"[]\",\n \"service_for\": \"both\",\n \"is_appt_on_lab_order\": \"no\",\n \"subscription_id\": null,\n \"renewal_template_id\": null,\n \"patient_portal_visible\": 0,\n \"renewal_source_id\": null,\n \"charge_consultation\": 0,\n \"s3_upload\": 0,\n \"allow_lead_signup\": 0,\n \"patient_dashboard_visible\": 0,\n \"is_shipping\": 0,\n \"shipping_label\": \"shipping\",\n \"shipping_price\": 0,\n \"health_benefits\": null,\n \"gender\": null,\n \"lab_service_charge\": 0,\n \"client_lab_charge\": 0,\n \"lab_test_data\": null,\n \"sales_agent_role_name\": null,\n \"icon_full_url\": \"http:\/\/abc.png\",\n \"subscription_plan\": null,\n \"role_info\": null\n }\n}", "name": "" }, { "header": [], "code": 401, "body": "{\n \"message\": \"Unauthenticated.\"\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"message\": \"Service not found.\"\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"message\": \"Internal Server Error\"\n}", "name": "" } ] } ] }, { "name": "Sources", "description": "", "item": [ { "name": "Get a single appointment source by ID.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/sources\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v2\/sources\/:id", "variable": [ { "id": "id", "key": "id", "value": "21", "description": "The ID of the appointment source fetch from the get client active sources." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This endpoint retrieves detailed information about a specific appointment source,\nincluding its pricing, duration, funnel URL, and any linked questionnaire template.\nIf the source is soft-deleted, it will still be included." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"id\": 5,\n \"title\": \"Initial Consultation\",\n \"amount\": 100.0,\n \"video_amount\": 120.0,\n \"async_amount\": 90.0,\n \"after_approval_amount\": 110.0,\n \"funnel_url\": \"https:\/\/example.com\/funnel\",\n \"duration\": 30,\n \"color\": \"#FF5733\",\n \"standing_order\": true,\n \"type\": \"consultation\",\n \"delay_days\": 2,\n \"payment_method\": \"credit_card\",\n \"gateway_id\": \"stripe\",\n \"excluded_states\": [\"NY\", \"CA\"],\n \"questionnaire_template_id\": 12\n }\n}", "name": "" }, { "header": [], "code": 401, "body": "{\n \"message\": \"Unauthenticated.\"\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"message\": \"Requested source not found\"\n}", "name": "" } ] }, { "name": "Get Client Active Sources", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/clients\/:clientId\/sources", "query": [], "raw": "{{baseUrl}}\/api\/v2\/clients\/:clientId\/sources", "variable": [ { "id": "clientId", "key": "clientId", "value": "123", "description": "The ID of the client." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns a list of active sources associated with a client,\nalong with the latest related questionnaire template." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"id\": 1,\n \"title\": \"Phentermine\",\n \"amount\": 1,\n \"after_approval_amount\": 0,\n \"video_amount\": \"0.00\",\n \"status\": 1,\n \"state_rule\": 0,\n \"created_at\": \"2020-09-25T18:32:15.000000Z\",\n \"updated_at\": \"2024-04-22T22:42:56.000000Z\",\n \"soft_delete\": 0,\n \"funnel_url\": \"\",\n \"duration\": \"1\",\n \"color\": \"\",\n \"type\": \"sync\",\n \"subtype\": \"both\",\n \"standing_order\": 0,\n \"delay_days\": 0,\n \"post_visit_summary\": 0,\n \"related_to\": 1,\n \"appointment_mode\": 0,\n \"doc_upload_option\": 1,\n \"payment_method\": \"\",\n \"super_bill\": 0,\n \"tenant_id\": \"392ab90f-3094-1529008ce3fd4\",\n \"sync_questionnare_id\": 0,\n \"async_questionnare_id\": 0,\n \"async_amount\": \"0.00\",\n \"rpm_amount\": 0,\n \"gateway_id\": null,\n \"deleted_at\": null,\n \"qb_company_id\": null,\n \"excluded_states\": \"[\\\"Alabama\"]\",\n \"qb_service\": null,\n \"qb_class\": null,\n \"async_qb_service\": null,\n \"reassessment_id\": null,\n \"reassessment_source_id\": null,\n \"is_controlled_substance\": 0,\n \"renewal_source_id\": null,\n \"questionnaire_id\": null\n }\n ]\n}", "name": "" }, { "header": [], "code": 401, "body": "{\n \"message\": \"Unauthenticated.\"\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"reason\": \"Client not found\"\n}", "name": "" } ] } ] }, { "name": "State rule", "description": "", "item": [ { "name": "State Rule Implementation", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/staterule", "query": [ { "key": "state_name", "value": "California", "description": "The state for which the care settings need to be fetched (e.g., \"California\").", "disabled": false }, { "key": "source_id", "value": "21", "description": "The unique identifier for the appointment source is fetch from get client active sources.", "disabled": false }, { "key": "patient_id", "value": "123", "description": "The unique identifier for the patient to dynamically determine recommended care mode.", "disabled": false }, { "key": "products", "value": "45%2C23", "description": "Product identifier to help determine care status.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v2\/staterule?state_name=California&source_id=21&patient_id=123&products=45%2C23" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Retrieve the care settings (establishing and continued care) based on the provided `state_name` and `source_id`.\nThe response varies depending on whether custom roles and rules exist for the given source and state." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"establishingCare\": \"audio\", \/\/ Possible values: \"audio\", \"video\", \"async\"\n \"continuedCare\": \"audio\" \/\/ Possible values: \"audio\", \"video\", \"async\"\n }\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"state_name\": [\n \"The state name field is required.\"\n ],\n \"source_id\": [\n \"The source id field is required.\"\n }\n}", "name": "" }, { "header": [], "code": 401, "body": "{\n \"message\": \"Unauthenticated.\"\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"message\": \"Resource Not Found\"\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"message\": \"Internal Server Error\"\n}", "name": "" } ] } ] } ], "auth": { "type": "bearer" } }