List a gist's forks

GET/gists/{uuid}/forks

Lists the gists that fork the targeted gist, filtered to what the caller may see: public forks plus the caller's own private/unlisted forks. Anonymous callers see public forks only.

The targeted gist follows the usual visibility rules: a private gist resolves only for its owner with a gist:read-capable token, otherwise 404.

Results are a JSON array; pagination is conveyed via the Link and X-* response headers (see the response headers below).

Request

Headers

Name	Type	Scopes
`Authorization`optional	`string`

Path parameters

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

Query parameters

Name	Type	Description
`page`	`integer`	Page number, 1-based. (default: 1, min: 1)
`per_page`	`integer`	Items per page. (default: 30, min: 1, max: 100)

Responses

Status	Body	Description
`200`	`GistSimple`[]	A list of forks.
	Headers:`LinkX-PageX-Per-PageX-TotalX-Total-Pages`
`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}/forks?page=1&per_page=30" \
  -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"
  }
]