Get a gist

GET/gists/{uuid}

Returns a single gist with its file contents, commits and forks.

Public and unlisted gists are readable by anyone, including anonymous callers. A private gist resolves only for its owner using a token with the gist:read scope; every other caller receives 404 so the gist's existence is not revealed.

Request

Headers

Name	Type	Scopes
`Authorization`optional	`string`

Path parameters

Name	Type	Description
`uuid`required	`string`	The gist's UUID.

Responses

Status	Body	Description
`200`	`Gist`	The gist.
`404`	`Error`	The requested resource does not exist (or is not visible to the caller).

Request

bash

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

Response 200

json

{
  "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
}