Highlights

Single highlight object:

Field
Type
Description

_id

String

Unique id of highlight

text

String

Text of highlight (required)

title

String

Title of bookmark

color

String

Color of highlight. Default yellow Can be blue, brown, cyan, gray, green, indigo, orange, pink, purple, red, teal, yellow

note

String

Optional note for highlight

created

String

Creation date of highlight

tags

Array

Tags list

link

String

Highlighted page URL

Get all highlights

GET https://api.raindrop.io/rest/v1/highlights

Query Parameters

Name
Type
Description

page

Number

perpage

Number

How many highlights per page. 50 max. Default 25

{
    "result": true,
    "items": [
        {
            "note": "Trully native macOS app",
            "color": "red",
            "text": "Orion is the new WebKit-based browser for Mac",
            "created": "2022-03-21T14:41:34.059Z",
            "tags": ["tag1", "tag2"],
            "_id": "62388e9e48b63606f41e44a6",
            "raindropRef": 123,
            "link": "https://apple.com",
            "title": "Orion Browser"
        },
        {
            "note": "",
            "color": "green",
            "text": "Built on WebKit, Orion gives you a fast, smooth and lightweight browsing experience",
            "created": "2022-03-21T15:13:21.128Z",
            "tags": ["tag1", "tag2"],
            "_id": "62389611058af151c840f667",
            "raindropRef": 123,
            "link": "https://apple.com",
            "title": "Apple"
        }
    ]
}

Get all highlights in a collection

GET https://api.raindrop.io/rest/v1/highlights/{collectionId}

Path Parameters

Name
Type
Description

collectionId*

Number

Collection ID

page

Number

perpage

Number

How many highlights per page. 50 max. Default 25

{
    "result": true,
    "items": [
        {
            "note": "Trully native macOS app",
            "color": "red",
            "text": "Orion is the new WebKit-based browser for Mac",
            "created": "2022-03-21T14:41:34.059Z",
            "tags": ["tag1", "tag2"],
            "_id": "62388e9e48b63606f41e44a6",
            "raindropRef": 123,
            "link": "https://apple.com",
            "title": "Apple"
        },
        {
            "note": "",
            "color": "green",
            "text": "Built on WebKit, Orion gives you a fast, smooth and lightweight browsing experience",
            "created": "2022-03-21T15:13:21.128Z",
            "tags": ["tag1", "tag2"],
            "_id": "62389611058af151c840f667",
            "raindropRef": 123,
            "link": "https://apple.com",
            "title": "Apple"
        }
    ]
}

Get highlights of raindrop

GET https://api.raindrop.io/rest/v1/raindrop/{id}

Path Parameters

Name
Type
Description

id*

number

Existing raindrop ID

{
    "result": true,
    "item": {
        "_id": 373777232,
        "highlights": [
            {
                "note": "Trully native macOS app",
                "color": "red",
                "text": "Orion is the new WebKit-based browser for Mac",
                "created": "2022-03-21T14:41:34.059Z",
                "lastUpdate": "2022-03-22T14:30:52.004Z",
                "_id": "62388e9e48b63606f41e44a6"
            },
            {
                "note": "",
                "color": "green",
                "text": "Built on WebKit, Orion gives you a fast, smooth and lightweight browsing experience",
                "created": "2022-03-21T15:13:21.128Z",
                "lastUpdate": "2022-03-22T09:15:18.751Z",
                "_id": "62389611058af151c840f667"
            }
        ]
    }
}

Add highlight

PUT https://api.raindrop.io/rest/v1/raindrop/{id}

Just specify a highlights array in body with object for each highlight

Fore example:

{"highlights": [ { "text": "Some quote", "color": "red", "note": "Some note" } ] }

Path Parameters

Name
Type
Description

id*

number

Existing raindrop ID

Request Body

Name
Type
Description

highlights*

array

highlights[].text*

String

highlights[].note

String

highlights[].color

String

{
    "result": true,
    "item": {
        "_id": 373777232,
        "highlights": [
            {
                "note": "Trully native macOS app",
                "color": "red",
                "text": "Orion is the new WebKit-based browser for Mac",
                "created": "2022-03-21T14:41:34.059Z",
                "lastUpdate": "2022-03-22T14:30:52.004Z",
                "_id": "62388e9e48b63606f41e44a6"
            },
            {
                "note": "",
                "color": "green",
                "text": "Built on WebKit, Orion gives you a fast, smooth and lightweight browsing experience",
                "created": "2022-03-21T15:13:21.128Z",
                "lastUpdate": "2022-03-22T09:15:18.751Z",
                "_id": "62389611058af151c840f667"
            }
        ]
    }
}

Update highlight

PUT https://api.raindrop.io/rest/v1/raindrop/{id}

Just specify a highlights array in body with object containing particular _id of highlight you want to update and all other fields you want to change.

Fore example:

{"highlights": [ { "_id": "62388e9e48b63606f41e44a6", "note": "New note" } ] }

Path Parameters

Name
Type
Description

id*

number

Existing raindrop ID

Request Body

Name
Type
Description

highlights*

array

highlights[]._id*

String

Particular highlight _id you want to remove

highlights[].text

String

Should be empty string

highlights[].note

String

highlights[].color

String

{
    "result": true,
    "item": {
        "_id": 373777232,
        "highlights": [
            {
                "note": "Trully native macOS app",
                "color": "red",
                "text": "Orion is the new WebKit-based browser for Mac",
                "created": "2022-03-21T14:41:34.059Z",
                "lastUpdate": "2022-03-22T14:30:52.004Z",
                "_id": "62388e9e48b63606f41e44a6"
            },
            {
                "note": "",
                "color": "green",
                "text": "Built on WebKit, Orion gives you a fast, smooth and lightweight browsing experience",
                "created": "2022-03-21T15:13:21.128Z",
                "lastUpdate": "2022-03-22T09:15:18.751Z",
                "_id": "62389611058af151c840f667"
            }
        ]    }}

Remove highlight

PUT https://api.raindrop.io/rest/v1/raindrop/{id}

Just specify a highlights array in body with object containing particular _id of highlight you want to remove and empty string for text field.

Fore example:

{"highlights": [ { "_id": "62388e9e48b63606f41e44a6", "text": "" } ] }

Path Parameters

Name
Type
Description

id*

number

Existing raindrop ID

Request Body

Name
Type
Description

highlights*

array

highlights[]._id*

String

Particular highlight _id you want to remove

highlights[].text*

String

Should be empty string

{
    "result": true,
    "item": {
        "_id": 373777232,
        "highlights": [
            {
                "note": "Trully native macOS app",
                "color": "red",
                "text": "Orion is the new WebKit-based browser for Mac",
                "created": "2022-03-21T14:41:34.059Z",
                "lastUpdate": "2022-03-22T14:30:52.004Z",
                "_id": "62388e9e48b63606f41e44a6"
            },
            {
                "note": "",
                "color": "green",
                "text": "Built on WebKit, Orion gives you a fast, smooth and lightweight browsing experience",
                "created": "2022-03-21T15:13:21.128Z",
                "lastUpdate": "2022-03-22T09:15:18.751Z",
                "_id": "62389611058af151c840f667"
            }
        ]
    }}

Last updated

Was this helpful?