Introduction

Welcome to the STS Cloud API. You can use our API to access a variety of endpoints, as described on this page.

Authentication

To authorize, use this code:

# With shell, you simply construct the proper URL, passing all required parameters
curl "https://stscloud.com/interfaces/ENDPOINT?username=USERNAME&key=API_KEY"

Make sure to replace ENDPOINT with the desired endpoint, USERNAME with your STS Cloud username, and API_KEY with your API key.

STS Cloud uses API keys to allow access to the API. You can request an API key by contacting your Account Manager or by contacting our support team.

For ease of use in integrating with a variety of third-party applications, the STS Cloud API uses vanilla HTTP GET requests. STS Cloud expects an API key to be included as part of the URI's querystring parameters in each API request, along with a valid username. API keys and users are company-specific – to properly authenticate, the API key and the username provided must be valid and belong to the same company.

https://stscloud.com/interfaces/ENDPOINT?username=USERNAME&key=API_KEY

Daily Functions

curl "https://stscloud.com/interfaces/reporting/daily_functions.json?username=USERNAME&key=API_KEY&start_date=START_DATE&end_date=END_DATE"

Make sure to replace USERNAME with your STS Cloud username, and API_KEY with your API key.

The above command returns JSON structured like this:

[
  {
    "date":"2019-01-01",
    "functions":[
      {
        "meeting_names":["Leadership Retreat"],
        "function_id":"999999-123456",
        "status":"definite",
        "complete":false,
        "meeting_room":"Pine Room",
        "function":"Breakfast",
        "post_as":"Leadership Retreat - Breakfast",
        "time_range":["2019-01-01T07:00:00.000-05:00","2019-01-01T08:00:00.000-05:00"],"setup":"Existing",
        "seating_count":95,
        "user_name":"Smith"
      }
    ]
  }
]

This endpoint gets all daily functions for the given date range, in JSON format.

HTTP Request

GET https://stscloud.com/interfaces/reporting/daily_functions.json?username=USERNAME&key=API_KEY&start_date=START_DATE&end_date=END_DATE

Query Parameters

Parameter	Required	Description
start_date	Yes	The start date for records to return, in ISO-8601 format (YYYY-MM-DD)
end_date	Yes	The end date for records to return, in ISO-8601 format (YYYY-MM-DD)