curl -X GET 'https://api.github.com/repos/example-owner/example-repo/pages' \
  -H "Authorization: Bearer $GITHUB_TOKEN" \
  -H 'Accept: application/vnd.github+json' \
  -H 'X-GitHub-Api-Version: 2026-03-10'

# GET /repos/{owner}/{repo}/pages (GitHub API)
Base URL: https://api.github.com
Auth: Authorization; GitHub token; required.
Last verified: 2026-10-20

> Get a GitHub Pages site

## 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/repos/example-owner/example-repo/pages' \
  -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 |
| :--- | :--- | :--- | :--- | :--- |
| owner | path | string | Yes | The account owner of the repository. The name is not case sensitive. |
| repo | path | string | Yes | The name of the repository without the `.git` extension. The name is not case... |

## Response example
{"url":"https://api.github.com/repos/github/hello-world/pages","status":"built"}

---
Need an API key? Get one at https://github.com/settings/tokens

GET

GET /repos/{owner}/{repo}/pages — GitHub API

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

GitHub API

Get a GitHub Pages site

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
→ 199 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/repos/example-owner/example-repo/pages' \  -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
owner	path	string	Yes	The account owner of the repository. The name is not case sensitive.
repo	path	string	Yes	The name of the repository without the `.git` extension. The name is not case sensitive.

Response 200 OK

{
  "url": "https://api.github.com/repos/github/hello-world/pages",
  "status": "built",
  "cname": "example.com",
  "protected_domain_state": "pending",
  "pending_domain_unverified_at": "2026-09-03T00:00:00Z",
  "custom_404": false,
  "html_url": "https://example.com",
  "build_type": "legacy",
  "source": {
    "branch": "string",
    "path": "string"
  },
  "public": true,
  "https_certificate": {
    "state": "approved",
    "description": "Certificate is approved",
    "domains": [
      "example.com",
      "www.example.com"
    ],
    "expires_at": "2026-09-03"
  },
  "https_enforced": true
}

Get a free GitHub API key → sponsored

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