GitHub: List organization secrets — codespaces codespaces List Org Secrets
GitHub codespaces.codespacesListOrgSecrets: arguments, response, policy and SDK examples.
← Codespaces operations · Get started
Operation github.codespaces_list_org_secrets
Provider route: GET /orgs/{org}/codespaces/secrets. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “Call through Alter”Install @alter-ai/sdk @alter-ai/github with npm, or alter-sdk-github with pip. Supply your connected customer’s grant ID and the arguments described below.
import { App } from "@alter-ai/sdk";import { GitHubIntegration } from "@alter-ai/github";
async function execute(input: Parameters<GitHubIntegration["codespaces"]["codespacesListOrgSecrets"]>[0]) { const app = new App({ apiKey: process.env.ALTER_API_KEY! }); try { const provider = new GitHubIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! }); const call = await provider.codespaces.codespacesListOrgSecrets(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom alter_sdk_github import GitHubIntegration
async def execute(arguments): async with App(api_key=os.environ["ALTER_API_KEY"]) as app: provider = GitHubIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]}) call = await provider.codespaces.codespaces_list_org_secrets(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.org | string | Required within parent | |
query | object | Optional | Additional keys: not allowed |
query.per_page | integer | Optional | Default: 30 |
query.page | integer | Optional | Default: 1 |
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
secrets | array | Required within parent | |
secrets[] | Model | Each item | Expand Get an organization secret — codespaces codespaces Get Org Secret — response body |
total_count | JSON | Required within parent | |
total_count (anyOf 1) | integer | Alternative | |
total_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Referenced models: Get an organization secret — codespaces codespaces Get Org Secret — response body
Schemas
Section titled “Schemas”Get an organization secret — codespaces codespaces Get Org Secret — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Secrets for a GitHub Codespace. |
created_at | string | Required within parent | The date and time at which the secret was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. Format: date-time |
name | string | Required within parent | The name of the secret |
selected_repositories_url | string | Optional | The API URL at which the list of repositories this secret is visible to can be retrieved Format: uri |
updated_at | string | Required within parent | The date and time at which the secret was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. Format: date-time |
visibility | string | Required within parent | The type of repositories in the organization that the secret is visible to Known values: all, private, selected |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: github.codespaces_list_org_secrets. Catalog operation: codespaces/list-org-secrets. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.
Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.
Pinned headers: {"X-GitHub-Api-Version": "2026-03-10", "User-Agent": "Alter", "Accept": "application/vnd.github+json"}