Reference

GET

/bookmarks

Search for bookmarks

Query Parameters

query
Required
string

Search query string

Example: "Tech blogs"Format: "string"
Status codeDescription
200Successful
401Unauthorized
403Forbidden
429Too Many Requests
curl
curl -X GET "https://briefkastenhq.com/bookmarks"

List of bookmark results

Example Response
[
  {
    "id": "cjld2cjxh0000qzrmn831i7rn",
    "userId": "cjld2cyuq0000t3rmniod1foy",
    "title": "Tech Blog",
    "url": "https://engadget.com",
    "category?": "string",
    "desc?": "string",
    "tags?": [
      {
        "id": "tz4a98xxat96iws9zmbrgj3a",
        "userId": "q6jy42jq92xypbao731oj7x8",
        "name": "string"
      }
    ]
  }
]

POST

/bookmarks

Create bookmarks

Request Body

The bookmark to create

idstring

Example: "cjld2cjxh0000qzrmn831i7rn"Format: "cuid"

userIdstring

Linked user id

Example: "cjld2cyuq0000t3rmniod1foy"Format: "cuid"

title
Required
string

Page or link title

Example: "Tech Blog"

url
Required
string

Link to the bookmark

Example: "https://engadget.com"

category?string

Category grouping for your bookmark

desc?string

Description of the bookmark

tags?array of object

Status codeDescription
200Successful
401Unauthorized
403Forbidden
429Too Many Requests
curl
curl -X POST "https://briefkastenhq.com/bookmarks" \
  -d '{
  "id": "cjld2cjxh0000qzrmn831i7rn",
  "userId": "cjld2cyuq0000t3rmniod1foy",
  "title": "Tech Blog",
  "url": "https://engadget.com",
  "category?": "string",
  "desc?": "string",
  "tags?": [
    {
      "id": "tz4a98xxat96iws9zmbrgj3a",
      "userId": "q6jy42jq92xypbao731oj7x8",
      "name": "string"
    }
  ]
}'
Example Response
{
  "id": "cjld2cjxh0000qzrmn831i7rn",
  "userId": "cjld2cyuq0000t3rmniod1foy",
  "title": "Tech Blog",
  "url": "https://engadget.com",
  "category?": "string",
  "desc?": "string",
  "tags?": [
    {
      "id": "tz4a98xxat96iws9zmbrgj3a",
      "userId": "q6jy42jq92xypbao731oj7x8",
      "name": "string"
    }
  ]
}

DELETE

/bookmarks

Delete bookmarks

Request Body

Bookmark ID to delete

idstring

Example: "cjld2cjxh0000qzrmn831i7rn"Format: "cuid"
Status codeDescription
204No Content
401Unauthorized
403Forbidden
429Too Many Requests
curl
curl -X DELETE "https://briefkastenhq.com/bookmarks" \
  -d '{
  "id": "cjld2cjxh0000qzrmn831i7rn"
}'

GET

/tags

Search for tags

Query Parameters

querystring

Query

Status codeDescription
200Successful
401Unauthorized
403Forbidden
429Too Many Requests
curl
curl -X GET "https://briefkastenhq.com/tags"

List of tag results

Example Response
[
  {
    "id": "tz4a98xxat96iws9zmbrgj3a",
    "userId": "q6jy42jq92xypbao731oj7x8",
    "name": "string"
  }
]

POST

/tags

Create tag

Request Body

The tag to create

idstring

Example: "tz4a98xxat96iws9zmbrgj3a"Format: "cuid"

userIdstring

Example: "q6jy42jq92xypbao731oj7x8"Format: "cuid"

name
Required
string

Query Parameters

querystring

Query

Status codeDescription
200Successful
401Unauthorized
403Forbidden
429Too Many Requests
curl
curl -X POST "https://briefkastenhq.com/tags" \
  -d '{
  "id": "tz4a98xxat96iws9zmbrgj3a",
  "userId": "q6jy42jq92xypbao731oj7x8",
  "name": "string"
}'
Example Response
{
  "id": "tz4a98xxat96iws9zmbrgj3a",
  "userId": "q6jy42jq92xypbao731oj7x8",
  "name": "string"
}

DELETE

/tags

Delete tag

Request Body

Tag ID to delete

idstring

Example: "cjld2cjxh0000qzrmn831i7rn"Format: "cuid"
Status codeDescription
204No Content
401Unauthorized
403Forbidden
429Too Many Requests
curl
curl -X DELETE "https://briefkastenhq.com/tags" \
  -d '{
  "id": "cjld2cjxh0000qzrmn831i7rn"
}'

GET

/categories

Search for categories

Query Parameters

querystring

Query

Status codeDescription
200Successful
401Unauthorized
403Forbidden
429Too Many Requests
curl
curl -X GET "https://briefkastenhq.com/categories"

List of categories results

Example Response
[
  {
    "id": "pfh0haxfpzowht3oi213cqos",
    "userId": "nc6bzmkmd014706rfda898to",
    "name": "string",
    "description": "string"
  }
]

POST

/categories

Create categories

Request Body

The category to create

idstring

Example: "pfh0haxfpzowht3oi213cqos"Format: "cuid"

userIdstring

Example: "nc6bzmkmd014706rfda898to"Format: "cuid"

name
Required
string

Name of your category

descriptionstring

Description for the category

Query Parameters

querystring

Query

Status codeDescription
200Successful
401Unauthorized
403Forbidden
429Too Many Requests
curl
curl -X POST "https://briefkastenhq.com/categories" \
  -d '{
  "id": "pfh0haxfpzowht3oi213cqos",
  "userId": "nc6bzmkmd014706rfda898to",
  "name": "string",
  "description": "string"
}'
Example Response
{
  "id": "pfh0haxfpzowht3oi213cqos",
  "userId": "nc6bzmkmd014706rfda898to",
  "name": "string",
  "description": "string"
}

DELETE

/categories

Delete categories

Request Body

Category ID to delete

idstring

Example: "cjld2cjxh0000qzrmn831i7rn"Format: "cuid"
Status codeDescription
204No Content
401Unauthorized
403Forbidden
429Too Many Requests
curl
curl -X DELETE "https://briefkastenhq.com/categories" \
  -d '{
  "id": "cjld2cjxh0000qzrmn831i7rn"
}'

Last updated on

Overview

Database