Online Scheduling Web Services API

Shiftboard API - The Developer API for Shiftboard

For Enterprise and Community Platform Builders, Shiftboard offers a rich set of Application Programming Interfaces (APIs) for resource and scheduling management services, including tools for JSON-RPC, XML, RSS/ATOM and iCal syndication.

Shiftboard Classes & Methods It's easy to seamlessly integrate Shiftboard Account Financials, Scheduling, Reporting and other decision making details with products and services that you already use in-house or that you plan to offer to your own clients.

Leverage the Cloud Begin using the Shiftboard web services API to rapidly build new mashups with other web services or to extend your existing applications for scalability with online resource scheduling, reporting, and management.

Real-time Device and Web Application Test Tools

Shiftboard Online scheduling software provides the most flexible and extensible set of transaction-oriented API's and developer test tools to support real-time, secure, and direct access to the robust Shiftboard online scheduling and workforce management service platform.

API Overview

In order to use the Shiftboard API, you'll need the following:

  • Software Development Experience
  • A valid API Account Key
  • A valid API Private Signature Key

API Example

The Shiftboard API uses JavaScript Object Notation (JSON) to encode request parameters and responses. The interface is simple and secure.

For example, a key-signed (base64-encoded HMAC SHA1 signature) request to the simple test method, echo, without any parameters, might look like this:

Further, if there's an error (such as an authentication problem) with your request, the API service gateway will respond with a JSON-encoded HTTP error message and code with details about the problem.

    "seconds": "0.00665", 
    "jsonrpc": "2.0", 
    "id": null, 
    "error": {
        "message": "An error occurred", 
        "code": -32000, 
        "data": {
            "app": "api", 
            "code": "not_authenticated"

API Classes and Methods

The Shiftboard API offers several important APIs to create, list, update and delete data in the following areas:

  • Accounts
  • Teams/Workgroups and Memberships
  • Access Levels
  • Scheduled Coverage (Shifts)
  • Timecards and Timeclock
  • Clients
  • Departments
  • Locations/Venues
  • Roles
  • Messaging, templates

For more information and documentation, get your API access key and consult the online API Documentation.

Get Started: Accessing the APIs

The Shiftboard API enables secure access to Shiftboard data. Accessing the API is subject to the Shiftboard Subscription Agreement as well as the Shiftboard API & Development Environment License Agreement.

API Access and Signature Keys are available to:

  • Existing, qualified Shiftboard customers by special request.
  • Shiftboard customers that possess some software development knowledge.

With a valid API Account Key and a corresponding Private Signature key, integrators can explore and experiment with the API using their own software or by using the online test page.