Skip to main content

Grimoire Integration API (0.2.1)

Download OpenAPI specification:Download

To authorize, use your user's credentials to create valid authorization header.

Add [USERNAME OR EMAIL]:[PASSWORD] and base64 encode it. Then use the resulting value as the Authorization header value, prefixed with Bearer (separated by space).

Example request with proper header (generated from my-username:my-password):

curl --request GET \ 
     --url http://[GRIMOIRE_URL]/api/bookmarks \ 
     --header 'Authorization: Bearer bXktdXNlcm5hbWU6bXktcGFzc3dvcmQ='

Create a new quick bookmark

Create a new quick bookmark. This endpoint is intended to be used by bookmarklet or as a fallback for browser extension.

Authorizations:
basicAuth
query Parameters
url
required
string

The base64 encoded URL to bookmark.

Responses

Response samples

Content type
application/json
{
  • "bookmark": {
    }
}

Retrieve a list of bookmarks

Authorizations:
basicAuth
query Parameters
ids
string
Examples: ids=id1,id2,id3

Array of bookmark IDs to retrieve

Responses

Response samples

Content type
application/json
{
  • "bookmarks": [
    ]
}

Create a new bookmark

Create a new bookmark with the given data.

Authorizations:
basicAuth
Request Body schema: application/json

Bookmark details

url
string

Bookmark URL

title
string

Bookmark title

description
string

Bookmark description

author
string

Bookmark author

content_text
string

Bookmark content text

content_html
string

Bookmark content HTML

content_type
string

Bookmark content type

content_published_date
string

Bookmark content published date

note
string

Bookmark note

icon_url
string

Bookmark icon URL

main_image_url
string

Bookmark main image URL

importance
integer

Bookmark importance

flagged
boolean

Bookmark flagged

category
string

Bookmark category ID

Array of objects (TagCreateDto)

Responses

Request samples

Content type
application/json
{
  • "url": "string",
  • "title": "string",
  • "description": "string",
  • "author": "string",
  • "content_text": "string",
  • "content_html": "string",
  • "content_type": "string",
  • "content_published_date": "string",
  • "note": "string",
  • "icon_url": "string",
  • "main_image_url": "string",
  • "importance": 0,
  • "flagged": true,
  • "category": "string",
  • "tags": [
    ]
}

Response samples

Content type
application/json
{
  • "bookmark": {
    }
}

Update a bookmark

Update a bookmark with the given data.

Authorizations:
basicAuth
Request Body schema: application/json

Bookmark details

id
string

Bookmark ID

url
string

Bookmark URL

title
string

Bookmark title

description
string

Bookmark description

author
string

Bookmark author

content_text
string

Bookmark content text

content_html
string

Bookmark content HTML

content_type
string

Bookmark content type

content_published_date
string

Bookmark content published date

note
string

Bookmark note

icon_url
string

Bookmark icon URL

main_image_url
string

Bookmark main image URL

importance
integer

Bookmark importance

flagged
boolean

Bookmark flagged

category
string

Bookmark category ID

Array of objects (TagCreateDto)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "url": "string",
  • "title": "string",
  • "description": "string",
  • "author": "string",
  • "content_text": "string",
  • "content_html": "string",
  • "content_type": "string",
  • "content_published_date": "string",
  • "note": "string",
  • "icon_url": "string",
  • "main_image_url": "string",
  • "importance": 0,
  • "flagged": true,
  • "category": "string",
  • "tags": [
    ]
}

Response samples

Content type
application/json
{
  • "bookmark": {
    }
}

Delete a bookmark

Delete a bookmark with the given ID.

Authorizations:
basicAuth
query Parameters
id
required
string

The bookmark ID to delete.

Responses

Response samples

Content type
application/json
{
  • "success": true
}

Retrieve all User categories

Authorizations:
basicAuth

Responses

Response samples

Content type
application/json
{
  • "categories": [
    ]
}

Create a new category

Create a new category with the given data.

Authorizations:
basicAuth
Request Body schema: application/json

Category details

name
string

Category name

description
string

Category description

color
string

Category color as hex value

icon
string

Category icon

public
boolean

Category public

archived
boolean

Category archived

parent
string

Category parent ID

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "color": "string",
  • "icon": "string",
  • "public": true,
  • "archived": true,
  • "parent": "string"
}

Response samples

Content type
application/json
{
  • "category": {
    }
}

Update a category

Update a category with the given data.

Authorizations:
basicAuth
Request Body schema: application/json

Category details

id
string

Category ID

name
string

Category name

description
string

Category description

color
string

Category color as hex value

icon
string

Category icon

public
boolean

Category public

archived
boolean

Category archived

parent
string

Category parent ID

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "color": "string",
  • "icon": "string",
  • "public": true,
  • "archived": true,
  • "parent": "string"
}

Response samples

Content type
application/json
{
  • "category": {
    }
}

Retrieve all User tags

Authorizations:
basicAuth

Responses

Response samples

Content type
application/json
{
  • "tags": [
    ]
}

Create a new tag

Create a new tag with the given data.

Authorizations:
basicAuth
Request Body schema: application/json

Tag details

name
string

Tag name

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "tag": {
    }
}