1. Reference
2. Web API
3. Stars

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

skip integer

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

take integer

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

count_only boolean

true to count the number of matching items instead of listing them; when specified the response will only contain the count property.

Example request

curl {WEAVY-URL}/api/stars
-H "Authorization: Bearer {ACCESS-TOKEN}"

Response codes

200 OK
401 Unauthorized

Response schema

{
  "data": [
    {
      "id": "integer",
      "type": "string"
    }
  ],
  "start": "integer",
  "end": "integer",
  "count": "integer"
}

Star app

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

POST /api/apps/{app}/stars

Path parameters

app string required

App identifier (id or uid)

Example request

curl -X POST {WEAVY-URL}/api/apps/acme-chat/stars
-H "Authorization: Bearer {ACCESS-TOKEN}"

Response codes

200 OK

Star file

Add a star to a file on behalf of the authenticated user.

POST /api/files/{id}/stars

Path parameters

id integer required

Id of the file.

Example request

curl -X POST {WEAVY-URL}/api/files/1/stars
-H "Authorization: Bearer {ACCESS-TOKEN}"

Response codes

200 OK

Star post

Add a star to a post on behalf of the authenticated user.

POST /api/posts/{id}/stars

Path parameters

id integer required

Id of the post.

Example request

curl -X POST {WEAVY-URL}/api/posts/1/stars
-H "Authorization: Bearer {ACCESS-TOKEN}"

Response codes

200 OK

Unstar app

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

DELETE /api/apps/{app}/stars

Path parameters

app string required

App identifier (id or uid)

Example request

curl -X DELETE {WEAVY-URL}/api/apps/acme-chat/stars
-H "Authorization: Bearer {ACCESS-TOKEN}"

Response codes

200 OK

Unstar file

Remove a star from a file on behalf of the authenticated user.

DELETE /api/files/{id}/stars

Path parameters

id integer required

Id of the file.

Example request

curl -X DELETE {WEAVY-URL}/api/files/1/stars
-H "Authorization: Bearer {ACCESS-TOKEN}"

Response codes

200 OK

Unstar post

Remove a star from a post on behalf of the authenticated user.

DELETE /api/posts/{id}/stars

Path parameters

id integer required

Id of the post.

Example request

curl -X DELETE {WEAVY-URL}/api/posts/1/stars
-H "Authorization: Bearer {ACCESS-TOKEN}"

Response codes

200 OK

Star comment

Add a star to a comment on behalf of the authenticated user.

POST /api/comments/{id}/stars

Path parameters

id integer required

Id of the comment.

Example request

curl -X POST {WEAVY-URL}/api/comments/1/stars
-H "Authorization: Bearer {ACCESS-TOKEN}"

Response codes

200 OK

Star message

Add a star to a message on behalf of the authenticated user.

POST /api/messages/{id}/stars

Path parameters

id integer required

Id of the message.

Example request

curl -X POST {WEAVY-URL}/api/messages/1/stars
-H "Authorization: Bearer {ACCESS-TOKEN}"

Response codes

200 OK

Unstar comment

Remove a star from a comment on behalf of the authenticated user.

DELETE /api/comments/{id}/stars

Path parameters

id integer required

Id of the comment.

Example request

curl -X DELETE {WEAVY-URL}/api/comments/1/stars
-H "Authorization: Bearer {ACCESS-TOKEN}"

Response codes

200 OK

Unstar message

Remove a star from a message on behalf of the authenticated user.

DELETE /api/messages/{id}/stars

Path parameters

id integer required

Id of the message.

Example request

curl -X DELETE {WEAVY-URL}/api/messages/1/stars
-H "Authorization: Bearer {ACCESS-TOKEN}"

Response codes

200 OK