Resources

Get a resource

One resource with its place, when it has one.

FieldTypeNotes
kindstringmanual 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).
connectorstring or nullThe connector key the place is on; null for a manual perk.
spaceobject or nullThe 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.
titlestringThe resource's name on plan cards; for a linked place, the place's title at link time.
descriptionstring or nullUp to 1,000 characters of well-formed HTML, shown as a perk beside the title.
activebooleanWhether 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, … }.

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

Path parameters

projectstring uuid required

The project, resolved by the route binder.

resourcestring uuid required

The resource, resolved within the project by the route binder.

Response

The resource.

Example response

{
  "data": {
    "id": "b73c5f21-9d80-4a6e-8215-4f70ce13a9d6",
    "project_id": "7f3d1c92-8b45-4e6a-9d21-5c8e0a4b6f13",
    "kind": "telegram:channel",
    "connector": "telegram",
    "space": {
      "id": "3c1f7a58-2b6e-4d90-8f41-6a2e9c5d7b10",
      "external_id": "-1001234567890",
      "title": "Research Premium Lounge"
    },
    "title": "Research Premium Lounge",
    "description": "Daily research notes and the members-only Q&A.",
    "active": true,
    "created_at": "2026-05-18T10:05:00Z",
    "updated_at": "2026-05-18T10:05:00Z"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.