---
title: "Get a resource"
method: GET
path: "/v1/projects/{project}/resources/{resource}"
tags: ["Resources"]
---

# Get a resource

`GET /v1/projects/{project}/resources/{resource}`

## Request

- Base URL: `https://api.subscriby.net`
- URL: `https://api.subscriby.net/v1/projects/{project}/resources/{resource}`
- Auth: HTTP bearer

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](https://docs.subscriby.net/api/v1/reference/connectors) 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, … }`.

## Path parameters

- `project` string, uuid, required
- `resource` string, uuid, required

## Response `200`

The resource.

- object
  - `data` ResourceResource, required: A resource a project sells access to: a place a connector gates, or a manual perk the creator hands over by hand.
    - `id` string, required: The resource's id.
    - `project_id` string, required: The project the resource belongs to.
    - `kind` string, required: `manual` for a perk the creator hands over by hand, otherwise `connector:kind` as the connector directory lists each connector's `resource_kinds`.
    - `connector` string, nullable, required: The connector key the place is on; null for a manual perk.
    - `space` object, nullable, required: The place the resource is bound to. Null for a manual perk and for a place-kind resource that was unlinked.
      - `id` string, required: The space's id.
      - `external_id` string, required: The platform's own id for the place.
      - `title` string, nullable, required: The place's title as the connector last read it.
    - `title` string, required: The resource's name on plan cards; for a linked place, the place's title at link time.
    - `description` string, nullable, required: Up to 1,000 characters of well-formed HTML, shown as a perk beside the title; null when none.
    - `active` boolean, required: Whether plans grant it right now. An inactive resource keeps its link and its plans, but new members do not receive it.
    - `created_at` string, nullable, required: When the resource was created, ISO 8601.
    - `updated_at` string, nullable, required: When the resource last changed, ISO 8601.

## Other responses

- `401`: `AUTHENTICATION_REQUIRED`: the request carries no bearer token, or one that is revoked, malformed, or minted for another environment (an `sbt_test_` token on production).
- `403`: `TOKEN_MISSING_ABILITY`: 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.
- `404`: `RESOURCE_NOT_FOUND`: 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.
- `429`: `RATE_LIMITED`: the token has spent its 300 requests a minute or 10,000 an hour; `Retry-After` says when the next one is accepted.

---

[API](https://skmtc.dev/memberpass/apis/subscriby-rest-api.md) · [All operations](https://skmtc.dev/memberpass/apis/subscriby-rest-api/llms.txt) · [OpenAPI document](https://skmtc.dev/memberpass/apis/subscriby-rest-api/revisions/59c4df91d764?raw)