List Commits

Signature verification object

The response will include a verification object that describes the result of verifying the commit's signature. The following fields are included in the verification object:

Name	Type	Description
verified	boolean	Indicates whether GitHub considers the signature in this commit to be verified.
reason	string	The reason for verified value. Possible values and their meanings are enumerated in table below.
signature	string	The signature that was extracted from the commit.
payload	string	The value that was signed.

These are the possible values for reason in the verification object:

Value	Description
expired_key	The key that made the signature is expired.
not_signing_key	The "signing" flag is not among the usage flags in the GPG key that made the signature.
gpgverify_error	There was an error communicating with the signature verification service.
gpgverify_unavailable	The signature verification service is currently unavailable.
unsigned	The object does not include a signature.
unknown_signature_type	A non-PGP signature was found in the commit.
no_user	No user was associated with the committer email address in the commit.
unverified_email	The committer email address in the commit was associated with a user, but the email address is not verified on her/his account.
bad_email	The committer email address in the commit is not included in the identities of the PGP key that made the signature.
unknown_key	The key that made the signature has not been registered with any user's account.
malformed_signature	There was an error parsing the signature.
invalid	The signature could not be cryptographically verified using the key whose key-id was found in the signature.
valid	None of the above errors applied, so the signature is considered to be verified.

External Documentation

To learn more, visit the GitHub documentation.

Parameters

Parameter	Description
Author	GitHub login or email address by which to filter by commit author.
End Time	Only commits before this date will be returned.
Owner	The organization or person who owns the repository. github.com/{owner}/{repo}
Page	Page number of the results to fetch.
Path Contains	Only commits containing this file path will be returned.
Per Page	The number of results per page (max 100).
Repo	Name of the repository owned by the owner. github.com/{owner}/{repo}
Return All Pages	Automatically fetch all resources, page by page.
SHA Contains	SHA or branch to start listing commits from. Default: the repository’s default branch (usually master).
Start Time	Only show notifications updated after the given time.

Example Output

{
    "value": [
        {
            "author": {
                "avatar_url": "https://github.com/images/error/octocat_happy.gif",
                "events_url": "https://api.github.com/users/octocat/events{/privacy}",
                "followers_url": "https://api.github.com/users/octocat/followers",
                "following_url": "https://api.github.com/users/octocat/following{/other_user}",
                "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
                "gravatar_id": "",
                "html_url": "https://github.com/octocat",
                "id": 1,
                "login": "octocat",
                "node_id": "MDQ6VXNlcjE=",
                "organizations_url": "https://api.github.com/users/octocat/orgs",
                "received_events_url": "https://api.github.com/users/octocat/received_events",
                "repos_url": "https://api.github.com/users/octocat/repos",
                "site_admin": false,
                "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
                "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
                "type": "User",
                "url": "https://api.github.com/users/octocat"
            },
            "comments_url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments",
            "commit": {
                "author": {
                    "date": "2011-04-14T16:00:49Z",
                    "email": "support@github.com",
                    "name": "Monalisa Octocat"
                },
                "comment_count": 0,
                "committer": {
                    "date": "2011-04-14T16:00:49Z",
                    "email": "support@github.com",
                    "name": "Monalisa Octocat"
                },
                "message": "Fix all the bugs",
                "tree": {
                    "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e",
                    "url": "https://api.github.com/repos/octocat/Hello-World/tree/6dcb09b5b57875f334f61aebed695e2e4193db5e"
                },
                "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e",
                "verification": {
                    "payload": null,
                    "reason": "unsigned",
                    "signature": null,
                    "verified": false
                }
            },
            "committer": {
                "avatar_url": "https://github.com/images/error/octocat_happy.gif",
                "events_url": "https://api.github.com/users/octocat/events{/privacy}",
                "followers_url": "https://api.github.com/users/octocat/followers",
                "following_url": "https://api.github.com/users/octocat/following{/other_user}",
                "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
                "gravatar_id": "",
                "html_url": "https://github.com/octocat",
                "id": 1,
                "login": "octocat",
                "node_id": "MDQ6VXNlcjE=",
                "organizations_url": "https://api.github.com/users/octocat/orgs",
                "received_events_url": "https://api.github.com/users/octocat/received_events",
                "repos_url": "https://api.github.com/users/octocat/repos",
                "site_admin": false,
                "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
                "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
                "type": "User",
                "url": "https://api.github.com/users/octocat"
            },
            "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e",
            "node_id": "MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==",
            "parents": [
                {
                    "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e",
                    "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e"
                }
            ],
            "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e",
            "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e"
        }
    ]
}

Automation Library Example

List Commits with Github and Send Results Via Email

Preview this Automation on desktop