projects
For users and admins: the projects routes cover this part of the API. Every route lives under the one public origin, https://venturenetwork.ai, and answers errors as problem types. The interactive version of this page is the live Scalar reference at https://venturenetwork.ai/docs. This page is generated from packages/sdk/openapi.json on every build.
GET /v1/orgs/{slug}/project-affiliations
Section titled “GET /v1/orgs/{slug}/project-affiliations”Operation id OrgProjectAffiliationsController_list.
Parameters
Section titled “Parameters”| Name | In | Required | Type | Notes |
|---|---|---|---|---|
limit |
query | no | integer | |
cursor |
query | no | string | |
status |
query | no | string, one of pending, active, declined, cancelled, ended |
|
slug |
path | yes | string |
Responses
Section titled “Responses”200
| Field | Type | Required | Notes |
|---|---|---|---|
items |
array of object | yes | |
nextCursor |
string or null | yes |
Problem types
Section titled “Problem types”Derived from the source scan (handler, one level of service calls, guards and pipes): membership_pending, membership_suspended, org_not_found, org_role_required, validation_failed.
POST /v1/orgs/{slug}/project-affiliations
Section titled “POST /v1/orgs/{slug}/project-affiliations”Operation id OrgProjectAffiliationsController_invite.
Parameters
Section titled “Parameters”| Name | In | Required | Type | Notes |
|---|---|---|---|---|
slug |
path | yes | string |
Request body
Section titled “Request body”| Field | Type | Required | Notes |
|---|---|---|---|
projectId |
string | yes | min length 1 |
kind |
string, one of community, program, investor |
yes | |
message |
string | yes | max length 500, default "" |
Responses
Section titled “Responses”200
| Field | Type | Required | Notes |
|---|---|---|---|
id |
string | yes | |
project |
object | yes | |
project.id |
string | yes | |
project.name |
string | yes | |
project.summary |
string | yes | |
project.stage |
string, one of idea, validating, building, launched |
yes | |
project.memberCount |
integer | yes | |
project.visibility |
string, one of network, private |
yes | |
org |
object | yes | |
org.slug |
string | yes | pattern ^[a-z0-9](?:[a-z0-9-]{1,38}[a-z0-9])$ |
org.name |
string | yes | |
org.logo |
string or null | yes | |
kind |
string, one of community, program, investor |
yes | |
status |
string, one of pending, active, declined, cancelled, ended |
yes | |
initiatedBy |
string, one of project, org |
yes | |
message |
string | yes | |
cohort |
string | yes | |
terms |
string or null | yes | |
termsUpdatedAt |
string or null | yes | |
requester |
object or null | yes | |
viewerSide |
string, one of team, org, both or null |
yes | |
joiningMembers |
array of object or null | yes | |
createdAt |
string | yes | |
decidedAt |
string or null | yes | |
endedAt |
string or null | yes |
Problem types
Section titled “Problem types”Derived from the source scan (handler, one level of service calls, guards and pipes): membership_pending, membership_suspended, org_not_found, org_role_required, validation_failed.
GET /v1/orgs/{slug}/projects
Section titled “GET /v1/orgs/{slug}/projects”Operation id OrgProjectsController_list.
Parameters
Section titled “Parameters”| Name | In | Required | Type | Notes |
|---|---|---|---|---|
limit |
query | no | integer | |
cursor |
query | no | string | |
status |
query | no | string, one of active, archived, all |
|
slug |
path | yes | string |
Responses
Section titled “Responses”200
| Field | Type | Required | Notes |
|---|---|---|---|
items |
array of object | yes | |
nextCursor |
string or null | yes |
Problem types
Section titled “Problem types”Derived from the source scan (handler, one level of service calls, guards and pipes): membership_pending, membership_suspended, org_not_found, validation_failed.
GET /v1/project-affiliations/{id}
Section titled “GET /v1/project-affiliations/{id}”Operation id ProjectAffiliationsController_read.
Parameters
Section titled “Parameters”| Name | In | Required | Type | Notes |
|---|---|---|---|---|
id |
path | yes | string |
Responses
Section titled “Responses”200
| Field | Type | Required | Notes |
|---|---|---|---|
id |
string | yes | |
project |
object | yes | |
project.id |
string | yes | |
project.name |
string | yes | |
project.summary |
string | yes | |
project.stage |
string, one of idea, validating, building, launched |
yes | |
project.memberCount |
integer | yes | |
project.visibility |
string, one of network, private |
yes | |
org |
object | yes | |
org.slug |
string | yes | pattern ^[a-z0-9](?:[a-z0-9-]{1,38}[a-z0-9])$ |
org.name |
string | yes | |
org.logo |
string or null | yes | |
kind |
string, one of community, program, investor |
yes | |
status |
string, one of pending, active, declined, cancelled, ended |
yes | |
initiatedBy |
string, one of project, org |
yes | |
message |
string | yes | |
cohort |
string | yes | |
terms |
string or null | yes | |
termsUpdatedAt |
string or null | yes | |
requester |
object or null | yes | |
viewerSide |
string, one of team, org, both or null |
yes | |
joiningMembers |
array of object or null | yes | |
createdAt |
string | yes | |
decidedAt |
string or null | yes | |
endedAt |
string or null | yes |
Problem types
Section titled “Problem types”Derived from the source scan (handler, one level of service calls, guards and pipes): membership_pending, membership_suspended.
PATCH /v1/project-affiliations/{id}
Section titled “PATCH /v1/project-affiliations/{id}”Operation id ProjectAffiliationsController_update.
Parameters
Section titled “Parameters”| Name | In | Required | Type | Notes |
|---|---|---|---|---|
id |
path | yes | string |
Request body
Section titled “Request body”| Field | Type | Required | Notes |
|---|---|---|---|
kind |
string, one of community, program, investor |
no | |
cohort |
string | no | max length 80 |
terms |
string | no | max length 4000 |
Responses
Section titled “Responses”200
| Field | Type | Required | Notes |
|---|---|---|---|
id |
string | yes | |
project |
object | yes | |
project.id |
string | yes | |
project.name |
string | yes | |
project.summary |
string | yes | |
project.stage |
string, one of idea, validating, building, launched |
yes | |
project.memberCount |
integer | yes | |
project.visibility |
string, one of network, private |
yes | |
org |
object | yes | |
org.slug |
string | yes | pattern ^[a-z0-9](?:[a-z0-9-]{1,38}[a-z0-9])$ |
org.name |
string | yes | |
org.logo |
string or null | yes | |
kind |
string, one of community, program, investor |
yes | |
status |
string, one of pending, active, declined, cancelled, ended |
yes | |
initiatedBy |
string, one of project, org |
yes | |
message |
string | yes | |
cohort |
string | yes | |
terms |
string or null | yes | |
termsUpdatedAt |
string or null | yes | |
requester |
object or null | yes | |
viewerSide |
string, one of team, org, both or null |
yes | |
joiningMembers |
array of object or null | yes | |
createdAt |
string | yes | |
decidedAt |
string or null | yes | |
endedAt |
string or null | yes |
Problem types
Section titled “Problem types”Derived from the source scan (handler, one level of service calls, guards and pipes): membership_pending, membership_suspended, validation_failed.
POST /v1/project-affiliations/{id}/accept
Section titled “POST /v1/project-affiliations/{id}/accept”Operation id ProjectAffiliationsController_accept.
Parameters
Section titled “Parameters”| Name | In | Required | Type | Notes |
|---|---|---|---|---|
id |
path | yes | string |
Request body
Section titled “Request body”| Field | Type | Required | Notes |
|---|---|---|---|
inviteTeam |
boolean | yes | default true |
Responses
Section titled “Responses”200
| Field | Type | Required | Notes |
|---|---|---|---|
id |
string | yes | |
project |
object | yes | |
project.id |
string | yes | |
project.name |
string | yes | |
project.summary |
string | yes | |
project.stage |
string, one of idea, validating, building, launched |
yes | |
project.memberCount |
integer | yes | |
project.visibility |
string, one of network, private |
yes | |
org |
object | yes | |
org.slug |
string | yes | pattern ^[a-z0-9](?:[a-z0-9-]{1,38}[a-z0-9])$ |
org.name |
string | yes | |
org.logo |
string or null | yes | |
kind |
string, one of community, program, investor |
yes | |
status |
string, one of pending, active, declined, cancelled, ended |
yes | |
initiatedBy |
string, one of project, org |
yes | |
message |
string | yes | |
cohort |
string | yes | |
terms |
string or null | yes | |
termsUpdatedAt |
string or null | yes | |
requester |
object or null | yes | |
viewerSide |
string, one of team, org, both or null |
yes | |
joiningMembers |
array of object or null | yes | |
createdAt |
string | yes | |
decidedAt |
string or null | yes | |
endedAt |
string or null | yes |
Problem types
Section titled “Problem types”Derived from the source scan (handler, one level of service calls, guards and pipes): membership_pending, membership_suspended, validation_failed.
POST /v1/project-affiliations/{id}/cancel
Section titled “POST /v1/project-affiliations/{id}/cancel”Operation id ProjectAffiliationsController_cancel.
Parameters
Section titled “Parameters”| Name | In | Required | Type | Notes |
|---|---|---|---|---|
id |
path | yes | string |
Responses
Section titled “Responses”200
| Field | Type | Required | Notes |
|---|---|---|---|
id |
string | yes | |
project |
object | yes | |
project.id |
string | yes | |
project.name |
string | yes | |
project.summary |
string | yes | |
project.stage |
string, one of idea, validating, building, launched |
yes | |
project.memberCount |
integer | yes | |
project.visibility |
string, one of network, private |
yes | |
org |
object | yes | |
org.slug |
string | yes | pattern ^[a-z0-9](?:[a-z0-9-]{1,38}[a-z0-9])$ |
org.name |
string | yes | |
org.logo |
string or null | yes | |
kind |
string, one of community, program, investor |
yes | |
status |
string, one of pending, active, declined, cancelled, ended |
yes | |
initiatedBy |
string, one of project, org |
yes | |
message |
string | yes | |
cohort |
string | yes | |
terms |
string or null | yes | |
termsUpdatedAt |
string or null | yes | |
requester |
object or null | yes | |
viewerSide |
string, one of team, org, both or null |
yes | |
joiningMembers |
array of object or null | yes | |
createdAt |
string | yes | |
decidedAt |
string or null | yes | |
endedAt |
string or null | yes |
Problem types
Section titled “Problem types”Derived from the source scan (handler, one level of service calls, guards and pipes): membership_pending, membership_suspended.
POST /v1/project-affiliations/{id}/decline
Section titled “POST /v1/project-affiliations/{id}/decline”Operation id ProjectAffiliationsController_decline.
Parameters
Section titled “Parameters”| Name | In | Required | Type | Notes |
|---|---|---|---|---|
id |
path | yes | string |
Responses
Section titled “Responses”200
| Field | Type | Required | Notes |
|---|---|---|---|
id |
string | yes | |
project |
object | yes | |
project.id |
string | yes | |
project.name |
string | yes | |
project.summary |
string | yes | |
project.stage |
string, one of idea, validating, building, launched |
yes | |
project.memberCount |
integer | yes | |
project.visibility |
string, one of network, private |
yes | |
org |
object | yes | |
org.slug |
string | yes | pattern ^[a-z0-9](?:[a-z0-9-]{1,38}[a-z0-9])$ |
org.name |
string | yes | |
org.logo |
string or null | yes | |
kind |
string, one of community, program, investor |
yes | |
status |
string, one of pending, active, declined, cancelled, ended |
yes | |
initiatedBy |
string, one of project, org |
yes | |
message |
string | yes | |
cohort |
string | yes | |
terms |
string or null | yes | |
termsUpdatedAt |
string or null | yes | |
requester |
object or null | yes | |
viewerSide |
string, one of team, org, both or null |
yes | |
joiningMembers |
array of object or null | yes | |
createdAt |
string | yes | |
decidedAt |
string or null | yes | |
endedAt |
string or null | yes |
Problem types
Section titled “Problem types”Derived from the source scan (handler, one level of service calls, guards and pipes): membership_pending, membership_suspended.
POST /v1/project-affiliations/{id}/end
Section titled “POST /v1/project-affiliations/{id}/end”Operation id ProjectAffiliationsController_end.
Parameters
Section titled “Parameters”| Name | In | Required | Type | Notes |
|---|---|---|---|---|
id |
path | yes | string |
Responses
Section titled “Responses”200
| Field | Type | Required | Notes |
|---|---|---|---|
id |
string | yes | |
project |
object | yes | |
project.id |
string | yes | |
project.name |
string | yes | |
project.summary |
string | yes | |
project.stage |
string, one of idea, validating, building, launched |
yes | |
project.memberCount |
integer | yes | |
project.visibility |
string, one of network, private |
yes | |
org |
object | yes | |
org.slug |
string | yes | pattern ^[a-z0-9](?:[a-z0-9-]{1,38}[a-z0-9])$ |
org.name |
string | yes | |
org.logo |
string or null | yes | |
kind |
string, one of community, program, investor |
yes | |
status |
string, one of pending, active, declined, cancelled, ended |
yes | |
initiatedBy |
string, one of project, org |
yes | |
message |
string | yes | |
cohort |
string | yes | |
terms |
string or null | yes | |
termsUpdatedAt |
string or null | yes | |
requester |
object or null | yes | |
viewerSide |
string, one of team, org, both or null |
yes | |
joiningMembers |
array of object or null | yes | |
createdAt |
string | yes | |
decidedAt |
string or null | yes | |
endedAt |
string or null | yes |
Problem types
Section titled “Problem types”Derived from the source scan (handler, one level of service calls, guards and pipes): membership_pending, membership_suspended.
POST /v1/project-affiliations/{id}/invite-team
Section titled “POST /v1/project-affiliations/{id}/invite-team”Operation id ProjectAffiliationsController_inviteTeam.
Parameters
Section titled “Parameters”| Name | In | Required | Type | Notes |
|---|---|---|---|---|
id |
path | yes | string |
Responses
Section titled “Responses”200
| Field | Type | Required | Notes |
|---|---|---|---|
invited |
array of string | yes | |
skipped |
array of string | yes |
Problem types
Section titled “Problem types”Derived from the source scan (handler, one level of service calls, guards and pipes): membership_pending, membership_suspended.
GET /v1/projects
Section titled “GET /v1/projects”Operation id ProjectsController_search.
Parameters
Section titled “Parameters”| Name | In | Required | Type | Notes |
|---|---|---|---|---|
limit |
query | no | integer | |
cursor |
query | no | string | |
member |
query | no | string | The projects a handle is on the roster of. |
status |
query | no | string, one of active, archived, all |
|
q |
query | no | string |
Responses
Section titled “Responses”200
| Field | Type | Required | Notes |
|---|---|---|---|
items |
array of object | yes | |
nextCursor |
string or null | yes |
Problem types
Section titled “Problem types”Derived from the source scan (handler, one level of service calls, guards and pipes): membership_pending, membership_suspended, validation_failed.
POST /v1/projects
Section titled “POST /v1/projects”Operation id ProjectsController_create.
Request body
Section titled “Request body”| Field | Type | Required | Notes |
|---|---|---|---|
name |
string | yes | min length 2, max length 80 |
summary |
string | yes | max length 280, default "" |
description |
string | yes | max length 4000, default "" |
stage |
string, one of idea, validating, building, launched |
yes | default "idea" |
visibility |
string, one of network, private |
yes | default "network" |
Responses
Section titled “Responses”200
| Field | Type | Required | Notes |
|---|---|---|---|
id |
string | yes | |
name |
string | yes | |
summary |
string | yes | |
description |
string | yes | |
stage |
string, one of idea, validating, building, launched |
yes | |
status |
string, one of active, archived |
yes | |
visibility |
string, one of network, private |
yes | |
memberCount |
integer | yes | |
myRole |
string, one of lead, member or null |
yes | |
canManage |
boolean | yes | |
affiliations |
array of object | yes | |
createdAt |
string | yes | |
updatedAt |
string | yes | |
members |
array of object | yes |
Problem types
Section titled “Problem types”Derived from the source scan (handler, one level of service calls, guards and pipes): membership_pending, membership_suspended, validation_failed.
GET /v1/projects/{id}
Section titled “GET /v1/projects/{id}”Operation id ProjectsController_read.
Parameters
Section titled “Parameters”| Name | In | Required | Type | Notes |
|---|---|---|---|---|
id |
path | yes | string |
Responses
Section titled “Responses”200
| Field | Type | Required | Notes |
|---|---|---|---|
id |
string | yes | |
name |
string | yes | |
summary |
string | yes | |
description |
string | yes | |
stage |
string, one of idea, validating, building, launched |
yes | |
status |
string, one of active, archived |
yes | |
visibility |
string, one of network, private |
yes | |
memberCount |
integer | yes | |
myRole |
string, one of lead, member or null |
yes | |
canManage |
boolean | yes | |
affiliations |
array of object | yes | |
createdAt |
string | yes | |
updatedAt |
string | yes | |
members |
array of object | yes |
Problem types
Section titled “Problem types”Derived from the source scan (handler, one level of service calls, guards and pipes): membership_pending, membership_suspended.
PATCH /v1/projects/{id}
Section titled “PATCH /v1/projects/{id}”Operation id ProjectsController_update.
Parameters
Section titled “Parameters”| Name | In | Required | Type | Notes |
|---|---|---|---|---|
id |
path | yes | string |
Request body
Section titled “Request body”| Field | Type | Required | Notes |
|---|---|---|---|
name |
string | no | min length 2, max length 80 |
summary |
string | no | max length 280 |
description |
string | no | max length 4000 |
stage |
string, one of idea, validating, building, launched |
no | |
visibility |
string, one of network, private |
no | |
status |
string, one of active, archived |
no |
Responses
Section titled “Responses”200
| Field | Type | Required | Notes |
|---|---|---|---|
id |
string | yes | |
name |
string | yes | |
summary |
string | yes | |
description |
string | yes | |
stage |
string, one of idea, validating, building, launched |
yes | |
status |
string, one of active, archived |
yes | |
visibility |
string, one of network, private |
yes | |
memberCount |
integer | yes | |
myRole |
string, one of lead, member or null |
yes | |
canManage |
boolean | yes | |
affiliations |
array of object | yes | |
createdAt |
string | yes | |
updatedAt |
string | yes | |
members |
array of object | yes |
Problem types
Section titled “Problem types”Derived from the source scan (handler, one level of service calls, guards and pipes): membership_pending, membership_suspended, validation_failed.
DELETE /v1/projects/{id}
Section titled “DELETE /v1/projects/{id}”Operation id ProjectsController_remove.
Parameters
Section titled “Parameters”| Name | In | Required | Type | Notes |
|---|---|---|---|---|
id |
path | yes | string |
Responses
Section titled “Responses”204
No body.
Problem types
Section titled “Problem types”Derived from the source scan (handler, one level of service calls, guards and pipes): membership_pending, membership_suspended.
GET /v1/projects/{id}/affiliations
Section titled “GET /v1/projects/{id}/affiliations”Operation id ProjectsController_listAffiliations.
Parameters
Section titled “Parameters”| Name | In | Required | Type | Notes |
|---|---|---|---|---|
id |
path | yes | string | |
limit |
query | no | integer | |
cursor |
query | no | string |
Responses
Section titled “Responses”200
| Field | Type | Required | Notes |
|---|---|---|---|
items |
array of object | yes | |
nextCursor |
string or null | yes |
Problem types
Section titled “Problem types”Derived from the source scan (handler, one level of service calls, guards and pipes): invalid_cursor, membership_pending, membership_suspended, validation_failed.
POST /v1/projects/{id}/affiliations
Section titled “POST /v1/projects/{id}/affiliations”Operation id ProjectsController_requestAffiliation.
Parameters
Section titled “Parameters”| Name | In | Required | Type | Notes |
|---|---|---|---|---|
id |
path | yes | string |
Request body
Section titled “Request body”| Field | Type | Required | Notes |
|---|---|---|---|
orgSlug |
string | yes | pattern ^[a-z0-9](?:[a-z0-9-]{1,38}[a-z0-9])$ |
kind |
string, one of community, program, investor |
yes | |
message |
string | yes | max length 500, default "" |
Responses
Section titled “Responses”200
| Field | Type | Required | Notes |
|---|---|---|---|
id |
string | yes | |
project |
object | yes | |
project.id |
string | yes | |
project.name |
string | yes | |
project.summary |
string | yes | |
project.stage |
string, one of idea, validating, building, launched |
yes | |
project.memberCount |
integer | yes | |
project.visibility |
string, one of network, private |
yes | |
org |
object | yes | |
org.slug |
string | yes | pattern ^[a-z0-9](?:[a-z0-9-]{1,38}[a-z0-9])$ |
org.name |
string | yes | |
org.logo |
string or null | yes | |
kind |
string, one of community, program, investor |
yes | |
status |
string, one of pending, active, declined, cancelled, ended |
yes | |
initiatedBy |
string, one of project, org |
yes | |
message |
string | yes | |
cohort |
string | yes | |
terms |
string or null | yes | |
termsUpdatedAt |
string or null | yes | |
requester |
object or null | yes | |
viewerSide |
string, one of team, org, both or null |
yes | |
joiningMembers |
array of object or null | yes | |
createdAt |
string | yes | |
decidedAt |
string or null | yes | |
endedAt |
string or null | yes |
Problem types
Section titled “Problem types”Derived from the source scan (handler, one level of service calls, guards and pipes): membership_pending, membership_suspended, validation_failed.
POST /v1/projects/{id}/members
Section titled “POST /v1/projects/{id}/members”Operation id ProjectsController_assign.
Parameters
Section titled “Parameters”| Name | In | Required | Type | Notes |
|---|---|---|---|---|
id |
path | yes | string |
Request body
Section titled “Request body”| Field | Type | Required | Notes |
|---|---|---|---|
handle |
string | yes | pattern ^[a-z0-9](?:[a-z0-9-]{1,28}[a-z0-9])$ |
role |
string, one of lead, member |
no | |
title |
string | no | max length 80 |
Responses
Section titled “Responses”200
| Field | Type | Required | Notes |
|---|---|---|---|
id |
string | yes | |
name |
string | yes | |
summary |
string | yes | |
description |
string | yes | |
stage |
string, one of idea, validating, building, launched |
yes | |
status |
string, one of active, archived |
yes | |
visibility |
string, one of network, private |
yes | |
memberCount |
integer | yes | |
myRole |
string, one of lead, member or null |
yes | |
canManage |
boolean | yes | |
affiliations |
array of object | yes | |
createdAt |
string | yes | |
updatedAt |
string | yes | |
members |
array of object | yes |
Problem types
Section titled “Problem types”Derived from the source scan (handler, one level of service calls, guards and pipes): membership_pending, membership_suspended, validation_failed.
DELETE /v1/projects/{id}/members/{userId}
Section titled “DELETE /v1/projects/{id}/members/{userId}”Operation id ProjectsController_removeMember.
Parameters
Section titled “Parameters”| Name | In | Required | Type | Notes |
|---|---|---|---|---|
id |
path | yes | string | |
userId |
path | yes | string |
Responses
Section titled “Responses”204
No body.
Problem types
Section titled “Problem types”Derived from the source scan (handler, one level of service calls, guards and pipes): membership_pending, membership_suspended.
DELETE /v1/projects/{id}/members/me
Section titled “DELETE /v1/projects/{id}/members/me”Operation id ProjectsController_leave.
Parameters
Section titled “Parameters”| Name | In | Required | Type | Notes |
|---|---|---|---|---|
id |
path | yes | string |
Responses
Section titled “Responses”204
No body.
Problem types
Section titled “Problem types”Derived from the source scan (handler, one level of service calls, guards and pipes): membership_pending, membership_suspended.