1. Reference
  2. Web API
  3. Stars

Stars

The Stars API enables bookmarking things for reference and/or follow-up.

Add star

POST /api/apps/{id}/stars

Add a star to an app on behalf of the authenticated user.

Sample request

$ curl -X POST {WEAVY_SERVER}/api/apps/1/stars
-H "Authorization: Bearer {ACCESS_TOKEN}"

Parameters

Name Type Required Description
id integer True App id.

Responses

Status code 204

No Content

Status code 404

application/json

{
  "type": "string",
  "title": "string",
  "status": "integer",
  "detail": "string",
  "instance": "string"
}

Remove star

DELETE /api/apps/{id}/stars

Remove a star from an app on behalf of the authenticated user.

Sample request

$ curl -X DELETE {WEAVY_SERVER}/api/apps/1/stars
-H "Authorization: Bearer {ACCESS_TOKEN}"

Parameters

Name Type Required Description
id integer True App id.

Responses

Status code 204

No Content

Status code 404

application/json

{
  "type": "string",
  "title": "string",
  "status": "integer",
  "detail": "string",
  "instance": "string"
}

List starred items

GET /api/stars

List items starred by the authenticated user.

Sample request

$ curl {WEAVY_SERVER}/api/stars
-H "Authorization: Bearer {ACCESS_TOKEN}"

Parameters

Name Type Required Description
top integer False
skip integer False
count boolean False
count_only boolean False

Responses

Status code 200

application/json

{
  "data": [
    "object"
  ],
  "start": "integer",
  "end": "integer",
  "count": "integer"
}
Weavy Docs