orgs

For users and admins: the orgs routes cover organizations, their members, invitations, and join requests. 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.

POST /v1/org-applications

Operation id OrgApplicationsController_create.

Request body

Field	Type	Required	Notes
slug	string	yes	pattern ^[a-z0-9](?:[a-z0-9-]{1,38}[a-z0-9])$
name	string	yes	min length 2, max length 80
kind	string, one of university_network, club, accelerator, community	yes	default "community"
description	string	yes	max length 2000, default ""
location	string	yes	max length 80, default ""
website	`` or string (uri)	yes	default ""
applicantRole	string	yes	min length 1, max length 80
message	string	yes	max length 1000, default ""

Responses

200

Field	Type	Required	Notes
id	string	yes
slug	string	yes	pattern ^[a-z0-9](?:[a-z0-9-]{1,38}[a-z0-9])$
name	string	yes
kind	string, one of university_network, club, accelerator, community	yes
description	string	yes
location	string	yes
website	string	yes
applicantRole	string	yes
message	string	yes
status	string, one of pending, approved, declined	yes
reason	string	yes
applicant	object	yes
applicant.userId	string	yes
applicant.name	string	yes
applicant.email	string	yes
applicant.handle	string or null	yes
organizationId	string or null	yes
decidedAt	string or null	yes
createdAt	string	yes

Problem types

Derived from the source scan (handler, one level of service calls, guards and pipes): membership_pending, membership_suspended, validation_failed.

GET /v1/org-applications/mine

Operation id OrgApplicationsController_mine.

Responses

200

Field	Type	Required	Notes
id	string	yes
slug	string	yes	pattern ^[a-z0-9](?:[a-z0-9-]{1,38}[a-z0-9])$
name	string	yes
kind	string, one of university_network, club, accelerator, community	yes
description	string	yes
location	string	yes
website	string	yes
applicantRole	string	yes
message	string	yes
status	string, one of pending, approved, declined	yes
reason	string	yes
applicant	object	yes
applicant.userId	string	yes
applicant.name	string	yes
applicant.email	string	yes
applicant.handle	string or null	yes
organizationId	string or null	yes
decidedAt	string or null	yes
createdAt	string	yes

Problem types

Derived from the source scan (handler, one level of service calls, guards and pipes): membership_pending, membership_suspended, org_application_not_found.

POST /v1/org-invitations/{token}/accept

Operation id OrgInvitationAcceptController_accept.

Parameters

Name	In	Required	Type	Notes
token	path	yes	string

Responses

200

Field	Type	Required	Notes
id	string	yes
slug	string	yes	pattern ^[a-z0-9](?:[a-z0-9-]{1,38}[a-z0-9])$
name	string	yes	min length 2, max length 80
kind	string, one of university_network, club, accelerator, community	yes
visibility	string, one of public, unlisted	yes
joinPolicy	string, one of open, request, invite_only	yes
description	string	yes	max length 2000
accent	string	yes	pattern ^#[0-9a-fA-F]{6}$
location	string	yes	max length 80
website	`` or string (uri)	yes
logo	string or null	yes
coverImage	string or null	yes
memberCount	integer	yes
createdAt	string	yes
updatedAt	string	yes

Problem types

Derived from the source scan (handler, one level of service calls, guards and pipes): invitation_email_mismatch, membership_pending, membership_suspended.

GET /v1/orgs

Operation id OrgsController_list.

Parameters

Name	In	Required	Type	Notes
limit	query	no	integer
cursor	query	no	string
scope	query	no	string, one of mine, listed

Responses

200

Field	Type	Required	Notes
items	array of object	yes
nextCursor	string or null	yes

Problem types

Derived from the source scan (handler, one level of service calls, guards and pipes): invalid_cursor, membership_pending, membership_suspended, org_not_found, validation_failed.

POST /v1/orgs

Operation id OrgsController_create.

Request body

Field	Type	Required	Notes
slug	string	yes	pattern ^[a-z0-9](?:[a-z0-9-]{1,38}[a-z0-9])$
name	string	yes	min length 2, max length 80
kind	string, one of university_network, club, accelerator, community	yes	default "community"
visibility	string, one of public, unlisted	yes	default "public"
joinPolicy	string, one of open, request, invite_only	yes	default "request"
description	string	yes	max length 2000, default ""
accent	string	yes	pattern ^#[0-9a-fA-F]{6}$, default "#88D1FF"
location	string	yes	max length 80, default ""
website	`` or string (uri)	yes	default ""

Responses

200

