OnSched Consumer API

onsched · Company

Company No Auth Free & Open collaboration

Build secure and scalable custom apps for Online Booking. Our flexible API provides many options for availability and booking. Take the API for a test drive. Just click on the Authorize button below and authenticate. You can access our demo company profile if you are not a customer, or your own profile by using your assigned ClientId and Secret. The API has two interfaces, consumer and setup. The consumer interface provides all the endpoints required for imp

Authentication

No authentication requiredFree to use with no key needed.

Sample Requests

GET Get Appointments

Use this endpoint to return a List of Appointments . Use the offset and limit parameters to control the page start and number of results. Default offset is 0, limit is 20, max is 100. Use the query parameters to filter the results further. For more information: <a href="https://onsched.read

https://api.apis.guru/v2/specs/onsched.com/consumer/v1/consumer/v1/appointments?email=[email protected]&limit=10&phone=example&offset=0&status=example&endDate=example&bookedBy=example&lastname=example&serviceId=example&startDate=example&calendarId=example&customerId=example&locationId=example&resourceId=example&serviceAllocationId=example

Hover any highlighted part to learn what it does

curl -X GET "https://api.apis.guru/v2/specs/onsched.com/consumer/v1/consumer/v1/appointments?email=test%40example.com&limit=10&phone=example&offset=0&status=example&endDate=example&bookedBy=example&lastname=example&serviceId=example&startDate=example&calendarId=example&customerId=example&locationId=example&resourceId=example&serviceAllocationId=example"

import requests
params = {
    "email": "[email protected]",
    "limit": "10",
    "phone": "example",
    "offset": "0",
    "status": "example",
    "endDate": "example",
    "bookedBy": "example",
    "lastname": "example",
    "serviceId": "example",
    "startDate": "example",
    "calendarId": "example",
    "customerId": "example",
    "locationId": "example",
    "resourceId": "example",
    "serviceAllocationId": "example"
}
response = requests.get(
    "https://api.apis.guru/v2/specs/onsched.com/consumer/v1/consumer/v1/appointments",
    params=params,
)
print(response.json())

const url = new URL('https://api.apis.guru/v2/specs/onsched.com/consumer/v1/consumer/v1/appointments');
url.searchParams.set('email', '[email protected]');
url.searchParams.set('limit', '10');
url.searchParams.set('phone', 'example');
url.searchParams.set('offset', '0');
url.searchParams.set('status', 'example');
url.searchParams.set('endDate', 'example');
url.searchParams.set('bookedBy', 'example');
url.searchParams.set('lastname', 'example');
url.searchParams.set('serviceId', 'example');
url.searchParams.set('startDate', 'example');
url.searchParams.set('calendarId', 'example');
url.searchParams.set('customerId', 'example');
url.searchParams.set('locationId', 'example');
url.searchParams.set('resourceId', 'example');
url.searchParams.set('serviceAllocationId', 'example');

const response = await fetch(url); 
const data = await response.json();
console.log(data);

package main

import (
	"fmt"
	"io"
	"net/http"
	"net/url"
)

func main() {
	baseURL, _ := url.Parse("https://api.apis.guru/v2/specs/onsched.com/consumer/v1/consumer/v1/appointments")
	q := baseURL.Query()
	q.Set("email", "[email protected]")
	q.Set("limit", "10")
	q.Set("phone", "example")
	q.Set("offset", "0")
	q.Set("status", "example")
	q.Set("endDate", "example")
	q.Set("bookedBy", "example")
	q.Set("lastname", "example")
	q.Set("serviceId", "example")
	q.Set("startDate", "example")
	q.Set("calendarId", "example")
	q.Set("customerId", "example")
	q.Set("locationId", "example")
	q.Set("resourceId", "example")
	q.Set("serviceAllocationId", "example")
	baseURL.RawQuery = q.Encode()
	targetURL := baseURL.String()
	req, _ := http.NewRequest("GET", targetURL, nil)

	client := &http.Client{}
	resp, _ := client.Do(req)
	defer resp.Body.Close()
	body, _ := io.ReadAll(resp.Body)
	fmt.Println(string(body))
}

require "net/http"
require "json"

uri = URI("https://api.apis.guru/v2/specs/onsched.com/consumer/v1/consumer/v1/appointments")
uri.query = URI.encode_www_form({
  "email" => "[email protected]",
  "limit" => "10",
  "phone" => "example",
  "offset" => "0",
  "status" => "example",
  "endDate" => "example",
  "bookedBy" => "example",
  "lastname" => "example",
  "serviceId" => "example",
  "startDate" => "example",
  "calendarId" => "example",
  "customerId" => "example",
  "locationId" => "example",
  "resourceId" => "example",
  "serviceAllocationId" => "example"
})

