Docs
⌘K
Account, keys and webhooks ›

Get git hub connection

GET/v1/github

Get git hub connection.

Requestcurl
  1. curl https://agental.io/v1/github \
  2. -H "Authorization: Bearer $AGENTAL_API_KEY"
Answer200 OK · GitHubConnection
  1. {
  2. "available": boolean,
  3. "installations": [{
  4. "installationId": integer,
  5. "account": string,
  6. "accountType": string,
  7. "connectedAt": string,
  8. "repositorySelection": "all" | "selected" | "null" | null,
  9. "repositories": string[] | null,
  10. … 1 more
  11. }],
  12. }

Whether GitHub can be connected here, and the installations of the App connected to the organization.

Headers

Authorizationrequired
Bearer key
An API key that may make this call.

Returns

200 Whether GitHub can be connected here, and the installations of the App connected to the organization.

GitHubConnection2 fields
available
boolean
installations
GitHubInstallation[]7 fields
installationId
integer
account
string
The GitHub user or organization the App is installed on.
accountType
string
User or Organization.
connectedAt
string
repositorySelection
allselectednullnull
Whether the App may use all the account's repositories or those chosen.
More Null where GitHub did not say.
repositories
string[]null
The repositories the App may use, by full name.
More Null where GitHub did not say.
manageUrl
string
Where on GitHub the repositories it may use are changed, or the App uninstalled.

Errors and other answers

403 session_required, or
403forbidden only an owner or an admin of the organization.

Every error answers { "error": { "code", "message" } }; a key without the action a call needs answers 403 key_action_forbidden, naming it.

← Update data retentionBegin git hub connection →