Skip to main content

Use the OnStage API

Exchange your API credentials for a token, then call the OnStage API from your own scripts and tools.

Who can do this: Owner, Admin. What the roles mean

Before you start​

Steps​

  1. Ask for a token: send POST https://api.on-stage.app/oauth/token with grant_type=client_credentials, using your client ID and secret as the user name and password.
  2. Copy access_token from the answer. It lasts one hour.
  3. Send it with every request, in the header Authorization: Bearer <token>.
  4. Call the endpoints under https://api.on-stage.app/integrations/v1. The API reference lists each one, with what to send and what comes back.
  5. When the token expires, ask for a new one.

Good to know​

  • Changes to events and bulk uploads only preview what would change. Send "dryRun": false to apply them.
  • The API can do only what your role allows.
  • Each team has a daily number of requests, set by its plan. GET /integrations/v1/me shows how many are left.
  • To generate a client in your language, download the OpenAPI file.