apicheats.dev github/llms.txt Raw .md
GET

GET /agents/automations — GitHub API

GitHub token (required); https://api.github.com

GitHub API

List automations for user

Base URL
https://api.github.com
Auth
Authorization: Bearer <GITHUB_API_KEY>
Last verified
2026-10-20 · upstream hash matched
Actions Try in browser→
Agents: curl -H "Accept: text/markdown" this URL
→ 214 tokens · Vary: Accept

Critical gotchas

GitHub recommends an Accept: application/vnd.github+json header and an explicit X-GitHub-Api-Version header.

Fine-grained tokens only authorize repositories and permissions selected when the token is created.

cURL

curl -X GET 'https://api.github.com/agents/automations?page=1&per_page=30&owner_type=user' \  -H "Authorization: Bearer $GITHUB_TOKEN" \  -H 'Accept: application/vnd.github+json' \  -H 'X-GitHub-Api-Version: 2026-03-10'

Parameters

Name In Type Required Description
page query integer No The page number of the results to fetch.
per_page query integer No The number of results per page (max 100).
owner_type query string No Filter automations by owner type. `user` returns automations owned by their creator, `repository` returns automations owned by the repository. Omit to return both.

Response 200 OK

[
  {
    "id": "string",
    "repository": {
      "id": 0,
      "owner": "string",
      "name": "string"
    },
    "name": "string",
    "enabled": true,
    "owner_type": "user",
    "write_scope": "trigger",
    "require_actor_write_permission": false,
    "model": "string",
    "reasoning_effort": "string",
    "triggers": {
      "interval": {
        "cadence": [
          "hourly"
        ],
        "hour_utc": 0,
        "day_of_week": 0,
        "minute_utc": 0,
        "write_scope": "trigger"
      },
      "issue_opened": {
        "query": "string",
        "write_scope": "trigger"
      },
      "issue_labeled": {
        "query": "string",
        "labels": [
          "string"
        ],
        "write_scope": "trigger"
      },
      "workflow_run": {
        "workflows": [
          "string"
        ],
        "conclusions": [
          "failure"
        ],
        "query": "string",
        "write_scope": "trigger"
      },
      "pull_request_opened": {
        "query": "string",
        "paths": [
          "string"
        ],
        "write_scope": "trigger"
      },
      "pull_request_synchronize": {
        "query": "string",
        "paths": [
          "string"
        ],
        "write_scope": "trigger"
      },
      "pull_request_merged": {
        "query": "string",
        "paths": [
          "string"
        ],
        "write_scope": "trigger"
      },
      "issue_comment": {
        "body_substring": "string",
        "write_scope": "trigger"
      },
      "pull_request_comment": {
        "comment_types": [
          "timeline_comment"
        ],
        "body_substring": "string",
        "write_scope": "trigger"
      },
      "discussion_opened": {
        "categories": [
          "string"
        ],
        "body_substring": "string",
        "write_scope": "trigger"
      },
      "discussion_updated": {
        "categories": [
          "string"
        ],
        "body_substring": "string",
        "write_scope": "trigger"
      },
      "discussion_comment": {
        "comment_types": [
          "comment"
        ],
        "categories": [
          "string"
        ],
        "body_substring": "string",
        "write_scope": "trigger"
      },
      "issue_assigned": {
        "query": "string",
        "assignees": [
          "string"
        ],
        "write_scope": "trigger"
      },
      "pull_request_assigned": {
        "query": "string",
        "paths": [
          "string"
        ],
        "assignees": [
          "string"
        ],
        "write_scope": "trigger"
      },
      "sub_issue_added": {
        "query": "string",
        "write_scope": "trigger"
      },
      "pull_request_ready_for_review": {
        "query": "string",
        "paths": [
          "string"
        ],
        "write_scope": "trigger"
      },
      "pull_request_labeled": {
        "query": "string",
        "paths": [
          "string"
        ],
        "labels": [
          "string"
        ],
        "write_scope": "trigger"
      },
      "pull_request_merge_conflict": {
        "query": "string",
        "paths": [
          "string"
        ],
        "write_scope": "trigger"
      },
      "pull_request_review_submitted": {
        "query": "string",
        "paths": [
          "string"
        ],
        "states": [
          "approved"
        ],
        "write_scope": "trigger"
      },
      "pull_request_review_requested": {
        "query": "string",
        "paths": [
          "string"
        ],
        "write_scope": "trigger"
      },
      "automation_completed": {
        "automation_ids": [
          "string"
        ],
        "write_scope": "trigger"
      }
    },
    "created_at": "2026-09-03T00:00:00Z",
    "updated_at": "2026-09-03T00:00:00Z",
    "created_by": {
      "id": 0
    }
  }
]
Get a free GitHub API key → sponsored

Affiliate link - we may earn a commission, at no extra cost to you.