Get a resource
/v1/projects/{project}/resources/{resource} in the Resources API.
One resource with its place, when it has one.
| Field | Type | Notes |
|---|---|---|
kind | string | manual for a perk the creator hands over by hand, otherwise connector:kind as the connector directory lists each connector's resource_kinds (telegram:channel, telegram:group, telegram:supergroup). |
connector | string or null | The connector key the place is on; null for a manual perk. |
space | object or null | The place the resource is bound to: its id, the platform's own external_id and its title as the connector last read it. null for a manual perk and for a place-kind resource that was unlinked. |
title | string | The resource's name on plan cards; for a linked place, the place's title at link time. |
description | string or null | Up to 1,000 characters of well-formed HTML, shown as a perk beside the title. |
active | boolean | Whether plans grant it right now. An inactive resource keeps its link and its plans, but new members do not receive it. |
A manual perk reads { "kind": "manual", "connector": null, "space": null, … }.
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.
uuidThe resource, resolved within the project by the route binder.
uuidResponses
200OKapplication/json
The resource.
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