List a user's gists

GET/users/{username}/gists

Lists the named user's gists. By default only their public gists are returned. The user's own private and unlisted gists are included only when the caller IS that user AND their token holds the gist:read scope; any other caller (including the user with an unscoped token) sees public gists only.

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
`username`required	`string`	The user's username.

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)
`since`	`string <date-time>`	Only return gists updated at or after this RFC 3339 timestamp.

Responses

Status	Body	Description
`200`	`GistSimple`[]	A list of the user's gists.
	Headers:`LinkX-PageX-Per-PageX-TotalX-Total-Pages`
`400`	`Error`	The request was malformed.
`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/users/{username}/gists?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"
  }
]