Get a project
/v1/projects/{project} in the Projects API.
One project. A project outside the token's team or its project scope is 404 RESOURCE_NOT_FOUND.
outage_compensations is the project's Outage Compensation switch, terms and privacy the URLs members are asked to accept, and banner_url / photo_url the hosted artwork (null until uploaded). storefront_arrangement says how the portal, the embed and the bot order the plans on offer: manual is the order pinned through Arrange the storefront order, with passes, seasons and then subscriptions, cheapest first, behind anything unpinned; live puts the passes and seasons whose access is on now first, the one ending soonest at the top, then those opening soonest, then everything else in the pinned order, so a creator selling dated passes never has to re-arrange. live needs the owner's time-limited passes capability (Growth, or the Passes Addon on any plan): setting it without one is refused with TEAM_TIER_REQUIRED, and when the capability lapses the storefronts fall back to the pinned order at once while the stored value is reset to manual with a project.updated event. A project has no platform field: it installs connectors, and the project's connectors list names them. Clients that read a type on projects before 5.0 must switch to the connectors list; the field is gone.
Requires ability
The token must hold this ability, or the call is refused with 403.
MCP tool
Runs the same action from an agent, behind the same ability.
Authorization
bearerToken A personal access token minted on the dashboard under Settings, then Tokens, sent as Authorization: Bearer sbt_live_…. The token carries the abilities each endpoint lists under Requires ability and is frozen to one team.
In: header
Path Parameters
The project, resolved by the route binder.
uuidResponses
200OKapplication/json
The project.
401UnauthorizedAUTHENTICATION_REQUIREDapplication/json
The request carries no bearer token, or one that is revoked, malformed, or minted for another environment (an sbt_test_ token on production).
403ForbiddenTOKEN_MISSING_ABILITYapplication/json
The token is valid but does not carry the ability this endpoint requires; error.context.required_ability names the one to grant. An endpoint that also checks who owns a row or which tier the account is on answers FORBIDDEN, TEAM_TIER_REQUIRED or CONNECTOR_TIER_REQUIRED with the same status, and says so in its own description.
404Not foundRESOURCE_NOT_FOUNDapplication/json
An id in the path names nothing the token can see. TENANT_MISMATCH: the project sits outside the token's scope:project: allow-list, or the token carries no team scope. Both answer 404 rather than 403 so that existence outside the token's scope cannot be inferred.
429Too many requestsRATE_LIMITEDapplication/json
The token has spent its 300 requests a minute or 10,000 an hour; Retry-After says when the next one is accepted.
How is this guide?
Last updated on