Collection methods

get
Get root collections
https://api.raindrop.io/rest/v1/collections
Returns JSON-encoded array containing all root collections
Request
Response
Request
​
Response
200: OK
{
  "result": true,
  "items": [
    {
      "_id": 8492393,
      "access": {
        "level": 4,
        "draggable": true
      },
      "collaborators": {
        "$id": "5dc1759a0e123be5f2654b6f"
      },
      "color": "#0c797d",
      "count": 16,
      "cover": [
        "https://up.raindrop.io/collection/thumbs/849/239/3/333ce18769311113836cf93a223a14a3.png"
      ],
      "created": "2019-10-09T11:49:53.518Z",
      "expanded": false,
      "lastUpdate": "2019-11-27T17:51:19.085Z",
      "public": false,
      "sort": 8492393,
      "title": "Development",
      "user": {
        "$id": 32
      },
      "view": "list"
    }
  ]
}
get
Get child collections
https://api.raindrop.io/rest/v1/collections/childrens
Returns JSON-encoded array containing all nested collections (that have positive parent.$id)
Request
Response
Request
​
Response
200: OK
{
  "result": true,
  "items": [
    {
      "_id": 8492393,
      "access": {
        "level": 4,
        "draggable": true
      },
      "collaborators": {
        "$id": "5dc1759a0e123be5f2654b6f"
      },
      "color": "#0c797d",
      "count": 16,
      "cover": [
        "https://up.raindrop.io/collection/thumbs/849/239/3/333ce18769311113836cf93a223a14a3.png"
      ],
      "created": "2019-10-09T11:49:53.518Z",
      "expanded": false,
      "lastUpdate": "2019-11-27T17:51:19.085Z",
      "parent_id": 1111,
      "public": false,
      "sort": 8492393,
      "title": "Development",
      "user": {
        "$id": 32
      },
      "view": "list"
    }
  ]
}
get
Get collection
https://api.raindrop.io/rest/v1/collection/{id}
Request
Response
Request
Path Parameters
id
required
number
Collection ID
Response
200: OK
{
  "result": true,
  "item": {
    "_id": 8492393,
    "access": {
      "for": 32,
      "level": 4,
      "root": true,
      "draggable": true
    },
    "author": true,
    "collaborators": {
      "$id": "5dc1759a0e123be5f2654b6f"
    },
    "color": "#0c797d",
    "count": 16,
    "cover": [
      "https://up.raindrop.io/collection/thumbs/849/239/3/333ce18769311113836cf93a223a14a3.png"
    ],
    "created": "2019-10-09T11:49:53.518Z",
    "expanded": false,
    "lastUpdate": "2019-11-27T17:51:19.085Z",
    "public": false,
    "sort": 8492393,
    "title": "Development",
    "user": {
      "$id": 32
    },
    "view": "list"
  }
}
post
Create collection
https://api.raindrop.io/rest/v1/collection
Create a new collection
Request
Response
Request
Body Parameters
view
optional
string
More details in "Fields"
title
optional
string
Name of the collection
sort
optional
number
The order of collection (descending). Defines the position of the collection among all the collections with the same parent.$id
public
optional
boolean
Collection and raindrops that it contains will be accessible without authentication?
parent.$id
optional
integer
The ID of parent collection. Empty for root collections
cover
optional
array
Collection cover url
Response
200: OK
{
    "result": true,
    "item": {
        ...
    }
}
400: Bad Request
Incorrect 'view' field value
{
    "result": false,
    "error": "view",
    "errorMessage": "Collection validation failed: view: `bla` is not a valid enum value for path `view`."
}
put
Update collection
https://api.raindrop.io/rest/v1/collection/{id}
Update an existing collection
Request
Response
Request
Path Parameters
id
required
number
Existing collection id
Body Parameters
expanded
optional
boolean
Whether the collection`s sub-collections are expanded
view
optional
string
More details in "Fields"
title
optional
string
Name of the collection
sort
optional
number
The order of collection (descending). Defines the position of the collection among all the collections with the same parent.$id
public
optional
boolean
Collection and raindrops that it contains will be accessible without authentication?
parent.$id
optional
integer
The ID of parent collection. Empty for root collections
cover
optional
array
Collection cover url
Response
200: OK
{
    "result": true,
    "item": {
        ...
    }
}
put
Upload cover
https://api.raindrop.io/rest/v1/collection/{id}/cover
It's possible to upload cover from desktop. PNG, GIF and JPEG supported
Request
Response
Request
Path Parameters
id
required
string
Existing collection ID
Headers
Content-Type
required
string
multipart/form-data
Form Data Parameters
cover
required
object
File
Response
200: OK
{
    "result": true,
    "item": {
        ...
    }
}
delete
Remove collection
https://api.raindrop.io/rest/v1/collection/{id}
Remove an existing collection and all its descendants.
Raindrops will be moved to "Trash" collection
Request
Response
Request
Path Parameters
id
required
number
Existing collection ID
Response
200: OK
{
    "result": true
}
delete
Remove multiple collections
https://api.raindrop.io/rest/v1/collections
Remove multiple collections at once.
Nested collections are ignored (include ID's in ids array to remove them)
Request
Response
Request
Body Parameters
ids
required
array
Array of collection ID
Response
200: OK
​
put
Reorder all collections
https://api.raindrop.io/rest/v1/collections
Updates order of all collections 
Request
Response
Request
Body Parameters
sort
required
string
Change order of all collections.
Possible values:
"title" - sort alphabetically ascending
"-title" - sort alphabetically descending
"-count" - sort by raindrops count descending
Response
200: OK
{
    "result": true
}
put
Expand/collapse all collections
https://api.raindrop.io/rest/v1/collections
Request
Response
Request
Path Parameters
expanded
required
boolean
TRUE = expand all
FALSE = collapse all
Response
200: OK
{
    "result": true
}
put
Merge collections
https://api.raindrop.io/rest/v1/collections/merge
Merge multiple collections
Request
Response
Request
Body Parameters
to
optional
number
Collection ID where listed collection ids will be merged
ids
optional
array
Collection ID's
Response
200: OK
​
put
Remove all empty collections
https://api.raindrop.io/rest/v1/collections/clean
Request
Response
Request
​
Response
200: OK
{
    "result": true,
    "count": 3
}
delete
Empty Trash
https://api.raindrop.io/rest/v1/collection/-99
Request
Response
Request
​
Response
200: OK
{
  "result": true
}
get
Get system collections count
https://api.raindrop.io/rest/v1/user/stats
Request
Response
Request
​
Response
200: OK
{
  "items": [
    {
      "_id": 0,
      "count": 1570
    },
    {
      "_id": -1,
      "count": 34
    },
    {
      "_id": -99,
      "count": 543
    }
  ],
  "meta": {
    "pro": true,
    "_id": 32,
    "changedBookmarksDate": "2020-02-11T11:23:43.143Z",
    "duplicates": {
      "count": 3
    },
    "broken": {
      "count": 31
    }
  },
  "result": true
}
​

Rest API v1 - Previous

Collections

Nested structure

Last updated 4 months ago

Collection methods

getGet root collections

getGet child collections

getGet collection

postCreate collection

putUpdate collection

putUpload cover

deleteRemove collection

deleteRemove multiple collections

putReorder all collections

putExpand/collapse all collections

putMerge collections

putRemove all empty collections

deleteEmpty Trash

getGet system collections count

get
Get root collections

get
Get child collections

get
Get collection

post
Create collection

put
Update collection

put
Upload cover

delete
Remove collection

delete
Remove multiple collections

put
Reorder all collections

put
Expand/collapse all collections

put
Merge collections

put
Remove all empty collections

delete
Empty Trash

get
Get system collections count