Projects

Get a project

One project. A project outside the token's team or its project scope is 404 RESOURCE_NOT_FOUND.

metrics is the project's Enable Public Metrics switch, outage_compensations its Outage Compensation switch, terms and privacy the URLs members are asked to accept, and banner_url / photo_url the hosted artwork (null until uploaded). 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.

get/v1/projects/{project}

Request

  • Base URL: https://api.subscriby.net
  • URL: https://api.subscriby.net/v1/projects/{project}
  • Auth: HTTP bearer

Path parameters

projectstring uuid required

The project, resolved by the route binder.

Response

The project.

Example response

{
  "data": {
    "id": "7f3d1c92-8b45-4e6a-9d21-5c8e0a4b6f13",
    "team_id": "a83f0d51-4c92-4b7e-8615-2fd9e70a3c86",
    "user_id": "2a91c4e7-6f38-4b52-8e0d-9c1a7b3f5d80",
    "name": "Research Premium",
    "handle": "research-premium",
    "description": "Weekly deep-dive research notes.",
    "terms": "https://example.com/terms",
    "privacy": "https://example.com/privacy",
    "banner_url": "https://static.subscriby.net/projects/7f3d1c92/banner.webp",
    "photo_url": "https://static.subscriby.net/projects/7f3d1c92/photo.webp",
    "metrics": true,
    "outage_compensations": true,
    "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.