Integration APIs

The Scheduly API allows you to create your own custom features by providing programmatic access to your Scheduly data and functionality. In order to give you a best-in-class experience when using our API, we have developed this API with standard conventions. We’ve created well-defined conventions to make integrations against our API a simple experience for you.

1. Login

  • Description: login to obtain the token with which you can get the APIs
  • API: https://scheduly-rest/api/auth/login
  • Method: POST
  • Headers:
    • -Content-type: application/json
    • X-Requested-With: XMLHttpRequest
  • Body:
  • Body type: JSON
    • JSON data:
      • email (required)
      • password (required)
      • remember_me (optional)
  • Response:
    • access_token (string)
    • token_type (string)
    • expires_at (datetime)

2. Logout

  • Description: close the apis consumption session
  • API: https://scheduly-rest/api/auth/logout
  • Method: GET
  • Headers:
    • Content-type: application/json
    • X-Requested-With: XMLHttpRequest
    • Autorization: Bearer [value_access_token]
  • Params: without parameters
  • Response:
    • message (string)

3. UserFind

  • Description: logged in user information (users table)
  • API: https://scheduly-rest/api/auth/user
  • Method: GET
  • Headers:
    • Content-type: application/json
    • X-Requested-With: XMLHttpRequest
    • Autorization: Bearer [value_access_token]
  • Params: without parameters
  • Response:
    • data (JSON)

4. GetClients

  • Description: get all the clients associated with the company
  • API: https://scheduly-rest/api/auth/getClients
  • Method: GET
  • Headers:
    • Content-type: application/json
    • X-Requested-With: XMLHttpRequest
    • Autorization: Bearer [value_access_token]
  • Params: without parameters
  • Response:
    • message (string)
    • data (array)

5. GetBookings

  • Description: get all the bookings associated with the company
  • API: https://scheduly-rest/api/auth/getBookings
  • Method: GET
  • Headers:
    • Content-type: application/json
    • X-Requested-With: XMLHttpRequest
    • Autorization: Bearer [value_access_token]
  • Params: without parameters
  • Response:
    • message (string)
    • data (array)

6. CreateClient

  • Body type: JSON
  • JSON data:
    • first_name (required)
    • last_name (required)
    • mobile (required)
    • email (required)
    • password (required)
    • address (required)
  • Response:
    • data (JSON)
    • message (string)
    • status (number)
  • Failed messages:
    • Unauthenticated
Unauthenticated user or invalid token

Unauthenticated user or invalid token

  • Error 500
Internal server error

Internal server error

  • Error in code
Internal code, report to admin

Internal code, report to admin

Examples postman collection:

https://www.getpostman.com/collections/26960805ad0a5fe20075

Next article How can I receive bookings from Google my Business?