> For the complete documentation index, see [llms.txt](https://developers.incidents.cloud.solarwinds.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developers.incidents.cloud.solarwinds.com/org-scoped-api-reference/overview.md).

# 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).

| Service Region | API Endpoints                  |
| -------------- | ------------------------------ |
| 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:

1. Log in to the Squadcast web application.
2. Navigate to Settings > API Tokens.
3. 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.
4. Pass the API key in the `Authorization` header for all subsequent API requests.

**Example — Using API Key**

```bash
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.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://developers.incidents.cloud.solarwinds.com/org-scoped-api-reference/overview.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.