board-github

POST `/v1/board-github/discover`

List the GitHub Projects a credential can see.

Pengesahan

Hantar kunci API sebagai token pembawa. Titik akhir ini tidak menyatakan kebenaran tertentu dalam spesifikasi, jadi berikan kunci anda kebenaran minimum yang diperlukan dan semak respons tersebut daripada membuat andaian.

Tempat ID organisasi anda diletakkan

Titik akhir ini mengambil org_id sebagai medan dalam kandungan JSON.

ID organisasi anda terletak pada skrin kekunci API dalam papan pemuka anda, di sebelah kekunci itu sendiri. Ia adalah ID yang sama dalam setiap panggilan yang anda buat.

Cuba

Gantikan apa sahaja di dalam kurungan sudut dengan nilai anda sendiri, dan pemegang tempat kunci dengan kunci dari papan pemuka anda.

curl -X POST https://api.zinndigital.com/v1/board-github/discover \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "owner_login": <string> }'

Sudah log masuk? Konsol API dalam papan pemuka anda mengisi id organisasi sebenar dan kunci anda sendiri, serta menjalankan permintaan terhadap API langsung supaya anda boleh melihat respons sebenar. Buka penamat ini dalam konsol API

Butiran

Asked before anything is linked, so the customer picks a project from a list rather than pasting a node id. Reads **both** owner shapes — GitHub's `organization` query returns null for a user login and `user` returns null for an org login, so a single-shape read would answer "no projects" for half of all customers with no error anywhere. `count` is returned beside `projects` deliberately: an owner with genuinely no projects and a credential that cannot *see* any would otherwise be the same empty array.

Badan permintaan

Nama	Jenis	Diperlukan	Apakah ia
`owner_login`	`string`	Ya	—
`auth_kind`	`GitHubAuthKind`	Tidak	`app` is the Zinn® GitHub App installation — per-repository scope the customer chooses on GitHub's own screen, revocable by them in one click, belonging to their organisation ra…
`installation_id`	`string`	Tidak	—
`token`	`string`	Tidak	A fine-grained token, for `auth_kind: pat`. Write-only and never echoed — a response carrying it would put a live GitHub credential in the browser's network tab and in any log t…
`org_id`	`string`	Tidak	—

Respons

Nama	Jenis	Diperlukan	Apakah ia
`owner_login`	`string`	Tidak	—
`count`	`integer`	Tidak	Returned beside the list on purpose. An owner with genuinely no projects and a credential that cannot see any would otherwise be the same empty array.
`projects`	`GitHubProjectSummary[]`	Tidak	—

Ralat yang boleh dikembalikan oleh titik akhir ini

401 · 403 · 422