GitHub: Get a concurrency group for a repository

GitHub actions.actionsGetConcurrencyGroupForRepository: arguments, response, policy and SDK examples.

Operation github.actions_get_concurrency_group_for_repository

Provider route: GET /repos/{owner}/{repo}/actions/concurrency_groups/{concurrency_group_name}. Alter supplies the connection’s credentials and routing.

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["actions"]["actionsGetConcurrencyGroupForRepository"]>[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.actions.actionsGetConcurrencyGroupForRepository(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from 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.actions.actions_get_concurrency_group_for_repository(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
`$`	object	Root	Additional keys: not allowed
`path`	object	Required within parent	Additional keys: not allowed
`path.owner`	string	Required within parent
`path.repo`	string	Required within parent
`path.concurrency_group_name`	string	Required within parent
`query`	object	Optional	Additional keys: not allowed
`query.ahead_of_run`	integer	Optional	Minimum: 1
`query.ahead_of_job`	integer	Optional	Minimum: 1

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
`$`	Model	Root	Expand Get a concurrency group for a repository — response body

Referenced models: Get a concurrency group for a repository — response body

Schemas

Get a concurrency group for a repository — response body

Field	Type	Presence	Description and constraints
`$`	object	Root	A concurrency group with the workflow runs and jobs that are either currently holding or waiting for the concurrency group lease.
`group_members`	array	Required within parent
`group_members[]`	object	Each item
`group_members[].job_html_url`	JSON	Optional
`group_members[].job_html_url (anyOf 1)`	string	Alternative	Web URL for the job. Format: uri
`group_members[].job_html_url (anyOf 2)`	null	Alternative
`group_members[].job_id`	JSON	Optional
`group_members[].job_id (anyOf 1)`	integer	Alternative	The ID of the job, when the item represents a job-level or reusable-workflow-level lease.
`group_members[].job_id (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`group_members[].job_name`	string	Optional	The display name of the job, when the item represents a job-level or reusable-workflow-level lease.
`group_members[].job_url`	JSON	Optional
`group_members[].job_url (anyOf 1)`	string	Alternative	API URL for the job. Format: uri
`group_members[].job_url (anyOf 2)`	null	Alternative
`group_members[].run_html_url`	JSON	Required within parent
`group_members[].run_html_url (anyOf 1)`	string	Alternative	Web URL for the workflow run. Format: uri
`group_members[].run_html_url (anyOf 2)`	null	Alternative
`group_members[].run_id`	JSON	Required within parent
`group_members[].run_id (anyOf 1)`	integer	Alternative	The ID of the workflow run.
`group_members[].run_id (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`group_members[].run_name`	string	Required within parent	The name of the workflow run.
`group_members[].run_url`	JSON	Required within parent
`group_members[].run_url (anyOf 1)`	string	Alternative	API URL for the workflow run. Format: uri
`group_members[].run_url (anyOf 2)`	null	Alternative
`group_members[].status`	string	Required within parent	Known values: in_progress, pending
`group_name`	string	Required within parent	The name of the concurrency group.
`group_url`	string	Required within parent	API URL for this concurrency group. Format: uri
`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]+)?$

Policy, approvals and errors

SDK function policy ID: github.actions_get_concurrency_group_for_repository. Catalog operation: actions/get-concurrency-group-for-repository. 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"}

Official provider source

Report an issue with this page