Field	Type	Required	Notes
id	string	yes
slug	string	yes	pattern ^[a-z0-9](?:[a-z0-9-]{1,38}[a-z0-9])$
name	string	yes	min length 2, max length 80
kind	string, one of university_network, club, accelerator, community	yes
visibility	string, one of public, unlisted	yes
joinPolicy	string, one of open, request, invite_only	yes
description	string	yes	max length 2000
accent	string	yes	pattern ^#[0-9a-fA-F]{6}$
location	string	yes	max length 80
website	`` or string (uri)	yes
logo	string or null	yes
coverImage	string or null	yes
memberCount	integer	yes
createdAt	string	yes
updatedAt	string	yes

Problem types

Derived from the source scan (handler, one level of service calls, guards and pipes): admin_required, membership_pending, membership_suspended, org_not_found, validation_failed.

GET /v1/orgs/{slug}

Operation id OrgsController_read.

Parameters

Name	In	Required	Type	Notes
slug	path	yes	string

Responses

200

Field	Type	Required	Notes
id	string	yes
slug	string	yes	pattern ^[a-z0-9](?:[a-z0-9-]{1,38}[a-z0-9])$
name	string	yes	min length 2, max length 80
kind	string, one of university_network, club, accelerator, community	yes
visibility	string, one of public, unlisted	yes
joinPolicy	string, one of open, request, invite_only	yes
description	string	yes	max length 2000
accent	string	yes	pattern ^#[0-9a-fA-F]{6}$
location	string	yes	max length 80
website	`` or string (uri)	yes
logo	string or null	yes
coverImage	string or null	yes
memberCount	integer	yes
createdAt	string	yes
updatedAt	string	yes
role	string, one of owner, admin, member or null	yes
joinRequestStatus	string, one of pending, approved, declined or null	yes

Problem types

Derived from the source scan (handler, one level of service calls, guards and pipes): membership_pending, membership_suspended, org_not_found.

PATCH /v1/orgs/{slug}

Operation id OrgsController_update.

Parameters

Name	In	Required	Type	Notes
slug	path	yes	string

Request body

Field	Type	Required	Notes
slug	string	no	pattern ^[a-z0-9](?:[a-z0-9-]{1,38}[a-z0-9])$
name	string	no	min length 2, max length 80
kind	string, one of university_network, club, accelerator, community	no
visibility	string, one of public, unlisted	no
joinPolicy	string, one of open, request, invite_only	no
description	string	no	max length 2000
accent	string	no	pattern ^#[0-9a-fA-F]{6}$
location	string	no	max length 80
website	`` or string (uri)	no

Responses

200

Field	Type	Required	Notes
id	string	yes
slug	string	yes	pattern ^[a-z0-9](?:[a-z0-9-]{1,38}[a-z0-9])$
name	string	yes	min length 2, max length 80
kind	string, one of university_network, club, accelerator, community	yes
visibility	string, one of public, unlisted	yes
joinPolicy	string, one of open, request, invite_only	yes
description	string	yes	max length 2000
accent	string	yes	pattern ^#[0-9a-fA-F]{6}$
location	string	yes	max length 80
website	`` or string (uri)	yes
logo	string or null	yes
coverImage	string or null	yes
memberCount	integer	yes
createdAt	string	yes
updatedAt	string	yes

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.

PUT /v1/orgs/{slug}/cover

Operation id OrgsController_setCover.

Parameters

Name	In	Required	Type	Notes
slug	path	yes	string

Responses

200

Field	Type	Required	Notes
id	string	yes
slug	string	yes	pattern ^[a-z0-9](?:[a-z0-9-]{1,38}[a-z0-9])$
name	string	yes	min length 2, max length 80
kind	string, one of university_network, club, accelerator, community	yes
visibility	string, one of public, unlisted	yes
joinPolicy	string, one of open, request, invite_only	yes
description	string	yes	max length 2000
accent	string	yes	pattern ^#[0-9a-fA-F]{6}$
location	string	yes	max length 80
website	`` or string (uri)	yes
logo	string or null	yes
coverImage	string or null	yes
memberCount	integer	yes
createdAt	string	yes
updatedAt	string	yes

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.

DELETE /v1/orgs/{slug}/cover

Operation id OrgsController_removeCover.

Parameters

Name	In	Required	Type	Notes
slug	path	yes	string

Responses

200

Field	Type	Required	Notes
id	string	yes
slug	string	yes	pattern ^[a-z0-9](?:[a-z0-9-]{1,38}[a-z0-9])$
name	string	yes	min length 2, max length 80
kind	string, one of university_network, club, accelerator, community	yes
visibility	string, one of public, unlisted	yes
joinPolicy	string, one of open, request, invite_only	yes
description	string	yes	max length 2000
accent	string	yes	pattern ^#[0-9a-fA-F]{6}$
location	string	yes	max length 80
website	`` or string (uri)	yes
logo	string or null	yes
coverImage	string or null	yes
memberCount	integer	yes
createdAt	string	yes
updatedAt	string	yes

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.

PUT /v1/orgs/{slug}/cover/from-url

