API Requests

The free Q-SYS Reflect API allows you to obtain a list of Q-SYS Cores, Systems, and items with relevant status. To submit a request to the Reflect API, you can use an application (for example, Postman) or a cURL command line tool.

Prerequisites

Note: Refer to the YAML file for the latest API support, as this feature is subject to change.

Example: Retrieve Info About All Cores in the Organization

This example uses the Postman application to submit an API request to obtain a list of Q-SYS Cores (and their details) within an Organization. Refer to the YAML file for a complete list of supported requests.

Example: Retrieve Media Playlists

This example uses the Postman application to submit an API request to obtain media playlists from a Q-SYS Core within an Organization. Refer to the YAML file for a complete list of supported requests.

Example: Retrieve Users Sign In Audit Records

This example uses the Postman application to submit an API request to obtain sign in records of a user on a Q-SYS Core within an Organization. Refer to the YAML file for a complete list of supported requests.

Troubleshooting