Skip to main content
GET
Get a repository wiki
This endpoint is rate limited. Each call counts toward your daily request limit.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>. The token may be a Sourcebot API key, OAuth access token, or scoped access token, subject to endpoint requirements.

Query Parameters

repo
string
required

The fully-qualified repository name.

Response

Whether the repository has a wiki, with a link when it does.

exists
boolean
required

Whether the repository has a wiki with at least one doc.

docCount
integer
required

The number of docs in the wiki, including its README overview.

url
string

The wiki's home page in the Sourcebot web app. Omitted when exists is false.

lastUpdatedAt
string

When a scan last updated the wiki, in ISO 8601. A scan updates each doc it checks against the code, even when the doc's text stays the same. Omitted when no scan has updated a doc.

lastUpdatedCommit
string

The SHA of the repository's commit that the wiki was last updated against. Present when lastUpdatedAt is.