Organisations

Read a page of an installation's repositories

Reads one page of 100 repositories the installation can reach: ids, names, the default branch, private or not.

POST/orgs/{org}/github/installations/{id}/sync

TL;DR

Question	Answer
What does it do?	Read a page of an installation's repositories.
What does it take?	A JSON body of type `GithubSyncBody`.
What does it return?	Status 200 with a body of type `GithubSync`.
What can go wrong?	`400` the body is not valid; `401` not signed in; `403` a member may not (orgs.forbidden), the plan has no GitHub App (plan.github_app_not_included), or the request came from an origin that may not make changes; `404` no such organisation or linked installation (github.installation_not_found); `429` too many requests, or GitHub asked to wait (github.rate_limited); `502` GitHub could not be reached (github.unavailable); `503` the GitHub App is not set up on this server (github.not_configured), or organisations are not. Every failure uses the one error envelope.

What it does

Reads one page of 100 repositories the installation can reach: ids, names, the default branch, private or not. nextPage is the next page to ask for. The owner and an admin, on Pro and Enterprise.

Path parameters

Field	Type	Required	Description
`org`	`string`	yes	The organisation's id or its slug.
`id`	`string`	yes	GitHub's id.

Request body

The body has the type GithubSyncBody.

Field	Type	Required	Description
`page`	`integer`	no	minimum 1; maximum 10; default 1.

Responses

Status	Meaning	Body
200	The page was read.	`GithubSync`
400	The body is not valid.	`ErrorResponse`
401	Not signed in.	`ErrorResponse`
403	A member may not (orgs.forbidden), the plan has no GitHub App (plan.github_app_not_included), or the request came from an origin that may not make changes.	`ErrorResponse`
404	No such organisation or linked installation (github.installation_not_found).	`ErrorResponse`
429	Too many requests, or GitHub asked to wait (github.rate_limited).	`ErrorResponse`
502	GitHub could not be reached (github.unavailable).	`ErrorResponse`
503	The GitHub App is not set up on this server (github.not_configured), or organisations are not.	`ErrorResponse`

Response body

A 200 answer has the type GithubSync.

Field	Type	Required	Description
`synced`	`integer`	yes
`nextPage`	`integer \| null`	yes

Doc	Why
API reference	Every endpoint, and the error envelope
Schemas	Every request and response type
Tool reference	The operations as callable tools