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 blog entries

Returns a paginated list of blog entries for a specific project. Internal access allowed without API Key. External access requires a Project API Key with blog:read scope.

Authorizations:
projectApiKey
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: 50

Result limit (max 100)

Responses

Response samples

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

List project incentives including hidden (API Key)

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 incentives:read scope, 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:
projectApiKeyNone
path Parameters
link_caption
required
string

Project URL slug

query Parameters
offset
integer
Default: 0

Result offset

limit
integer
Default: 50

Result limit (max 100)

Responses

Response samples

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

Get project details

Returns full project details. Supports optional API Key authentication for extended access.

path Parameters
link_caption
required
string

Project URL slug

Responses

Response samples

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

List project subscribers (API Key required)

Returns all subscribers (fans) for a project. Requires a Project API Key with subscribers:read scope.

Authorizations:
projectApiKey
path Parameters
link_caption
required
string

Project URL slug

query Parameters
offset
integer
Default: 0

Result offset

limit
integer
Default: 50

Result limit (max 100)

Responses

Response samples

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

List project wall entries (API Key required)

Returns all wall entries (Pinnwand) for a project. Requires a Project API Key with wall:read scope.

Authorizations:
projectApiKey
path Parameters
link_caption
required
string

Project URL slug

query Parameters
offset
integer
Default: 0

Result offset

limit
integer
Default: 50

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 access allowed without API Key. External access requires a Project API Key with fundings:read scope.

Authorizations:
projectApiKey
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: 10

Result limit

Responses

Response samples

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

List all project orders (API Key required)

Returns all successful orders for a project. Requires a Project API Key with orders:read scope. Project must be successfully funded (>=100%).

Authorizations:
projectApiKey
path Parameters
link_caption
required
string

Project URL slug

query Parameters
offset
integer
Default: 0

Result offset

limit
integer
Default: 50

Result limit (max 100)

Responses

Response samples

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

UserApiKey

Endpoints accessible with User API Key (snx_user_*)

Get API key identity

Returns minimal identity data for the authenticated User API Key. Answers "who am I and what scopes does my key have?" without PII exposure. Requires a User API Key (snx_user_*) — session auth is explicitly rejected.

Authorizations:
userApiKey

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get incentives from own and team projects

Returns a paginated list of active incentives from all projects where the current user is the initiator or a team member. Accepts either a session cookie (internal) or a User API Key with incentives:read scope.

Authorizations:
NoneuserApiKey
query Parameters
sort
string
Default: "sold"
Enum: "new" "sold" "price-a" "price-d" "name-a" "name-d" "rand"

Sort order

fundable
boolean

Filter by fundable projects only

is_favorite
boolean

Filter favorites only

offset
integer
Default: 0

Result offset

limit
integer
Default: 50

Result limit (max 100)

Responses

Response samples

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

Get all public projects (own + team)

Returns a paginated list of all public projects where the current user is the initiator or a team member. Accepts either a session cookie (internal) or a User API Key with projects:read scope.

Authorizations:
NoneuserApiKey
query Parameters
sort
string
Default: "project-end-date-d"
Enum: "project-end-date-d" "project-end-date-a" "project-activation-date-d" "project-activation-date-a" "project-title-d" "project-title-a" "project-funding-sum-d" "project-funding-sum-a" "project-support-count-d" "project-support-count-a" "project-fan-count-d" "project-fan-count-a" "rand"

Sort order

offset
integer
Default: 0

Result offset

limit
integer
Default: 20

Result limit

Responses

Response samples

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