Overview
The Squadcast Organization-Scoped API provides organization-level operations for managing Squadcast resources at scale. This API currently supports a limited set of operations that are not scoped to individual users, enabling system automation and organization-wide API operations that don't require user context. For operations not available here, the User-Scoped APIs are the only option for now. It's ideal for programmatic access to organization-level resources and integration workflows.
Service Regions
Squadcast allows customers to choose the geographic region of the Squadcast data centers that host their account. When signing up, you can choose the service region. Currently, the available options are the United States (US) and Europe (EU).
US
https://api.squadcast.com
EU
https://api.eu.squadcast.com
Authentication
In order to access the Organization-Scoped APIs, you need to use API key authentication. The API key can be passed as a Bearer token in the Authorization header.
Steps to procure an API key:
Log in to the Squadcast web application.
Navigate to Settings > API Tokens.
Create a new API token. This is the API key you'll use for authentication. Important: The token will only be visible once after creation. Copy and store it securely, as it will be gone forever once you close the dialog or navigate away.
Pass the API key in the
Authorizationheader for all subsequent API requests.
Example — Using API Key
curl --location --request GET 'https://api.squadcast.com/v4/public/api-key' \
--header 'Authorization: Bearer YOUR_API_KEY'Access Control
Only users with the "API Tokens" permission can access, create, and delete Organization-Scoped APIs. API access controls are determined by the purpose and permissions of the token selected during token creation. Ensure your API token has the necessary permissions for the operations you intend to perform.
Last updated