REST API

Last Updated 11 months ago

REST API documentation

Swagger interactive REST API documentation

Please enter Account Id in "user" field and REST API Token in "password" field to test Swagger interface.

Access tokens can be created, edited and revoked using the Screen9 Account Console, under Settings -> API. This requires Administrator privileges. See example screenshot below:

image

Token privileges explained

Token privileges can be changed and revoked after the token has been created.

Access level
Determines whether the token only should have access to public content or to all content.
Read privileges
Determines whether the token should be able to read content on the account or not.
Write privileges
Determines whether the token should be able to make changes to content on the account or not.
Upload privileges
Determines whether the token should be able to add content to the account or not.

Note that the Name is only used to identify the Access Token in the Console, when accessing the API you need your Account ID (also known as custid).

Note also that there is a rate limit set for the API calls, if you believe you are experiencing issues because of this, please contact Screen9 support.

This website relies on cookies to function, but no personal data is ever stored in the cookies.
OK

Loading ...