1. Reference
  2. Web API
  3. Stars

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 required

App 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 required

App 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 integer

Maximum number of items to return in the listing. Should be a value between 0 and 100. Default is 25.

skip integer

The number of items to skip. Used together with top to return a specific range of items (for pagination).

count boolean

false to skip counting the total number of matching items; default is true.

count_only boolean

true to only return the number of matching items; when this is specified the response will only contain the count 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}"
Weavy Docs