admin
For admins: the admin routes cover the platform admin routes. They need the admin role. 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/admin/invites
Section titled “POST /v1/admin/invites”Operation id AdminController_createInvite.
Request body
Section titled “Request body”| Field | Type | Required | Notes |
|---|---|---|---|
note |
string | yes | max length 200, default "" |
maxUses |
integer | yes | min 1, max 500, default 1 |
expiresInDays |
integer | no | min 1, max 365 |
Responses
Section titled “Responses”200
| Field | Type | Required | Notes |
|---|---|---|---|
code |
string | yes | |
note |
string | yes | |
maxUses |
integer | yes | |
uses |
integer | yes | |
expiresAt |
string or null | yes | |
createdAt |
string | yes |
Problem types
Section titled “Problem types”Derived from the source scan (handler, one level of service calls, guards and pipes): admin_required, membership_pending, membership_suspended, validation_failed.
GET /v1/admin/invites
Section titled “GET /v1/admin/invites”Operation id AdminController_listInvites.
Parameters
Section titled “Parameters”| Name | In | Required | Type | Notes |
|---|---|---|---|---|
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): admin_required, invalid_cursor, membership_pending, membership_suspended, validation_failed.
GET /v1/admin/members
Section titled “GET /v1/admin/members”Operation id AdminController_members.
Parameters
Section titled “Parameters”| Name | In | Required | Type | Notes |
|---|---|---|---|---|
status |
query | no | string, one of pending, active, suspended |
Responses
Section titled “Responses”200
Type: array of object.
Problem types
Section titled “Problem types”Derived from the source scan (handler, one level of service calls, guards and pipes): admin_required, membership_pending, membership_suspended, validation_failed.
POST /v1/admin/members/{id}/approve
Section titled “POST /v1/admin/members/{id}/approve”Operation id AdminController_approve.
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 | |
email |
string | yes | |
name |
string | yes | |
membershipStatus |
string, one of pending, active, suspended |
yes | |
role |
string, one of member, admin |
yes | |
createdAt |
string | yes |
Problem types
Section titled “Problem types”Derived from the source scan (handler, one level of service calls, guards and pipes): admin_required, member_not_found, membership_pending, membership_suspended.
POST /v1/admin/members/{id}/role
Section titled “POST /v1/admin/members/{id}/role”Operation id AdminController_setRole.
Parameters
Section titled “Parameters”| Name | In | Required | Type | Notes |
|---|---|---|---|---|
id |
path | yes | string |
Request body
Section titled “Request body”| Field | Type | Required | Notes |
|---|---|---|---|
role |
string, one of member, admin |
yes |
Responses
Section titled “Responses”200
| Field | Type | Required | Notes |
|---|---|---|---|
id |
string | yes | |
email |
string | yes | |
name |
string | yes | |
membershipStatus |
string, one of pending, active, suspended |
yes | |
role |
string, one of member, admin |
yes | |
createdAt |
string | yes |
Problem types
Section titled “Problem types”Derived from the source scan (handler, one level of service calls, guards and pipes): admin_required, cannot_change_own_role, member_not_found, member_suspended, membership_pending, membership_suspended, validation_failed.
POST /v1/admin/members/{id}/suspend
Section titled “POST /v1/admin/members/{id}/suspend”Operation id AdminController_suspend.
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 | |
email |
string | yes | |
name |
string | yes | |
membershipStatus |
string, one of pending, active, suspended |
yes | |
role |
string, one of member, admin |
yes | |
createdAt |
string | yes |
Problem types
Section titled “Problem types”Derived from the source scan (handler, one level of service calls, guards and pipes): admin_required, cannot_suspend_self, membership_pending, membership_suspended.
GET /v1/admin/org-applications
Section titled “GET /v1/admin/org-applications”Operation id OrgApplicationsAdminController_list.
Parameters
Section titled “Parameters”| Name | In | Required | Type | Notes |
|---|---|---|---|---|
status |
query | no | string, one of pending, approved, declined |
Responses
Section titled “Responses”200
Type: array of object.
Problem types
Section titled “Problem types”Derived from the source scan (handler, one level of service calls, guards and pipes): admin_required, membership_pending, membership_suspended, validation_failed.
POST /v1/admin/org-applications/{id}/approve
Section titled “POST /v1/admin/org-applications/{id}/approve”Operation id OrgApplicationsAdminController_approve.
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 | |
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
Section titled “Problem types”Derived from the source scan (handler, one level of service calls, guards and pipes): admin_required, membership_pending, membership_suspended.
POST /v1/admin/org-applications/{id}/decline
Section titled “POST /v1/admin/org-applications/{id}/decline”Operation id OrgApplicationsAdminController_decline.
Parameters
Section titled “Parameters”| Name | In | Required | Type | Notes |
|---|---|---|---|---|
id |
path | yes | string |
Request body
Section titled “Request body”| Field | Type | Required | Notes |
|---|---|---|---|
reason |
string | yes | max length 500, default "" |
Responses
Section titled “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
Section titled “Problem types”Derived from the source scan (handler, one level of service calls, guards and pipes): admin_required, membership_pending, membership_suspended, validation_failed.
GET /v1/admin/outbox
Section titled “GET /v1/admin/outbox”Operation id OutboxController_stats.
Responses
Section titled “Responses”200
| Field | Type | Required | Notes |
|---|---|---|---|
pending |
integer | yes | |
failed |
integer | yes | |
sentLastHour |
integer | yes | |
oldestPendingAt |
string (date-time) or null | yes |
Problem types
Section titled “Problem types”Derived from the source scan (handler, one level of service calls, guards and pipes): admin_required, membership_pending, membership_suspended.