Operation id OrgsController_setCoverFromUrl.

Parameters

Name	In	Required	Type	Notes
slug	path	yes	string

Request body

Field	Type	Required	Notes
url	string (uri)	yes	max length 2000

Responses

200

Field	Type	Required	Notes
id	string	yes
slug	string	yes	pattern ^[a-z0-9](?:[a-z0-9-]{1,38}[a-z0-9])$
name	string	yes	min length 2, max length 80
kind	string, one of university_network, club, accelerator, community	yes
visibility	string, one of public, unlisted	yes
joinPolicy	string, one of open, request, invite_only	yes
description	string	yes	max length 2000
accent	string	yes	pattern ^#[0-9a-fA-F]{6}$
location	string	yes	max length 80
website	`` or string (uri)	yes
logo	string or null	yes
coverImage	string or null	yes
memberCount	integer	yes
createdAt	string	yes
updatedAt	string	yes

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}/invitations

Operation id OrgInvitationsController_create.

Parameters

Name	In	Required	Type	Notes
slug	path	yes	string

Request body

Field	Type	Required	Notes
email	string (email)	yes	pattern ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$, max length 200
role	string, one of member, admin	yes	default "member"
expiresInDays	integer	yes	min 1, max 90, default 14

Responses

200

Field	Type	Required	Notes
id	string	yes
orgSlug	string	yes	pattern ^[a-z0-9](?:[a-z0-9-]{1,38}[a-z0-9])$
orgName	string	yes
email	string	yes
role	string, one of owner, admin, member	yes
status	string, one of pending, accepted, revoked, expired	yes
invitedByName	string	yes
expiresAt	string	yes
createdAt	string	yes

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}/invitations

Operation id OrgInvitationsController_list.

Parameters

Name	In	Required	Type	Notes
limit	query	no	integer
cursor	query	no	string
slug	path	yes	string

Responses

200

Field	Type	Required	Notes
items	array of object	yes
nextCursor	string or null	yes

Problem types

Derived from the source scan (handler, one level of service calls, guards and pipes): invalid_cursor, membership_pending, membership_suspended, org_not_found, org_role_required, validation_failed.

DELETE /v1/orgs/{slug}/invitations/{id}

Operation id OrgInvitationsController_revoke.

Parameters

Name	In	Required	Type	Notes
id	path	yes	string
slug	path	yes	string

Responses

204

No body.

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.

POST /v1/orgs/{slug}/join

Operation id JoinRequestsController_join.

Parameters

Name	In	Required	Type	Notes
slug	path	yes	string

Request body

Field	Type	Required	Notes
message	string	yes	max length 500, default ""

Responses

200

Field	Type	Required	Notes
id	string	yes
slug	string	yes	pattern ^[a-z0-9](?:[a-z0-9-]{1,38}[a-z0-9])$
name	string	yes	min length 2, max length 80
kind	string, one of university_network, club, accelerator, community	yes
visibility	string, one of public, unlisted	yes
joinPolicy	string, one of open, request, invite_only	yes
description	string	yes	max length 2000
accent	string	yes	pattern ^#[0-9a-fA-F]{6}$
location	string	yes	max length 80
website	`` or string (uri)	yes
logo	string or null	yes
coverImage	string or null	yes
memberCount	integer	yes
createdAt	string	yes
updatedAt	string	yes
role	string, one of owner, admin, member or null	yes
joinRequestStatus	string, one of pending, approved, declined or null	yes

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/orgs/{slug}/join-requests

Operation id JoinRequestsController_list.

Parameters

Name	In	Required	Type	Notes
limit	query	no	integer
cursor	query	no	string
status	query	yes	string, one of pending, approved, declined
slug	path	yes	string

Responses

200

Field	Type	Required	Notes
items	array of object	yes
nextCursor	string or null	yes

Problem types

Derived from the source scan (handler, one level of service calls, guards and pipes): invalid_cursor, membership_pending, membership_suspended, org_not_found, org_role_required, validation_failed.

POST /v1/orgs/{slug}/join-requests/{id}/approve

Operation id JoinRequestsController_approve.

Parameters

Name	In	Required	Type	Notes
id	path	yes	string
slug	path	yes	string

Responses

200

Field	Type	Required	Notes
id	string	yes
orgSlug	string	yes	pattern ^[a-z0-9](?:[a-z0-9-]{1,38}[a-z0-9])$
userId	string	yes
handle	string	yes
name	string	yes
image	string or null	yes
headline	string	yes
message	string	yes	max length 500
status	string, one of pending, approved, declined	yes
createdAt	string	yes
decidedAt	string or null	yes

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.

POST /v1/orgs/{slug}/join-requests/{id}/decline

Operation id JoinRequestsController_decline.

Parameters

