Usage

General

The API follows a RESTful approach, with JSON as the serialisation format.

Access control is managed using the OAuth 2.0 Client Credentials Grant.

URLs

The API is deployed at the following location:

https://app.sparkforms.io/api/...

Authorisation

In order to use the API, you must first create an API Client. Using the resulting client ID and secret an access token can be obtained, which must be included as a header in subsequent requests:

Authorization: Bearer <token>

There are two scopes available, access to which will depend on client settings:

• read - access to read-only methods
• write - access to write methods

If no scope is specified, read will be assumed.

Parameters

Where supported, parameters are accepted via the query string.

Filters

Where supported, filters are accepted via the query string.

If multiple filters/values are supplied, they will be evaluated as follows:

• OR for multiple values of a single filter
• AND for different filters

For example, the set of filters (name="Alice", name="Bob", age=20) will be evaluated as ((name="Alice" OR name="Bob") AND age=20).

Errors

In the event of an error, a non-2xx status code will be returned along with an Error object.