Streamdata.io API Gallery - OnSched (Report Issue)

Organization(s):

OnSched Returns a list of appointments.

The results are returned in pages. Use the offset and limit parameters to control the page start and size. Default offset is 0, and limit is 20. Use the other query parameters to optionally filter the results list.

OnSched Returns an appointment object

This end point creates a new appointment in an Initial "IN" status. A valid serviceId is required. Use GET consumer/v1/services to retrieve a list of your services. A valid resourceId is required if your calendar is a resource based calenda...

OnSched Returns a list of appointment custom field definitions

This end point returns your Appointment custom field definitions. Appointment custom fields are different than Customer custom fields. Appointment custom fields are stored with each appointment. They are used when the information collected dur...

OnSched Returns an appointment object

This end point deletes a booking. Only appointments in a "IN" initial status can be deleted. Past dated appointments cannot be cancelled. A valid appointment id is required. Use the appointmentId returned from GET /consumer/v1/appointments

OnSched Returns an appointment object.

The result returned is a single appointment object. A valid id is required to find the appointment. Find appointment id's using the GET consumer/v1/appointments end point.

OnSched Returns an appointment object

This end point completes a new booking. Only appointments in the "IN" initial status can be booked. by saving all the relevant details of the booking. A valid appointment id is required. Use the appointmentId returned from POST /consumer/v1/ap...

OnSched Returns an appointment object

This end point cancels a booking or reservation. Only appointments in a "BK" booked, or "RS" reserved status can be cancelled. Past dated appointments cannot be cancelled. A valid appointment id is required. Use the appointmentId returned from...

OnSched Returns an appointment object

This end point reschedules a booking. Only appointments in a "BK" booked status can be rescheduled. Past dated appointments cannot be cancelled. A valid appointment id is required. Use the appointmentId returned from GET /consumer/v1/appointme...

OnSched Returns a list of available times.

This end point is used to find availability for the purpose of rescheduling an appointment. Availability defaults to the serviceId, resourceId and timezone from the original appointment. After choosing from the availability, you can call the app...

OnSched Returns a list of available times.

Choose your search criteria carefully. Availability is an expensive call. If you search availability for all resources then you should only do so for a single date. If you decide to search availability for multiple dates you should only do so fo...

OnSched Returns a list of available days.

This end point is used to show day level availability. For example if the business is closed, or there is a public holiday. Day level availability is a good way to restrict your choices of dates in your app and improve usability.

OnSched Returns a list of unavailable times.

This endpoint is used to show unavailable times and provides information why the timeslot is unavailable.

OnSched Returns a list of customers.

The results are returned in pages. Use the offset and limit parameters to control the page start and size. Default offset is 0, and limit is 20. Use the other query parameters to optionally filter the results list.

OnSched Creates a new customer object.

Use this endpoint to create a new customer. If not specified the business location id defaults to the first location in the company. Email Address and a lastname are required for creating a new customer.

OnSched Returns a list of country objects

Returns a list of countries with the associated country code. Country codes are based on the 2 character ANSI standard.

OnSched Returns a list of customField objects

This end point returns your Customer custom field definitions. Customer custom fields are different than Appointment custom fields. Appointment custom fields are stored with each appointment. They are used when the information collected during...

OnSched Deletes a customer subscription object.

Deletes a customer subscription object.

OnSched Returns a customer object.

The result returned is a single customer object. An id is required to find the customer. Find customer id's using either the GET consumer/v1/customers end point, or the GET consumer/v1/appointments end point. A customer object is automatically cr...

OnSched Updates a customer object.

Use this endpoint to update customer information. If not specified the business location id defaults to the first location in the company. Blank fields are not changed

OnSched Returns a list of customer booking limits.

The result returned is list of limit rules as defined by the subscribed customer plan along with Booking Counts/Minutes The results indicate the remaining bookings count / minutes. Use the results in your app to determine if the customer should c...

OnSched Returns a customer subscription object.

The result returned is a single customer subscription object. A customer can only be subsribed to a single Customer Plan

OnSched Creates a new customer subscription object.

Use this endpoint to create a new customer subscription.

OnSched Returns a list of customers.

The results are returned in pages. Use the offset and limit parameters to control the page start and size. Default offset is 0, and limit is 20. Use the other query parameters to optionally filter the results list.

OnSched Returns a customer object.

The result returned is a single customer object. An id is required to find the customer. Find customer id's using either the GET consumer/v1/customers end point, or the GET consumer/v1/appointments end point. A customer object is automatically cr...

OnSched Returns a list of lead questions

This end point returns your Customer Registration fields. Customer custom fields are different than Appointment custom fields. Appointment custom fields are stored with each appointment. They are used when the information collected during the ...

OnSched Returns a list of state objects

Returns a list of states with the associated state code and country. Contact us if states for your countries of operation are not currently loaded.

OnSched Returns a list of customer subscriptions.

The results are returned in pages. Use the offset and limit parameters to control the page start and size. Default offset is 0, and limit is 20. Use the other query parameters to optionally filter the results list.

OnSched Deletes a list of lead questions

Deletes a list of lead questions

OnSched Returns a customer subscription object.

The result returned is a single customer subscription object.

OnSched Updates a customer subscription object.

Use this endpoint to update customer subscription information.

OnSched Returns a list of business locations.

Use this api end point if you have multiple business locations in your company. The results are returned in pages. Use the offset and limit parameters to control the page start and size. Default offset is 0, and limit is 20. Use the other query ...

OnSched Returns a business location object.

The result returned is a single location object. An id is required to find the location. Find location id's using the GET consumer/v1/locations end point,

OnSched Returns a list of resources.

The results are returned in pages. Use the offset and limit parameters to control the page start and size. Default offset is 0, and limit is 20. Use the other query parameters to optionally filter the results list.

OnSched Returns a resource object.

The result returned is a single resource object. An id is required to find the resource. Find customer id's using either the GET consumer/v1/resources end point, or the GET consumer/v1/appointments end point.

OnSched Returns a list of resource services.

The results are returned in pages. Use the offset and limit parameters to control the page start and size. Default offset is 0, and limit is 20. Use the other query parameters to optionally filter the results list. Resource services are used to ...

OnSched Returns a list of service groups.

The results are returned in pages. Use the offset and limit parameters to control the page start and size. Default offset is 0, and limit is 20. Use the other query parameters to optionally filter the results list.

OnSched Returns a serviceGroup object.

The result returned is a single serviceGroup object. An id is required to find the serviceGroup. Find serviceGroup id's using the GET consumer/v1/servicegroups end point,

OnSched Returns a list of services.

The results are returned in pages. Use the offset and limit parameters to control the page start and size. Default offset is 0, and limit is 20. Use the other query parameters to optionally filter the results list.

OnSched Returns a service object.

The result returned is a single service object. An id is required to find the service. Find service id's using either the GET consumer/v1/service end point, or the GET consumer/v1/appointments end point.

OnSched Returns a list of resources.

The results are returned in pages. Use the offset and limit parameters to control the page start and size. Default offset is 0, and limit is 20. Use the other query parameters to optionally filter the results list.

OnSched Returns a list of customers.

The results are returned in pages. Use the offset and limit parameters to control the page start and size. Default offset is 0, and limit is 20. Use the other query parameters to optionally filter the results list.

Submit Your API

Join the gallery to find out how much you can save with Streamdata.io.