progress
For users and admins: the progress 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/progress
Section titled “GET /v1/progress”Operation id ProgressController_list.
Parameters
Section titled “Parameters”| Name | In | Required | Type | Notes |
|---|---|---|---|---|
limit |
query | no | integer | |
cursor |
query | no | string | |
kind |
query | no | any | |
feed |
query | no | boolean | Only entries shared with you, the way the post feed works. |
mine |
query | no | boolean | Only entries you wrote, regardless of visibility. |
project |
query | no | string | Only entries on this project. |
author |
query | no | string | Only entries a handle wrote. |
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/progress
Section titled “POST /v1/progress”Operation id ProgressController_create.
Request body
Section titled “Request body”| Field | Type | Required | Notes |
|---|---|---|---|
kind |
string, one of milestone, customer, program, learning |
yes | |
title |
string | yes | min length 3, max length 140 |
note |
string | yes | max length 2000, default "" |
occurredAt |
string (date-time) | no | |
projectId |
string | no | min length 1 |
publishTo |
object | yes | default {"orgSlugs":[],"public":false} |
publishTo.orgSlugs |
array of string | yes | max items 20, default [] |
publishTo.public |
boolean | yes | default false |
linkedin |
boolean | yes | default false |
Responses
Section titled “Responses”200
| Field | Type | Required | Notes |
|---|---|---|---|
id |
string | yes | |
authorUserId |
string | yes | |
authorHandle |
string or null | yes | |
authorName |
string | yes | |
authorImage |
string or null | yes | |
projectId |
string or null | yes | |
projectName |
string or null | yes | |
kind |
string, one of milestone, customer, program, learning |
yes | |
title |
string | yes | min length 3, max length 140 |
note |
string | yes | max length 2000 |
photo |
string or null | yes | |
occurredAt |
string (date-time) | yes | |
targets |
object | yes | |
targets.orgs |
array of object | yes | |
targets.public |
boolean | yes | |
linkedinPostUrl |
string or null | yes | |
canEdit |
boolean | yes | |
createdAt |
string | yes | |
updatedAt |
string | yes | |
warnings |
array of string | no |
Problem types
Section titled “Problem types”Derived from the source scan (handler, one level of service calls, guards and pipes): linkedin_not_linked, linkedin_relink_required, linkedin_share_unavailable, linkedin_unavailable, membership_pending, membership_suspended, validation_failed.
GET /v1/progress/{id}
Section titled “GET /v1/progress/{id}”Operation id ProgressController_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 | |
authorUserId |
string | yes | |
authorHandle |
string or null | yes | |
authorName |
string | yes | |
authorImage |
string or null | yes | |
projectId |
string or null | yes | |
projectName |
string or null | yes | |
kind |
string, one of milestone, customer, program, learning |
yes | |
title |
string | yes | min length 3, max length 140 |
note |
string | yes | max length 2000 |
photo |
string or null | yes | |
occurredAt |
string (date-time) | yes | |
targets |
object | yes | |
targets.orgs |
array of object | yes | |
targets.public |
boolean | yes | |
linkedinPostUrl |
string or null | yes | |
canEdit |
boolean | yes | |
createdAt |
string | yes | |
updatedAt |
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.
PATCH /v1/progress/{id}
Section titled “PATCH /v1/progress/{id}”Operation id ProgressController_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 milestone, customer, program, learning |
no | |
title |
string | no | min length 3, max length 140 |
note |
string | no | max length 2000 |
occurredAt |
string (date-time) | no |
Responses
Section titled “Responses”200
| Field | Type | Required | Notes |
|---|---|---|---|
id |
string | yes | |
authorUserId |
string | yes | |
authorHandle |
string or null | yes | |
authorName |
string | yes | |
authorImage |
string or null | yes | |
projectId |
string or null | yes | |
projectName |
string or null | yes | |
kind |
string, one of milestone, customer, program, learning |
yes | |
title |
string | yes | min length 3, max length 140 |
note |
string | yes | max length 2000 |
photo |
string or null | yes | |
occurredAt |
string (date-time) | yes | |
targets |
object | yes | |
targets.orgs |
array of object | yes | |
targets.public |
boolean | yes | |
linkedinPostUrl |
string or null | yes | |
canEdit |
boolean | yes | |
createdAt |
string | yes | |
updatedAt |
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, validation_failed.
DELETE /v1/progress/{id}
Section titled “DELETE /v1/progress/{id}”Operation id ProgressController_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.
POST /v1/progress/{id}/linkedin
Section titled “POST /v1/progress/{id}/linkedin”Operation id ProgressController_shareToLinkedIn.
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 | |
authorUserId |
string | yes | |
authorHandle |
string or null | yes | |
authorName |
string | yes | |
authorImage |
string or null | yes | |
projectId |
string or null | yes | |
projectName |
string or null | yes | |
kind |
string, one of milestone, customer, program, learning |
yes | |
title |
string | yes | min length 3, max length 140 |
note |
string | yes | max length 2000 |
photo |
string or null | yes | |
occurredAt |
string (date-time) | yes | |
targets |
object | yes | |
targets.orgs |
array of object | yes | |
targets.public |
boolean | yes | |
linkedinPostUrl |
string or null | yes | |
canEdit |
boolean | yes | |
createdAt |
string | yes | |
updatedAt |
string | yes |
Problem types
Section titled “Problem types”Derived from the source scan (handler, one level of service calls, guards and pipes): linkedin_not_linked, linkedin_relink_required, linkedin_share_unavailable, linkedin_unavailable, membership_pending, membership_suspended.
PUT /v1/progress/{id}/photo
Section titled “PUT /v1/progress/{id}/photo”Operation id ProgressController_setPhoto.
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 | |
authorUserId |
string | yes | |
authorHandle |
string or null | yes | |
authorName |
string | yes | |
authorImage |
string or null | yes | |
projectId |
string or null | yes | |
projectName |
string or null | yes | |
kind |
string, one of milestone, customer, program, learning |
yes | |
title |
string | yes | min length 3, max length 140 |
note |
string | yes | max length 2000 |
photo |
string or null | yes | |
occurredAt |
string (date-time) | yes | |
targets |
object | yes | |
targets.orgs |
array of object | yes | |
targets.public |
boolean | yes | |
linkedinPostUrl |
string or null | yes | |
canEdit |
boolean | yes | |
createdAt |
string | yes | |
updatedAt |
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.
DELETE /v1/progress/{id}/photo
Section titled “DELETE /v1/progress/{id}/photo”Operation id ProgressController_removePhoto.
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 | |
authorUserId |
string | yes | |
authorHandle |
string or null | yes | |
authorName |
string | yes | |
authorImage |
string or null | yes | |
projectId |
string or null | yes | |
projectName |
string or null | yes | |
kind |
string, one of milestone, customer, program, learning |
yes | |
title |
string | yes | min length 3, max length 140 |
note |
string | yes | max length 2000 |
photo |
string or null | yes | |
occurredAt |
string (date-time) | yes | |
targets |
object | yes | |
targets.orgs |
array of object | yes | |
targets.public |
boolean | yes | |
linkedinPostUrl |
string or null | yes | |
canEdit |
boolean | yes | |
createdAt |
string | yes | |
updatedAt |
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.
PUT /v1/progress/{id}/photo/from-url
Section titled “PUT /v1/progress/{id}/photo/from-url”Operation id ProgressController_setPhotoFromUrl.
Parameters
Section titled “Parameters”| Name | In | Required | Type | Notes |
|---|---|---|---|---|
id |
path | yes | string |
Request body
Section titled “Request body”| Field | Type | Required | Notes |
|---|---|---|---|
url |
string (uri) | yes | max length 2000 |
Responses
Section titled “Responses”200
| Field | Type | Required | Notes |
|---|---|---|---|
id |
string | yes | |
authorUserId |
string | yes | |
authorHandle |
string or null | yes | |
authorName |
string | yes | |
authorImage |
string or null | yes | |
projectId |
string or null | yes | |
projectName |
string or null | yes | |
kind |
string, one of milestone, customer, program, learning |
yes | |
title |
string | yes | min length 3, max length 140 |
note |
string | yes | max length 2000 |
photo |
string or null | yes | |
occurredAt |
string (date-time) | yes | |
targets |
object | yes | |
targets.orgs |
array of object | yes | |
targets.public |
boolean | yes | |
linkedinPostUrl |
string or null | yes | |
canEdit |
boolean | yes | |
createdAt |
string | yes | |
updatedAt |
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, validation_failed.