List Clinics¶

Retrieve a list of clinics within an organization.

Endpoint¶

GET /apis/v1/branch/organisation/{organisation_id}/get-all-clinics

Parameters¶

Path Parameters¶

Parameter	Type	Required	Description
`organisation_id`	integer	Yes	The unique identifier of the organization

Headers¶

Parameter	Type	Required	Description
`Authorization`	string	Yes	Bearer token for authentication

Request¶

curl --location '{base_url}/apis/branch/organisation/{organisation_id}/get-all-clinics' \
--header 'Authorization: Bearer YOUR_TOKEN'

Response¶

Success Response¶

Code: 200 OK

{
    "code": 2000,
    "data": {
        "total": 11,
        "pages": 1,
        "current": 1,
        "no_of_records": 11,
        "clinics": [
            {
                "clinic_id": 525,
                "name": "XYZ Sport Institute",
                "address": {
                    "line1": "7172",
                    "line2": "Edinger Ave",
                    "landmark": "",
                    "city": "Huntington Beach",
                    "state": "CA",
                    "postal_code": "92647",
                    "country": "USA",
                },
                "phone_number": "+17149029349",
                "email": "info@sportschange.com",
                "time_zone": "America/Los_Angeles",
                "photos": [],
                "about": null,
                "logo_url": "https://us-phy-uploads.s3.us-west-2.amazonaws.com/files/cb1931a3-c9ea-4e40-9fde-d392825b9619.png",
                "organisation_id": 362,
                "service_type": null,
                "timings": [
                    {
                        "schedule_id": 91564,
                        "day_of_weeks": [
                            "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", 
                       ],
                        "start_time": "08:30",
                        "end_time": "18:00",
                    },
                ],
                "clinic_instructions": null,
                "parking_instruction_url": null,
                "services": [
                    "ORTHOPEDICS",
                    "PEDIATRICS",
                    "Aquatic therapy and rehabilitation",
                    "Arthritis treatment",
                    "Back Pain",
                ],
                "review_url": null,
                "location_url": null,
                "equipments": [
                    "Stationary bikes",
                    "Electrical stimulation",                ],
                "specialities": [
                    "Orthopedic/ MSK rehabilitation",
                    "Sports"
                ],
                "year_founded": 2020,
                "primary_category": "Physical Therapy Clinic",
                "npi": "1164750000",
                "map_image": "https://us-phy-uploads.s3.us-west-2.amazonaws.com/files/4d0c8b4f-4641-4628-9d6c-2233388b9aec.jpeg",
                "send_attachments": false,
                "fax_number": "7143623147",
                "max_allowed_visit_per_slot": null,
                "parking_available": false,
                "verified": false
            }, // other clinics
        ]
    }
}

Response Schema¶

Data Object¶

Field	Type	Description
`total`	integer	Total number of clinics
`pages`	integer	Total number of pages
`current`	integer	Current page number
`no_of_records`	integer	Number of records in current response
`clinics`	array	Array of clinic objects

Clinic Object¶

Field	Type	Description
`clinic_id`	integer	Unique identifier for the clinic
`name`	string	Name of the clinic
`address`	object	Complete address information
`phone_number`	string	Primary phone number
`alternative_number`	string	Alternative phone number
`email`	string	Contact email address
`time_zone`	string	Clinic's timezone
`photos`	array	Array of photo URLs
`about`	string	Description about the clinic
`logo_url`	string	URL to clinic's logo
`organisation_id`	integer	ID of the parent organization
`service_type`	string	Type of services offered
`timings`	array	Operating hours for each day
`clinic_instructions`	string	Special instructions for patients
`parking_instruction_url`	string	URL to parking instructions
`services`	array	List of services offered
`equipments`	array	List of available equipment
`specialities`	array	Medical specialties
`year_founded`	integer	Year the clinic was established
`primary_category`	string	Primary category of the clinic
`npi`	string	National Provider Identifier
`map_image`	string	URL to map image
`send_attachments`	boolean	Whether clinic accepts attachments
`fax_number`	string	Fax number
`max_allowed_visit_per_slot`	integer	Maximum visits per time slot
`parking_available`	boolean	Whether parking is available
`verified`	boolean	Whether clinic is verified

Address Object¶

Field	Type	Description
`line1`	string	First line of address
`line2`	string	Second line of address
`landmark`	string	Nearby landmark
`city`	string	City name
`state`	string	State abbreviation
`postal_code`	string	ZIP/postal code
`latitude`	number	Latitude coordinate
`longitude`	number	Longitude coordinate
`gps_link`	string	GPS navigation link
`country`	string	Country name
`plus_code`	string	Google Plus Code
`place_id`	string	Google Place ID

Timing Object¶

Field	Type	Description
`schedule_id`	integer	Unique schedule identifier
`day_of_weeks`	array	Array of days (e.g., ["MONDAY"])
`start_time`	string	Opening time (HH:MM format)
`end_time`	string	Closing time (HH:MM format)