Kb Articles

Bookly Read Rest API Plugin

Here are the key features of Bookly Rest API Plugin

  • Get Appointment details
  • Filter Appointments based on date range, staff and customer email
  • Get Staff details
  • Get Services details
  • Get Customer Details

Bookly Appointments Rest API URL : http://siteurl/wp-json/wp/v2/wpo_bookly_appointments
Response in json format:

[
    {
        "id": "1",
        "series_id": null,
        "location_id": null,
        "staff_id": {
            "id": "2",
            "wp_user_id": "0",
            "attachment_id": "0",
            "full_name": "Angella ",
            "email": "[email protected]",
            "phone": "+916546546546546",
            "info": "Lorem ipusm"
        },
        "staff_any": "0",
        "service_id": {
            "id": "3",
            "category_id": "2",
            "title": "web",
            "duration": "3600",
            "price": "10.00"
        },
        "custom_service_name": null,
        "custom_service_price": null,
        "start_date": "2018-07-27 13:15:00",
        "end_date": "2018-07-27 14:15:00",
        "extras_duration": "0",
        "internal_note": null,
        "google_event_id": null,
        "google_event_etag": null,
        "created_from": "bookly"
    },
    {
        "id": "2",
        "series_id": null,
        "location_id": null,
        "staff_id": {
            "id": "1",
            "wp_user_id": "0",
            "attachment_id": "270",
            "full_name": "kevin jones",
            "email": "[email protected]",
            "phone": "+9112121212121212",
            "info": "Lorem Ipusm content goes here."
        },
        "staff_any": "0",
        "service_id": {
            "id": "1",
            "category_id": "1",
            "title": "WP Developer ",
            "duration": "3600",
            "price": "11.00"
        },
        "custom_service_name": null,
        "custom_service_price": null,
        "start_date": "2018-07-27 10:15:00",
        "end_date": "2018-07-27 11:15:00",
        "extras_duration": "0",
        "internal_note": null,
        "google_event_id": null,
        "google_event_etag": null,
        "created_from": "bookly"
    }
]

 

Here is the Postman request screenshot for more clarification:

Bookly Appointments Rest API Filters :

  • Filter by Staff Email http://siteurl/wp-json/wp/v2/wpo_bookly_appointments?filter[staff]=staffemailid
  • Filter by Customer Email http://siteurl/wp-json/wp/v2/wpo_bookly_appointments?filter[customer]=customeremailid
  • Filter by Month http://siteurl/wp-json/wp/v2/wpo_bookly_appointments?filter[month]=8
  • Filter by Today http://siteurl/wp-json/wp/v2/wpo_bookly_appointments?filter[appointments]=today
  • Filter by Date Range http://siteurl/wp-json/wp/v2/wpo_bookly_appointments?filter[startdate]=2018-08-01&filter[enddate]=2018-09-15

 

Bookly Staff Rest API URL : http://siteurl/wp-json/wp/v2/wpo_bookly_staff

 

Bookly Services Rest API URL : http://siteurl/wp-json/wp/v2/wpo_bookly_services

 

Bookly Customers Rest API URL : http://siteurl/wp-json/wp/v2/wpo_bookly_customers

Changelog:

= 1.1.0 (2018-11-19) = 

Updated plugin to support Bookly Latest Version.



Back To Top