In this guide

Get a Repository

Everything about one repository: stars, language, default branch, licence.

Action referenceRead

What this action does #

First, connect GitHub in Services. Then open Actions → + → GitHub and choose Get a Repository.

More about this action

Works on any public repository, and on private ones the token was granted.

Subscribers, forks and open issues are counted as of the moment of the call. Open Issues includes open pull requests, because GitHub counts a pull request as an issue everywhere.

Inputs to fill in #

Open an input to choose its value. Keep a fixed value with Text, receive it from Shortcuts, ask when the action runs, or use an Earlier Step. Read how input sources work.

Owner

RequiredText

User or organisation.

This input offers a picker for repository from your connected account. You can also supply its value directly.

Example value (replace with your own):
swiftlang

Repository

RequiredText

Name only, without the owner and without .git.

This input offers a picker for repository from your connected account. You can also supply its value directly.

Example value (replace with your own):
swift

What comes back #

In the action editor, open Output → Returned Value to choose fields for your shortcut. These are the response fields described by the app; a service may omit an optional field or return an empty list. JSON File contains the full response.

Returned fieldTypeMeaning
idintegerWhole-number value.
namestringWithout the owner.
full_namestringowner/repo.
descriptionstringNull when unset.
html_urlstringThe repository page.
clone_urlstringHTTPS clone URL.
ssh_urlstringText value.
homepagestringText value.
privatebooleanTrue or false.
visibilitystringpublic, private or internal.
forkbooleanTrue or false.
archivedbooleanArchived repositories are read-only.
disabledbooleanTrue or false.
default_branchstringUsually main.
languagestringThe most-used language, or null.
topicsarrayTopic strings.
sizeintegerKilobytes.
stargazers_countintegerWhole-number value.
watchers_countintegerA copy of the star count, not watchers.
forks_countintegerWhole-number value.
open_issues_countintegerOpen issues plus open pull requests.
has_issuesbooleanFalse means issues are turned off.
created_atstringISO 8601.
updated_atstringText value.
pushed_atstringLast push to any branch.
ownerobjectA group of named values.
owner.loginstringUsername.
owner.idintegerWhole-number value.
owner.html_urlstringTheir profile page.
owner.avatar_urlstringText value.
owner.typestringUser, Organization or Bot.
licenseobjectNull when the repository has no licence file.
license.keystringmit, apache-2.0, …
license.namestringText value.
license.spdx_idstringText value.
permissionsobjectWhat this token may do here.
permissions.adminbooleanTrue or false.
permissions.pushbooleanWrite access.
permissions.pullbooleanRead access.
subscribers_countintegerWatchers, properly counted.
network_countintegerSize of the fork network.
parentobjectPresent only on a fork.
parent.full_namestringText value.
parent.html_urlstringText value.

Run it from Shortcuts #

  1. Give the action a recognizable name and tap Save.
  2. In Apple Shortcuts, add Shortcutify’s Execute Action and select the saved action.
  3. Supply any Param or File slots you bound in the inputs, then run the shortcut.

If the result is unexpected, open Logs in Shortcutify, select the run, and inspect this step’s inputs and response.

Advanced reference #

Request, permissions, and identifiers

Request: GET https://api.github.com/repos/{owner}/{repo}

Action identifier: github.repos.get.v1

Permissions declared for this action: metadata:read. The account’s own access rules also apply.

InputRequest keyLocation
Ownerownerpath
Repositoryrepopath

GitHub API reference