Get a gist at a revision

GET/gists/{uuid}/{sha}

Returns a gist as it stood at the given commit SHA, with the same shape as GET /gists/{uuid}.

Visibility rules match the gist endpoint: public and unlisted gists are readable by anyone; a private gist resolves only for its owner with a gist:read-capable token, otherwise 404. An unknown revision also returns 404 so the gist's commit history is not disclosed.

Request

Headers

Name	Type	Scopes
Authorizationoptional	string

Path parameters

Name	Type	Description
uuidrequired	string	The gist's UUID.
sharequired	string	A full or partial commit SHA (hex, 4–40 characters). (pattern: ^[0-9a-fA-F]{4,40}$)

Responses

Status	Body	Description
200	Gist	The gist at the requested revision.
400	Error	The request was malformed.
404	Error	The requested resource does not exist (or is not visible to the caller).

Request

curl -X GET \
  --url "https://opengist.example.com/api/gists/{uuid}/{sha}" \
  -H "Authorization: Bearer og_xxxxxxxx"

Response 200

{
  "id": "string",
  "slug_url": "string",
  "owner": {
    "id": 1,
    "login": "string",
    "username": "string",
    "avatar_url": "https://opengist.example/...",
    "type": "string",
    "created_at": "2024-01-01T00:00:00Z"
  },
  "title": "string",
  "html_url": "https://opengist.example/...",
  "description": "string",
  "public": true,
  "visibility": "public",
  "like_count": 1,
  "fork_count": 1,
  "clone_url": "https://opengist.example/...",
  "ssh_url": "string",
  "topics": [
    "string"
  ],
  "created_at": "2024-01-01T00:00:00Z",
  "updated_at": "2024-01-01T00:00:00Z",
  "fork_of": {
    "id": "string",
    "slug_url": "string",
    "owner": {
      "id": 1,
      "login": "string",
      "username": "string",
      "avatar_url": "https://opengist.example/...",
      "type": "string",
      "created_at": "2024-01-01T00:00:00Z"
    },
    "title": "string",
    "html_url": "https://opengist.example/...",
    "description": "string",
    "public": true,
    "visibility": "public",
    "like_count": 1,
    "fork_count": 1,
    "clone_url": "https://opengist.example/...",
    "ssh_url": "string",
    "topics": [
      "string"
    ],
    "created_at": "2024-01-01T00:00:00Z",
    "updated_at": "2024-01-01T00:00:00Z"
  },
  "forks": [
    {
      "id": "string",
      "slug_url": "string",
      "owner": {
        "id": 1,
        "login": "string",
        "username": "string",
        "avatar_url": "https://opengist.example/...",
        "type": "string",
        "created_at": "2024-01-01T00:00:00Z"
      },
      "title": "string",
      "html_url": "https://opengist.example/...",
      "description": "string",
      "public": true,
      "visibility": "public",
      "like_count": 1,
      "fork_count": 1,
      "clone_url": "https://opengist.example/...",
      "ssh_url": "string",
      "topics": [
        "string"
      ],
      "created_at": "2024-01-01T00:00:00Z",
      "updated_at": "2024-01-01T00:00:00Z"
    }
  ],
  "files": {
    "<key>": {
      "filename": "string",
      "type": "string",
      "language": "string",
      "size": 1,
      "truncated": true,
      "content": "string",
      "encoding": "string"
    }
  },
  "commits": [
    {
      "version": "string",
      "author": {
        "name": "string",
        "email": "string"
      },
      "user": {
        "id": 1,
        "login": "string",
        "username": "string",
        "avatar_url": "https://opengist.example/...",
        "type": "string",
        "created_at": "2024-01-01T00:00:00Z"
      },
      "change_status": {
        "files_changed": 1,
        "additions": 1,
        "deletions": 1,
        "total": 1
      },
      "committed_at": "2024-01-01T00:00:00Z"
    }
  ],
  "truncated": true
}