http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"

req = Net::HTTP::Get.new(uri)

res = http.request(req)
puts JSON.parse(res.body)

<?php
$url = "https://api.apis.guru/v2/specs/onsched.com/consumer/v1/consumer/v1/appointments?" . http_build_query([
    "email" => "[email protected]",
    "limit" => "10",
    "phone" => "example",
    "offset" => "0",
    "status" => "example",
    "endDate" => "example",
    "bookedBy" => "example",
    "lastname" => "example",
    "serviceId" => "example",
    "startDate" => "example",
    "calendarId" => "example",
    "customerId" => "example",
    "locationId" => "example",
    "resourceId" => "example",
    "serviceAllocationId" => "example"
]);
$opts = ["http" => [
    "method" => "GET",
]];
$ctx = stream_context_create($opts);
$res = file_get_contents($url, false, $ctx);
print_r(json_decode($res, true));

GET List Customers

Use this endpoint to return a List of Customers . The results are returned in pages. Use the offset and limit parameters to control the page start and number of results. Default offset is 0, limit is 20, max is 100. Use the query parameters to filter the results further.

https://api.apis.guru/v2/specs/onsched.com/consumer/v1/consumer/v1/customers?email=[email protected]&limit=10&offset=0&deleted=true&groupId=example&lastname=example&locationId=example

Hover any highlighted part to learn what it does

curl -X GET "https://api.apis.guru/v2/specs/onsched.com/consumer/v1/consumer/v1/customers?email=test%40example.com&limit=10&offset=0&deleted=true&groupId=example&lastname=example&locationId=example"

import requests
params = {
    "email": "[email protected]",
    "limit": "10",
    "offset": "0",
    "deleted": "true",
    "groupId": "example",
    "lastname": "example",
    "locationId": "example"
}
response = requests.get(
    "https://api.apis.guru/v2/specs/onsched.com/consumer/v1/consumer/v1/customers",
    params=params,
)
print(response.json())

const url = new URL('https://api.apis.guru/v2/specs/onsched.com/consumer/v1/consumer/v1/customers');
url.searchParams.set('email', '[email protected]');
url.searchParams.set('limit', '10');
url.searchParams.set('offset', '0');
url.searchParams.set('deleted', 'true');
url.searchParams.set('groupId', 'example');
url.searchParams.set('lastname', 'example');
url.searchParams.set('locationId', 'example');

const response = await fetch(url); 
const data = await response.json();
console.log(data);

package main

import (
	"fmt"
	"io"
	"net/http"
	"net/url"
)

func main() {
	baseURL, _ := url.Parse("https://api.apis.guru/v2/specs/onsched.com/consumer/v1/consumer/v1/customers")
	q := baseURL.Query()
	q.Set("email", "[email protected]")
	q.Set("limit", "10")
	q.Set("offset", "0")
	q.Set("deleted", "true")
	q.Set("groupId", "example")
	q.Set("lastname", "example")
	q.Set("locationId", "example")
	baseURL.RawQuery = q.Encode()
	targetURL := baseURL.String()
	req, _ := http.NewRequest("GET", targetURL, nil)

	client := &http.Client{}
	resp, _ := client.Do(req)
	defer resp.Body.Close()
	body, _ := io.ReadAll(resp.Body)
	fmt.Println(string(body))
}

require "net/http"
require "json"

uri = URI("https://api.apis.guru/v2/specs/onsched.com/consumer/v1/consumer/v1/customers")
uri.query = URI.encode_www_form({
  "email" => "[email protected]",
  "limit" => "10",
  "offset" => "0",
  "deleted" => "true",
  "groupId" => "example",
  "lastname" => "example",
  "locationId" => "example"
})

http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"

req = Net::HTTP::Get.new(uri)

res = http.request(req)
puts JSON.parse(res.body)

<?php
$url = "https://api.apis.guru/v2/specs/onsched.com/consumer/v1/consumer/v1/customers?" . http_build_query([
    "email" => "[email protected]",
    "limit" => "10",
    "offset" => "0",
    "deleted" => "true",
    "groupId" => "example",
    "lastname" => "example",
    "locationId" => "example"
]);
$opts = ["http" => [
    "method" => "GET",
]];
$ctx = stream_context_create($opts);
$res = file_get_contents($url, false, $ctx);
print_r(json_decode($res, true));

GET List Locations

