Stars
The Stars API enables bookmarking things for reference and/or follow-up.
Add star
Add a star to an app on behalf of the authenticated user.
POST /api/apps/{id}/stars
Path parameters
id
integer requiredApp id.
Response codes
204 No Content
404 Not Found
Code sample
$ curl -X POST {WEAVY_SERVER}/api/apps/1/stars
-H "Authorization: Bearer {ACCESS-TOKEN}"
Remove star
Remove a star from an app on behalf of the authenticated user.
DELETE /api/apps/{id}/stars
Path parameters
id
integer requiredApp id.
Response codes
204 No Content
404 Not Found
Code sample
$ curl -X DELETE {WEAVY_SERVER}/api/apps/1/stars
-H "Authorization: Bearer {ACCESS-TOKEN}"
List starred items
List items starred by the authenticated user.
GET /api/stars
Query parameters
top
integerMaximum number of items to return in the listing. Should be a value between
0
and100
. Default is25
.
skip
integerThe number of items to skip. Used together with
top
to return a specific range of items (for pagination).
count
booleanfalse
to skip counting the total number of matching items; default istrue
.
count_only
booleantrue
to only return the number of matching items; when this is specified the response will only contain thecount
property.
Response codes
200 Success
{
"data": [
"object"
],
"start": "integer",
"end": "integer",
"count": "integer"
}
Code sample
curl https://{WEAVY-SERVER}/api/stars
-H "Authorization: Bearer {ACCESS-TOKEN}"