Control Events REST API (1.0)

Download OpenAPI specification:Download

Control Events Public REST API.

Authentication

OAuth2

Control Events use the OAuth 2.0 protocol for authentication and authorization. Control Events supports common OAuth 2.0 scenarios such as those for web server, installed, and client-side applications.

If you want to make requests on behalf of other control.events users, you can register an OAuth application and have them grant permissions to your app.

Security Scheme Type OAuth2
authorizationCode OAuth Flow
Authorization URL: https://account.corezoid.com/oauth2/authorize
Token URL: https://account.corezoid.com/oauth2/token
Scopes:
  • control.events:users.readonly -

    View workspace users information

  • control.events:workspaces.readonly -

    View all your workspaces

  • control.events:forms.readonly -

    View templates

  • control.events:forms.management -

    Create, update, and delete templates

  • control.events:actors.readonly -

    View actors info

  • control.events:actors.management -

    Create, update, and delete actors

  • control.events:attachments.readonly -

    View attachments

  • control.events:attachments.management -

    Create, update, and delete attachments

BearerAuth

You can generate an API access_token for your workspace on the Credentials page (Settings -> Credentials).

To use an API access_token to authenticate an API request, just replace access_token in the following API endpoints with the string key, and pass the Authorization header:

Authorization: Bearer YOUR_ACCESS_TOKEN

Security Scheme Type HTTP
HTTP Authorization Scheme bearer

workspaces

Workspaces API

Get all your workspaces

Scopes [control.events:workspaces.readonly]

Authorizations:
OAuth2 (control.events:workspaces.readonly)
header Parameters
Authorization
required
string

Authorization header. Bearer [AccessToken]

Responses

Request samples

curl --request GET \
  --url https://api.control.events/v/1.0/workspaces

Response samples

Content type
application/json
{
  • "data": [
    ]
}

users

Users API

Get workspace users

Scopes [control.events:users.readonly]

Authorizations:
OAuth2 (control.events:users.readonly)
path Parameters
accId
required
string

Workspace Id

query Parameters
limit
integer [ 0 .. 200 ]
Default: 20

The total number of rows to retrieve (used with offset)

offset
integer
Default: 0

The number of rows to skip when fetching list

header Parameters
Authorization
required
string

Authorization header. Bearer [AccessToken]

Responses

Request samples

curl --request GET \
  --url https://api.control.events/v/1.0/users/%7BaccId%7D

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Remove user

Scopes [control.events:users.management]

Authorizations:
OAuth2 (control.events:users.management)
path Parameters
accId
required
string

Workspace Id

header Parameters
Authorization
required
string

Authorization header. Bearer [AccessToken]

Request Body schema: application/json
userId
required
string

Responses

Request samples

Content type
application/json
{
  • "userId": 123
}

Response samples

Content type
application/json
{
  • "data": "ok"
}

Search workspace users

Scopes [control.events:users.readonly]<