Skip to content
Talk to an Engineer Dashboard

Github

GitHub is a cloud-based Git repository hosting service that allows developers to store, manage, and track changes to their code.

GitHub is a cloud-based Git repository hosting service that allows developers to store, manage, and track changes to their code.

Github logo

Supports authentication: OAuth 2.0

Get the contents of a file or directory from a GitHub repository. Returns Base64 encoded content for files.

NameTypeRequiredDescription
ownerstringYesThe account owner of the repository
pathstringYesThe content path (file or directory path in the repository)
refstringNoThe name of the commit/branch/tag
repostringYesThe name of the repository

Create a new file or update an existing file in a GitHub repository. Content must be Base64 encoded. Requires SHA when updating existing files.

NameTypeRequiredDescription
authorobjectNoAuthor information object with name and email
branchstringNoThe branch name
committerobjectNoCommitter information object with name and email
contentstringYesThe new file content (Base64 encoded)
messagestringYesThe commit message for this change
ownerstringYesThe account owner of the repository
pathstringYesThe file path in the repository
repostringYesThe name of the repository
shastringNoThe blob SHA of the file being replaced (required when updating existing files)

Create a new issue in a repository. Requires push access to set assignees, milestones, and labels.

NameTypeRequiredDescription
assigneesarray<string>NoGitHub usernames to assign to the issue
bodystringNoThe contents of the issue
labelsarray<string>NoLabels to associate with the issue
milestonenumberNoMilestone number to associate with the issue
ownerstringYesThe account owner of the repository
repostringYesThe name of the repository
titlestringYesThe title of the issue
typestringNoThe name of the issue type

List issues in a repository. Both issues and pull requests are returned as issues in the GitHub API.

NameTypeRequiredDescription
assigneestringNoFilter by assigned user
creatorstringNoFilter by issue creator
directionstringNoSort order
labelsstringNoFilter by comma-separated list of label names
milestonestringNoFilter by milestone number or state
ownerstringYesThe account owner of the repository
pagenumberNoPage number of results to fetch
per_pagenumberNoNumber of results per page (max 100)
repostringYesThe name of the repository
sincestringNoShow issues updated after this timestamp (ISO 8601 format)
sortstringNoProperty to sort issues by
statestringNoFilter by issue state

List public repositories for a specified user. Does not require authentication.

NameTypeRequiredDescription
directionstringNoSort order
pagenumberNoPage number of results to fetch
per_pagenumberNoNumber of results per page (max 100)
sortstringNoProperty to sort repositories by
typestringNoFilter repositories by type
usernamestringYesThe GitHub username to list repositories for

Create a new pull request in a repository. Requires write access to the head branch.

NameTypeRequiredDescription
basestringYesThe name of the branch you want the changes pulled into
bodystringNoThe contents of the pull request description
draftbooleanNoIndicates whether the pull request is a draft
headstringYesThe name of the branch where your changes are implemented (format: user:branch)
maintainer_can_modifybooleanNoIndicates whether maintainers can modify the pull request
ownerstringYesThe account owner of the repository
repostringYesThe name of the repository
titlestringNoThe title of the pull request

List pull requests in a repository with optional filtering by state, head, and base branches.

NameTypeRequiredDescription
basestringNoFilter by base branch name
directionstringNoSort order
headstringNoFilter by head branch (format: user:ref-name)
ownerstringYesThe account owner of the repository
pagenumberNoPage number of results to fetch
per_pagenumberNoNumber of results per page (max 100)
repostringYesThe name of the repository
sortstringNoProperty to sort pull requests by
statestringNoFilter by pull request state

Get detailed information about a GitHub repository including metadata, settings, and statistics.

NameTypeRequiredDescription
ownerstringYesThe account owner of the repository (case-insensitive)
repostringYesThe name of the repository without the .git extension (case-insensitive)

List repositories for the authenticated user. Requires authentication.

NameTypeRequiredDescription
directionstringNoSort order
pagenumberNoPage number of results to fetch
per_pagenumberNoNumber of results per page (max 100)
sortstringNoProperty to sort repositories by
typestringNoFilter repositories by type