Use this endpoint to return a List of Business Locations . 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 and maximum is 100. Use the other query parameters to filter the results further.

https://api.apis.guru/v2/specs/onsched.com/consumer/v1/consumer/v1/locations?name=test&limit=10&units=example&offset=0&regionId=example&nearestTo=example&proximity=1&serviceId=example&friendlyId=example&ignorePrimary=true

Hover any highlighted part to learn what it does

curl -X GET "https://api.apis.guru/v2/specs/onsched.com/consumer/v1/consumer/v1/locations?name=test&limit=10&units=example&offset=0&regionId=example&nearestTo=example&proximity=1&serviceId=example&friendlyId=example&ignorePrimary=true"

import requests
params = {
    "name": "test",
    "limit": "10",
    "units": "example",
    "offset": "0",
    "regionId": "example",
    "nearestTo": "example",
    "proximity": "1",
    "serviceId": "example",
    "friendlyId": "example",
    "ignorePrimary": "true"
}
response = requests.get(
    "https://api.apis.guru/v2/specs/onsched.com/consumer/v1/consumer/v1/locations",
    params=params,
)
print(response.json())

const url = new URL('https://api.apis.guru/v2/specs/onsched.com/consumer/v1/consumer/v1/locations');
url.searchParams.set('name', 'test');
url.searchParams.set('limit', '10');
url.searchParams.set('units', 'example');
url.searchParams.set('offset', '0');
url.searchParams.set('regionId', 'example');
url.searchParams.set('nearestTo', 'example');
url.searchParams.set('proximity', '1');
url.searchParams.set('serviceId', 'example');
url.searchParams.set('friendlyId', 'example');
url.searchParams.set('ignorePrimary', 'true');

const response = await fetch(url); 
const data = await response.json();
console.log(data);

package main

import (
	"fmt"
	"io"
	"net/http"
	"net/url"
)

func main() {
	baseURL, _ := url.Parse("https://api.apis.guru/v2/specs/onsched.com/consumer/v1/consumer/v1/locations")
	q := baseURL.Query()
	q.Set("name", "test")
	q.Set("limit", "10")
	q.Set("units", "example")
	q.Set("offset", "0")
	q.Set("regionId", "example")
	q.Set("nearestTo", "example")
	q.Set("proximity", "1")
	q.Set("serviceId", "example")
	q.Set("friendlyId", "example")
	q.Set("ignorePrimary", "true")
	baseURL.RawQuery = q.Encode()
	targetURL := baseURL.String()
	req, _ := http.NewRequest("GET", targetURL, nil)

	client := &http.Client{}
	resp, _ := client.Do(req)
	defer resp.Body.Close()
	body, _ := io.ReadAll(resp.Body)
	fmt.Println(string(body))
}

require "net/http"
require "json"

uri = URI("https://api.apis.guru/v2/specs/onsched.com/consumer/v1/consumer/v1/locations")
uri.query = URI.encode_www_form({
  "name" => "test",
  "limit" => "10",
  "units" => "example",
  "offset" => "0",
  "regionId" => "example",
  "nearestTo" => "example",
  "proximity" => "1",
  "serviceId" => "example",
  "friendlyId" => "example",
  "ignorePrimary" => "true"
})

http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"

req = Net::HTTP::Get.new(uri)

res = http.request(req)
puts JSON.parse(res.body)

<?php
$url = "https://api.apis.guru/v2/specs/onsched.com/consumer/v1/consumer/v1/locations?" . http_build_query([
    "name" => "test",
    "limit" => "10",
    "units" => "example",
    "offset" => "0",
    "regionId" => "example",
    "nearestTo" => "example",
    "proximity" => "1",
    "serviceId" => "example",
    "friendlyId" => "example",
    "ignorePrimary" => "true"
]);
$opts = ["http" => [
    "method" => "GET",
]];
$ctx = stream_context_create($opts);
$res = file_get_contents($url, false, $ctx);
print_r(json_decode($res, true));

Postman Setup Guide

Get Postman ↗

See official documentation for authentication and setup.

What can you build with OnSched Consumer API?

OnSched Consumer API is a Company API. Developers commonly use company APIs for:

enriching CRM records with company firmographics
building lead-generation and prospecting tools
verifying business identity and registration details
monitoring competitors and market intelligence
powering B2B data enrichment pipelines

No authentication required. This API is open — no signup or key needed. Ideal for quick prototypes and public-facing features. OnSched Consumer API is free to use, making it a low-risk choice to experiment with.

New to APIs? Read our beginner's guide · Learn about API keys · What is REST?

Open documentation ↗