agent-automations

List automations for user

Changed on

Returns automations whose created_by user is the authenticated caller, across repositories the caller can read. This includes both user-owned and repository-owned automations created by the caller but excludes repository-owned automations created by someone else even if the caller has write access to the repository.

Use the repository-scoped list operation for those automations. The owner_type filter only narrows this creator-scoped collection.

Fine-grained access tokens for "List automations for user"

This endpoint works with the following fine-grained token types:

The fine-grained token must have one of the following permission sets for each repository accessed by this request:

  • "Agent tasks" repository permissions (read)
  • "Contents" repository permissions (read)

The required permission set depends on each repository's Automation permission configuration.

GitHub App installation access tokens are not supported for this endpoint.

get/agents/automations

Request

  • Base URL: https://api.github.com
  • URL: https://api.github.com/agents/automations
  • Auth: none declared

Query parameters

pageinteger

The page number of the results to fetch.

per_pageinteger

The number of results per page (max 100).

owner_type'user' | 'repository'

Filter automations by owner type. user returns automations owned by their creator, repository returns automations owned by the repository. Omit to return both.

Response

Automations retrieved successfully

idstring required

The unique identifier of the automation.

namestring required

The name of the automation.

enabledboolean

Whether the automation is currently enabled.

owner_type'user' | 'repository'

Who owns the automation. user keeps it private to its creator and its runs act as that user. repository makes it belong to the repository, visible to anyone with read access to the repository, and its runs act as the Copilot app rather than as a person.

write_scope'trigger' | 'repository'

Controls which repository resources a run may modify. trigger limits writes to the resource that started the run, when one exists, and resources created during the run; repository allows writes to any resource in the repository. Supported values: trigger, repository.

require_actor_write_permissionboolean

When true, event-triggered runs require the event actor to have repo write permission, even when the org's allow_read_access_triggers policy is enabled. Does not apply to interval-scheduled runs, which always run as the automation owner.

modelstring

The model to use for sessions triggered by this automation. Omit to use the platform default.

reasoning_effortstring

The reasoning effort to use for sessions triggered by this automation. Omit or leave empty for no override. Currently supported values: none, low, medium, high, xhigh, max

created_atstring date-time required

When the automation was created.

updated_atstring date-time required

When the automation was last updated.

Changes