Assets

List assets

GET /api/v1/assets

Parameters

Name	In	Type	Required	Description
`organizationId`	query	string	No	—
`scoutId`	query	string	No	—

Example request

curl -X GET \
"https://api.example.com/api/v1/assets?organizationId=<organizationId>&scoutId=<scoutId>" \
-H "Authorization: Bearer <API_KEY>" \
-H "Content-Type: application/json"

Response body type

—

Create asset

POST /api/v1/assets

Example request

curl -X POST \
"https://api.example.com/api/v1/assets" \
-H "Authorization: Bearer <API_KEY>" \
-H "Content-Type: application/json"

Response body type

—

getAsset

GET /api/v1/assets/{id}

Parameters

Name	In	Type	Required	Description
`id`	path	string	Yes	Convex document id

Example request

curl -X GET \
"https://api.example.com/api/v1/assets/<id>" \
-H "Authorization: Bearer <API_KEY>" \
-H "Content-Type: application/json"

Response body type

—

updateAsset

PATCH /api/v1/assets/{id}

Parameters

Name	In	Type	Required	Description
`id`	path	string	Yes	Convex document id

Example request

curl -X PATCH \
"https://api.example.com/api/v1/assets/<id>" \
-H "Authorization: Bearer <API_KEY>" \
-H "Content-Type: application/json"

Response body type

—

deleteAsset

DELETE /api/v1/assets/{id}

Parameters

Name	In	Type	Required	Description
`id`	path	string	Yes	Convex document id

Example request

curl -X DELETE \
"https://api.example.com/api/v1/assets/<id>" \
-H "Authorization: Bearer <API_KEY>" \
-H "Content-Type: application/json"

Response body type

—