Setster's scheduling platform employs a RESTful API that is easily deployed, secure, and highly scalable to meet enterprise needs.

You can schedule thousands of appointments, remotely manage all of their parameters, track all user activity and plug Setster within your business workflow. In layman's terms, with Setster, you can add massive scheduling capacity anywhere within your enterprise.

The first step to getting started using Setster to solve your complex scheduling needs is to create an account. The intuitive onboarding will walk you through adding all of the details about your business, locations, services, and staff that are a core component of developing your custom scheduling experience.

Sign Up

To use the Setster API, you will need the API key found within your Setster account. The Setster API works on HTTPS only.

In this guide, we'll be using a Postman Collection to test out sending requests to the Setster API with a final goal of creating a new appointment.

Download and Import Collection To use the provided Postman Collection, you'll need to import it into your workspace. Detailed instructions on importing collections can be found at the official Postman docs here.

Download Postman Collection

For the purpose of this getting started guide, we'll be working within the Basic Appointment Booking folder.

In this collection we'll be making use of Collection Variables to store data that we retrieve from a sequence of requests. To access and edit these variables edit the collection details and navigate to the variables section.

Authenticate your key to get your session token. We'll use the session_token property from this response to send to all future requests.

Using Postman

1. Import the Postman Collection and locate the Basic Appointment Booking folder.
2. Before making your first request, you'll need to update the email and API_TOKEN collection variables.
3. Open the Auth Get Session Token POST request from within the 1. Get Session Token folder
4. Click the Send button to run the authentication POST request
5. Your SESSION_TOKEN and company_id will automatically set in the collection variables after the initial authentication request.
6. Open the collection variables to confirm the SESSION_TOKEN, and company_id values are now populated before moving forward.

If the account has multiple locations, you'll need to retrieve them and select the one you'll book the appointment at. If the account has only one location, this step can be skipped, and the system will book the appointment within the single location.

If the user experience requires a specific employee to be selected during the booking flow, use this call to get the list of available employees. This step is optional if the account only has one employee or a specific employee is not required to be selected. In that case, the appointment will be assigned to the appropriate employee based on a round-robin approach.

Each service record has a location_links property that defines the links between the service, the employees, and the locations. This is how the system determines which service is offered at what location and by whom.

This information is used when displaying a list of available locations, services, and employees to the user to select when booking an appointment. This parameter is also available for the employee entity.

Get the availability for the selected location(optional), employee(optional), service, and day/week.

• If the location is not specified, then the default location for that company will be assigned.
• If the employee is not specified, then the pooled availability of all employees will be returned.

Once you have all the above selected, you're ready to construct the request to create a new appointment. Setster requires the name and email address of the client at a minimum to save an appointment. You can optionally include additional information like phone, address, and other information that can be passed using Custom Fields.