Hanzo
OpenapiProjects

Returns every project your org owns.

Returns every project your org owns. Each row carries the slug, name, framework, visibility, status and live URL — the same rows console and the builder…

GET /v1/projects

Addresshttps://api.hanzo.ai/v1/projects
MethodGET
Operationget_projects
AuthAuthorization: Bearer $HANZO_API_KEY

Returns every project your org owns.

Each row carries the slug, name, framework, visibility, status and live URL — the same rows console and the builder render, because there is only one store behind both. It requires a validated principal (403 without one) and is keyed by that principal's org, so it never contains another tenant's project.

Request

GET /v1/projects takes no parameters and no body — the credential is the whole request.

Response

StatusBodyMeaning
200projectsProject[]ok

200 body — 30 fields.

FieldInTypeAlwaysDescription
[].analyticsbodybooleanAnalytics is whether the web-analytics beacon is injected into this site's pages.
[].bucketbodystringBucket is the object-store bucket the site's files are served out of.
[].cacheControlbodystringCacheControl is the Cache-Control policy the edge serves this site's HTML under — how long a reader may hold a stale page before asking again.
[].createdAtbodyintegerCreatedAt is when the project was created, as Unix seconds.
[].currentDeploymentIdbodystringCurrentDeploymentID names the deployment currently serving, so a caller can ask what is live without scanning the history.
[].descriptionbodystringDescription is the one-line summary, which is copied onto forks of this project and shown on a gallery card.
[].forkedFrombodystringForkedFrom is the parent this project was forked from ("<org>/<slug>" of a published project, or a catalog template slug) — the attribution edge a gallery…
[].frameworkbodystringFramework is a BUILD HINT from a closed set, defaulting to static.
[].hiddenbodybooleanHidden is PLATFORM MODERATION, and it is a different axis from visibility: it pulls a public project out of the catalogue without editing the publisher's own…
[].hiddenReasonbodystringHiddenReason is why moderation hid it.
[].idbodystringID is the project's internal identifier.
[].keybodystringKey is the project's publishable ingest key, minted at create.
[].lastPurgeAtbodyintegerLastPurgeAt is when the edge cache was last cleared, as Unix seconds, so a console can say how fresh what readers see actually is.
[].licensebodystringLicense is the terms that upstream work carries.
[].liveUrlbodystringLiveURL is where the site answers today.
[].namebodystringName is the project's display name, free text a person chose.
[].orgbodystringOrg is the organisation that owns the project, and therefore who pays for it and who may change it.
[].repobodyprojectsRepo
[].repo.branchbodystringBranch is the ref a push has to touch for this project to rebuild.
[].repo.providerbodystringProvider is the forge the URL was recognised as — it decides which webhook and which credential reach the repository, and is DERIVED from the URL rather than…
[].repo.urlbodystringURL is the clone address of the repository this project builds from.
[].slugbodystringSlug is the identifier that MATTERS: the handle every later call addresses, the S3 key segment the site's objects live under, and the label of the public host…
[].spacebodystringSpace is the project's Base data space, which is where a deployed site's form, forum and data submissions land.
[].starredbodybooleanStarred is THIS CALLER's star, not a property of the project — two people in the same org see different values for the same row, which is the whole point of…
[].statusbodystringStatus is where the project stands — whether a build has ever succeeded and whether anything is serving right now.
[].tagsbodyobjectTags is the site's browser tag config: platform slug → non-secret pixel id (GA measurement, Meta pixel, …) — what track.js injects and the server CAPI reads,…
[].tags.*bodystring
[].updatedAtbodyintegerUpdatedAt is when the project's own record last changed, as Unix seconds.
[].upstreambodystringUpstream credits the third-party work this project was published from — a free-text line, because the honest answer is a name and a title that no enum could…
[].visibilitybodystringVisibility is "public" or "private", and Hidden reports platform moderation.

Failure carries the platform error shape — see Errors.

Examples

hanzo projects list

Projects API · All Hanzo APIs · Interactive reference

How is this guide?

On this page