API docs by Redocly

Startnext Crowdfunding API (1.0.0)

Download OpenAPI specification:

Public and Project API for Startnext crowdfunding platform

ProjectApiKey

Endpoints accessible with Project API Key (Bearer snx_proj_*)

List project incentives including hidden

Returns a paginated list of all incentives for a specific project, including hidden ones (status=hidden or hidden due to an unmet funding goal). Requires a Project API Key with the incentives:read scope, an end-user Bearer credential (OAuth Bearer or User API Key) with the project:read scope and the Starter/Manager/Team Member role, a System API Key, or an internal request. Use hidden_until_goal_reached and is_unlocked on each incentive to determine its visibility state.

Authorizations:
projectApiKeyuserApiKeyNoneNone
path Parameters
link_caption
required
string

Project URL slug

query Parameters
offset
integer
Default: 0

Result offset

limit
integer
Default: 20

Result limit (max 100)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Get project details

Returns full project details. Public (rate-limited, no authentication) from status started onwards — this is what the external project widget uses. A draft (new) or manager-only project requires an authorized viewer: a Project/System API Key, an end-user token (OAuth Bearer or User API Key with project:read) whose user is starter, team member or manager, a session with those roles, or a valid team-invitation token. Otherwise the endpoint answers 404 and does not reveal that the slug exists.

Authorizations:
NoneNoneprojectApiKeyuserApiKey
path Parameters
link_caption
required
string

Project URL slug

query Parameters
invitation
string

Team invitation token — unlocks a still-draft project for its invitee, mirroring the project page's own invitation-link access.

invitation_reconsider
string

Set to "1" when the invitee is reconsidering a previously declined invitation, matching ?invitation_reconsider=1 on the project page.

Responses

Response samples

Content type
application/json
{
  • "project": {
    },
  • "status": 0
}

List project subscribers

Returns all subscribers (fans) for a project. Requires a Project API Key with the subscribers:read scope, an end-user Bearer credential (OAuth Bearer or User API Key) with the contacts:read scope and the Starter/Manager role, or a System API Key.

Authorizations:
projectApiKeyuserApiKey
path Parameters
link_caption
required
string

Project URL slug

query Parameters
offset
integer
Default: 0

Result offset

limit
integer
Default: 20

Result limit (max 100)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

List project wall entries

Returns all wall entries (Pinnwand) for a project. Requires a Project API Key with the wall:read scope, an end-user Bearer credential (OAuth Bearer or User API Key) with the project:read scope and the Starter/Manager role, or a System API Key.

Authorizations:
projectApiKeyuserApiKey
path Parameters
link_caption
required
string

Project URL slug

query Parameters
offset
integer
Default: 0

Result offset

limit
integer
Default: 20

Result limit (max 100)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

List public project fundings (for streams)

Returns a paginated list of public fundings for a project (timestamp and supporter name only). Suitable for live streams/feeds. Internal (session/Startnext-domain) access is allowed without a key. External access requires either a Project API Key with the fundings:read scope, or an end-user Bearer credential (OAuth Bearer or User API Key) with the project:read scope and the Starter/Manager role.

Authorizations:
projectApiKeyuserApiKeyNone
path Parameters
link_caption
required
string

Project URL slug

query Parameters
funding_date_min
integer

Min funding date (UNIX timestamp)

funding_date_max
integer

Max funding date (UNIX timestamp)

offset
integer
Default: 0

Result offset

limit
integer
Default: 20

Result limit (max 100)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

List all project orders

Returns all successful orders for a project. Requires either a Project API Key with the orders:read scope, or an end-user Bearer credential (OAuth Bearer or User API Key) with the contacts:read scope and the Starter/Manager role. Project must be successfully funded (>=100%).

Authorizations:
projectApiKeyuserApiKey
path Parameters
link_caption
required
string

Project URL slug

query Parameters
offset
integer
Default: 0

Result offset

limit
integer
Default: 20

Result limit (max 100)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

List project blog entries

Returns a paginated list of blog entries for a specific project. OAuth Bearer (project Starter, Manager or Team Member) returns all entries including drafts. Internal access is allowed without an API key and returns published entries only. External access requires a Project API Key with blog:read scope.

Authorizations:
projectApiKeyuserApiKeyNone
path Parameters
link_caption
required
string

Project URL slug

query Parameters
blog_type
string
Default: "text"

Blog entry type (text, story)

offset
integer
Default: 0

Result offset

limit
integer
Default: 20

Result limit (max 100)

include_supporter_only
integer
Default: 0
Enum: 0 1

Set to 1 to include supporter-only blog entries. Only honoured when the caller is verified as a supporter, the starter, a team member or a platform manager; otherwise ignored. Requests with this parameter bypass the Cloudflare cache.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}