intros
For users and admins: the intros 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/intros
Section titled “GET /v1/intros”Operation id IntrosController_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, accepted, declined, expired |
|
direction |
query | no | string, one of received, sent |
received (the default) or sent. |
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/intros
Section titled “POST /v1/intros”Operation id IntrosController_create.
Request body
Section titled “Request body”| Field | Type | Required | Notes |
|---|---|---|---|
contextKind |
string, one of profile, post, event |
yes | |
toHandle |
string | no | pattern ^[a-z0-9](?:[a-z0-9-]{1,28}[a-z0-9])$ |
contextId |
string | no | |
message |
string | yes | min length 1, max length 500 |
Responses
Section titled “Responses”200
| Field | Type | Required | Notes |
|---|---|---|---|
id |
string | yes | |
from |
object | yes | |
from.userId |
string | yes | |
from.handle |
string | yes | |
from.name |
string | yes | |
from.image |
string or null | yes | |
from.headline |
string | yes | |
from.email |
string or null | yes | |
to |
object | yes | |
to.userId |
string | yes | |
to.handle |
string | yes | |
to.name |
string | yes | |
to.image |
string or null | yes | |
to.headline |
string | yes | |
to.email |
string or null | yes | |
contextKind |
string, one of profile, post, event |
yes | |
contextId |
string or null | yes | |
contextTitle |
string or null | yes | |
message |
string | yes | |
status |
string, one of pending, accepted, declined, expired |
yes | |
createdAt |
string (date-time) | yes | |
respondedAt |
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): membership_pending, membership_suspended, validation_failed.
GET /v1/intros/{id}
Section titled “GET /v1/intros/{id}”Operation id IntrosController_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 | |
from |
object | yes | |
from.userId |
string | yes | |
from.handle |
string | yes | |
from.name |
string | yes | |
from.image |
string or null | yes | |
from.headline |
string | yes | |
from.email |
string or null | yes | |
to |
object | yes | |
to.userId |
string | yes | |
to.handle |
string | yes | |
to.name |
string | yes | |
to.image |
string or null | yes | |
to.headline |
string | yes | |
to.email |
string or null | yes | |
contextKind |
string, one of profile, post, event |
yes | |
contextId |
string or null | yes | |
contextTitle |
string or null | yes | |
message |
string | yes | |
status |
string, one of pending, accepted, declined, expired |
yes | |
createdAt |
string (date-time) | yes | |
respondedAt |
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): membership_pending, membership_suspended.
POST /v1/intros/{id}/respond
Section titled “POST /v1/intros/{id}/respond”Operation id IntrosController_respond.
Parameters
Section titled “Parameters”| Name | In | Required | Type | Notes |
|---|---|---|---|---|
id |
path | yes | string |
Request body
Section titled “Request body”| Field | Type | Required | Notes |
|---|---|---|---|
decision |
string, one of accept, decline |
yes |
Responses
Section titled “Responses”200
| Field | Type | Required | Notes |
|---|---|---|---|
id |
string | yes | |
from |
object | yes | |
from.userId |
string | yes | |
from.handle |
string | yes | |
from.name |
string | yes | |
from.image |
string or null | yes | |
from.headline |
string | yes | |
from.email |
string or null | yes | |
to |
object | yes | |
to.userId |
string | yes | |
to.handle |
string | yes | |
to.name |
string | yes | |
to.image |
string or null | yes | |
to.headline |
string | yes | |
to.email |
string or null | yes | |
contextKind |
string, one of profile, post, event |
yes | |
contextId |
string or null | yes | |
contextTitle |
string or null | yes | |
message |
string | yes | |
status |
string, one of pending, accepted, declined, expired |
yes | |
createdAt |
string (date-time) | yes | |
respondedAt |
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): membership_pending, membership_suspended, validation_failed.