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:

NameTypeDescription
verifiedbooleanIndicates whether GitHub considers the signature in this commit to be verified.
reasonstringThe reason for verified value. Possible values and their meanings are enumerated in table below.
signaturestringThe signature that was extracted from the commit.
payloadstringThe value that was signed.

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

ValueDescription
expired_keyThe key that made the signature is expired.
not_signing_keyThe “signing” flag is not among the usage flags in the GPG key that made the signature.
gpgverify_errorThere was an error communicating with the signature verification service.
gpgverify_unavailableThe signature verification service is currently unavailable.
unsignedThe object does not include a signature.
unknown_signature_typeA non-PGP signature was found in the commit.
no_userNo user was associated with the committer email address in the commit.
unverified_emailThe committer email address in the commit was associated with a user, but the email address is not verified on her/his account.
bad_emailThe committer email address in the commit is not included in the identities of the PGP key that made the signature.
unknown_keyThe key that made the signature has not been registered with any user’s account.
malformed_signatureThere was an error parsing the signature.
invalidThe signature could not be cryptographically verified using the key whose key-id was found in the signature.
validNone of the above errors applied, so the signature is considered to be verified.

To learn more, visit the GitHub documentation.

​
Parameters​

ParameterDescription
AuthorGitHub login or email address by which to filter by commit author.
End TimeOnly commits before this date will be returned.
OwnerThe organization or person who owns the repository. github.com/{owner}/{repo}
PagePage number of the results to fetch.
Path ContainsOnly commits containing this file path will be returned.
Per PageThe number of results per page (max 100).
RepoName of the repository owned by the owner. github.com/{owner}/{repo}
Return All PagesAutomatically fetch all resources, page by page.
SHA ContainsSHA or branch to start listing commits from. Default: the repository’s default branch (usually master).
Start TimeOnly 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"        }    ]}

​
Workflow Library Example​

List Commits with Github and Send Results Via Email

Preview this Workflow on desktop

Was this page helpful?

List CollaboratorsList Org Members