Name	In	Required	Type	Notes
id	path	yes	string
slug	path	yes	string

Responses

200

Field	Type	Required	Notes
id	string	yes
orgSlug	string	yes	pattern ^[a-z0-9](?:[a-z0-9-]{1,38}[a-z0-9])$
userId	string	yes
handle	string	yes
name	string	yes
image	string or null	yes
headline	string	yes
message	string	yes	max length 500
status	string, one of pending, approved, declined	yes
createdAt	string	yes
decidedAt	string or null	yes

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.

PUT /v1/orgs/{slug}/logo

Operation id OrgsController_setLogo.

Parameters

Name	In	Required	Type	Notes
slug	path	yes	string

Responses

200

Field	Type	Required	Notes
id	string	yes
slug	string	yes	pattern ^[a-z0-9](?:[a-z0-9-]{1,38}[a-z0-9])$
name	string	yes	min length 2, max length 80
kind	string, one of university_network, club, accelerator, community	yes
visibility	string, one of public, unlisted	yes
joinPolicy	string, one of open, request, invite_only	yes
description	string	yes	max length 2000
accent	string	yes	pattern ^#[0-9a-fA-F]{6}$
location	string	yes	max length 80
website	`` or string (uri)	yes
logo	string or null	yes
coverImage	string or null	yes
memberCount	integer	yes
createdAt	string	yes
updatedAt	string	yes

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.

DELETE /v1/orgs/{slug}/logo

Operation id OrgsController_removeLogo.

Parameters

Name	In	Required	Type	Notes
slug	path	yes	string

Responses

200

Field	Type	Required	Notes
id	string	yes
slug	string	yes	pattern ^[a-z0-9](?:[a-z0-9-]{1,38}[a-z0-9])$
name	string	yes	min length 2, max length 80
kind	string, one of university_network, club, accelerator, community	yes
visibility	string, one of public, unlisted	yes
joinPolicy	string, one of open, request, invite_only	yes
description	string	yes	max length 2000
accent	string	yes	pattern ^#[0-9a-fA-F]{6}$
location	string	yes	max length 80
website	`` or string (uri)	yes
logo	string or null	yes
coverImage	string or null	yes
memberCount	integer	yes
createdAt	string	yes
updatedAt	string	yes

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.

PUT /v1/orgs/{slug}/logo/from-url

Operation id OrgsController_setLogoFromUrl.

Parameters

Name	In	Required	Type	Notes
slug	path	yes	string

Request body

Field	Type	Required	Notes
url	string (uri)	yes	max length 2000

Responses

200

Field	Type	Required	Notes
id	string	yes
slug	string	yes	pattern ^[a-z0-9](?:[a-z0-9-]{1,38}[a-z0-9])$
name	string	yes	min length 2, max length 80
kind	string, one of university_network, club, accelerator, community	yes
visibility	string, one of public, unlisted	yes
joinPolicy	string, one of open, request, invite_only	yes
description	string	yes	max length 2000
accent	string	yes	pattern ^#[0-9a-fA-F]{6}$
location	string	yes	max length 80
website	`` or string (uri)	yes
logo	string or null	yes
coverImage	string or null	yes
memberCount	integer	yes
createdAt	string	yes
updatedAt	string	yes

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}/members

Operation id OrgMembersController_list.

Parameters

Name	In	Required	Type	Notes
limit	query	no	integer
cursor	query	no	string
slug	path	yes	string

Responses

200

Field	Type	Required	Notes
items	array of object	yes
nextCursor	string or null	yes

Problem types

Derived from the source scan (handler, one level of service calls, guards and pipes): invalid_cursor, membership_pending, membership_suspended, org_not_found, org_role_required, validation_failed.

DELETE /v1/orgs/{slug}/members/{userId}

Operation id OrgMembersController_remove.

Parameters

Name	In	Required	Type	Notes
userId	path	yes	string
slug	path	yes	string

Responses

204

No body.

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.

PATCH /v1/orgs/{slug}/members/{userId}/role

Operation id OrgMembersController_setRole.

Parameters

Name	In	Required	Type	Notes
userId	path	yes	string
slug	path	yes	string

Request body

Field	Type	Required	Notes
role	string, one of owner, admin, member	yes

Responses

200

Field	Type	Required	Notes
userId	string	yes
handle	string	yes
name	string	yes
image	string or null	yes
headline	string	yes
roles	array of string, one of founder, operator, investor, idea_person, business_owner	yes
lookingFor	array of string, one of cofounder, team, investors, talent, advice, ideas	yes
role	string, one of owner, admin, member	yes
joinedAt	string	yes

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.

DELETE /v1/orgs/{slug}/members/me

Operation id OrgMembersController_leave.

Parameters

Name	In	Required	Type	Notes
slug	path	yes	string

Responses

204

No body.

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.