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