Multiple raindrops

Common parameters

To filter, sort or limit raindrops use one of the parameters described below. Check each method for exact list of supported parameters.

Parameter

Type

Description

collectionId

Integer

Path parameter that specify from which collection to get raindrops. Or specify one of system:

0 to get all (except Trash)

-1 to get from "Unsorted"

-99 to get from "Trash"

Warning: update or remove methods not support 0 yet. Will be fixed in future.

search

String

More details below

sort

String

Query parameter for sorting:

-created by date descending (default)

created by date ascending

score by relevancy (only applicable when search is specified)

-sort by order

title by title (ascending)

-title by title (descending)

domain by hostname (ascending)

-domain by hostname (descending)

page

Integer

Query parameter. 0, 1, 2, 3 ...

perpage

Integer

Query parameter. How many raindrops per page. 50 max

ids

Array<Integer>

You can specify exact raindrop ID's for batch update/remove methods

Search parameter

Query parameter to find and/or filter raindrops. Specified as url-encoded JSON serialized string:

[{"key":"word","val":"text"}]

As you noticed this is an array with key and val parameters:

key

val

Description

word

any text

Full text search by title, description, tags, URL and page content

tag

tag name

Find raindrops with exact tags

notag

Find raindrops without any tags

important

Raindrops marked as "favorite"

type

link article image document or audio

Raindrop type

domain

hostname

Find from hostname

broken

Broken links

So for example if you want to find all raindrops with tag "apple" and "ios 13" phrase in text, you need to call URL like this:

/rest/v1/raindrops/0?search=[{"key":"tag","val":"apple"},{"key":"word","val":"ios 13"}]

get
Get raindrops

https://api.raindrop.io/rest/v1/raindrops/{collectionId}
Request
Response
Request
Path Parameters
collectionId
required
number
Collection ID
Query Parameters
sort
optional
string
perpage
optional
number
page
optional
number
search
optional
string
Response
200: OK

post
Create many raindrops

https://api.raindrop.io/rest/v1/raindrops
Request
Response
Request
Body Parameters
items
optional
array
Array of objects. Format of single object described in "Create single raindrop". Maximum 100 objects in array!
Response
200: OK
{
"result": true,
"items": [
{
...
}
]
}

put
Update many raindrops

https://api.raindrop.io/rest/v1/raindrops/{collectionId}
Specify optional search and/or ids parameters to limit raindrops that will be updated. Possible fields that could be updated are described in "Body Parameters"
Request
Response
Request
Path Parameters
collectionId
required
number
Body Parameters
ids
optional
array
important
optional
boolean
TRUE - mark as "favorite" FALSE - unmark as "favorite"
tags
optional
array
Will append specified tags to raindrops. Or will remove all tags from raindrops if [] (empty array) is specified
media
optional
array
Will append specified media items to raindrops. Or will remove all media from raindrops if [] (empty array) is specified
cover
optional
string
Set URL for cover. Tip: specify <screenshot> to set screenshots for all raindrops
collection
optional
object
Specify {"$id": collectionId} to move raindrops to other collection
Response
200: OK

delete
Remove many raindrops

https://api.raindrop.io/rest/v1/raindrops/{collectionId}
Specify optional search and/or ids parameters to limit raindrops that will be moved to "Trash" When :collectionId is -99, raindrops will be permanently removed!
Request
Response
Request
Path Parameters
collectionId
required
number
Query Parameters
search
optional
string
Body Parameters
ids
optional
array
Response
200: OK
{
"result": true,
"modified": 330
}