Firework · OAuth Scopes

Firework OAuth Scopes

OAuth 2.0 searched

Firework publishes 12 OAuth 2.0 scopes via the clientCredentials and authorizationCode flows. Scopes are the fine-grained permissions an application requests at authorization time to act against the Firework API on a user’s behalf.

Tokens are issued from https://api.firework.com/oauth/token.

This index is generated from the provider’s OpenAPI security definitions (and, where available, its documented scope reference) and refreshes on every APIs.io network build. Browse every provider’s scopes at scopes.apis.io.

CompanyConsumerVideo CommerceShoppable VideoLivestream ShoppingEcommerceRetailVideoSDKWebhooks
Scopes: 12 Flows: clientCredentials, authorizationCode Method: searched

OAuth endpoints

Authorization URL
https://api.firework.com/oauth/authorize
Token URL
https://api.firework.com/oauth/token
Flows
clientCredentialsauthorizationCode

Scopes (12)

ScopeDescriptionFlows
businesses:read List businesses the token can act on. clientCredentials, authorizationCode
channels:read List channels. clientCredentials, authorizationCode
channels:write Update a channel's metadata. clientCredentials, authorizationCode
insights:read Read analytics / insights data. clientCredentials, authorizationCode
livestreams:read Read livestream resources. clientCredentials, authorizationCode
livestreams:write Create and manage livestream resources. clientCredentials, authorizationCode
playlists:read Read playlists. clientCredentials, authorizationCode
playlists:write Create and manage playlists. clientCredentials, authorizationCode
products:read List or search products and business stores. clientCredentials, authorizationCode
products:write Create and manage products. clientCredentials, authorizationCode
videos:read List videos, read video details, and check async import status. clientCredentials, authorizationCode
videos:write Upload, create, update, delete, publish, archive videos and manage subtitles/posters. clientCredentials, authorizationCode

Source

OAuth Scopes

firework-scopes.yml Raw ↑
generated: '2026-07-19'
method: searched
source: well-known/firework-oauth-authorization-server.json
docs: https://docs.firework.com/firework-for-developers/api/authentication
schemes:
  - name: OAuth2
    source: well-known/firework-oauth-authorization-server.json
    flows:
      - flow: clientCredentials
        tokenUrl: https://api.firework.com/oauth/token
      - flow: authorizationCode
        authorizationUrl: https://api.firework.com/oauth/authorize
        tokenUrl: https://api.firework.com/oauth/token
scopes:
  - scope: businesses:read
    description: List businesses the token can act on.
    flows: [clientCredentials, authorizationCode]
  - scope: channels:read
    description: List channels.
    flows: [clientCredentials, authorizationCode]
  - scope: channels:write
    description: Update a channel's metadata.
    flows: [clientCredentials, authorizationCode]
  - scope: insights:read
    description: Read analytics / insights data.
    flows: [clientCredentials, authorizationCode]
  - scope: livestreams:read
    description: Read livestream resources.
    flows: [clientCredentials, authorizationCode]
  - scope: livestreams:write
    description: Create and manage livestream resources.
    flows: [clientCredentials, authorizationCode]
  - scope: playlists:read
    description: Read playlists.
    flows: [clientCredentials, authorizationCode]
  - scope: playlists:write
    description: Create and manage playlists.
    flows: [clientCredentials, authorizationCode]
  - scope: products:read
    description: List or search products and business stores.
    flows: [clientCredentials, authorizationCode]
  - scope: products:write
    description: Create and manage products.
    flows: [clientCredentials, authorizationCode]
  - scope: videos:read
    description: List videos, read video details, and check async import status.
    flows: [clientCredentials, authorizationCode]
  - scope: videos:write
    description: Upload, create, update, delete, publish, archive videos and manage subtitles/posters.
    flows: [clientCredentials, authorizationCode]