Welcome to the REST API. Below, you’ll find a full listing of all the available endpoints. As we add more endpoints, they will be automatically documented here and available through the Developer Console.
For more information about a particular endpoint, click on its name under the Resource header. You’ll be taken to the endpoint’s documentation page, which includes what query parameters the endpoint will except, what the JSON object’s parameters will be in the response, and an example query/response.
| Resource | Description |
|---|---|
| GET/me | Meta data about auth token's User |
| GET/me/likes/ | List the currently authorized user's likes |
| Resource | Description |
|---|---|
| GET/sites/$site | Information about a site ID/domain |
| Resource | Description |
|---|---|
| GET/sites/$site/posts/ | Return matching Posts |
| GET/sites/$site/posts/$post_ID | Return a single Post (by ID) |
| POST/sites/$site/posts/$post_ID | Edit a Post |
| GET/sites/$site/posts/slug:$post_slug | Return a single Post (by slug) |
| POST/sites/$site/posts/new | Create a Post |
| POST/sites/$site/posts/$post_ID/delete | Delete a Post. Note: If the post object is of type post or page and the trash is enabled, this request will send the post to the trash. A second request will permanently delete the post. |
| GET/sites/$site/posts/$post_ID/likes/ | List the Likes for a Post |
| POST/sites/$site/posts/$post_ID/likes/new | Like a Post |
| POST/sites/$site/posts/$post_ID/likes/mine/delete | Remove your Like from a Post |
| GET/sites/$site/posts/$post_ID/likes/mine/ | Get your Like status for a Post |
| GET/sites/$site/posts/$post_ID/reblogs/mine | Get Reblog status for a Post |
| POST/sites/$site/posts/$post_ID/reblogs/new | Reblog a Post |
| Resource | Description |
|---|---|
| GET/sites/$site/comments/ | Return recent Comments |
| GET/sites/$site/posts/$post_ID/replies/ | Return recent Comments for a Post |
| GET/sites/$site/comments/$comment_ID | Return a single Comment |
| POST/sites/$site/comments/$comment_ID | Edit a Comment |
| POST/sites/$site/posts/$post_ID/replies/new | Create a Comment on a Post |
| POST/sites/$site/comments/$comment_ID/replies/new | Create a Comment as a reply to another Comment |
| POST/sites/$site/comments/$comment_ID/delete | Delete a Comment |
| Resource | Description |
|---|---|
| GET/sites/$site/categories/slug:$category | Returns information on a single Category |
| POST/sites/$site/categories/slug:$category | Edit a Category |
| GET/sites/$site/tags/slug:$tag | Returns information on a single Tag |
| POST/sites/$site/tags/slug:$tag | Edit a Tag |
| POST/sites/$site/categories/new | Create a new Category |
| POST/sites/$site/tags/new | Create a new Tag |
| POST/sites/$site/categories/slug:$category/delete | Delete a Category |
| POST/sites/$site/tags/slug:$tag/delete | Delete a Tag |
| Resource | Description |
|---|---|
| POST/sites/$site/follows/new | Follow a Blog |
| POST/sites/$site/follows/mine/delete | Unfollow a Blog |
| GET/sites/$site/follows/mine | Get Blog Following status for this User |
| Resource | Description |
|---|---|
| GET/freshly-pressed/ | List Freshly Pressed Posts |
| Resource | Description |
|---|---|
| GET/notifications/ | Reverse-chronologically list User Notifications |
| GET/notifications/$note_ID | Get a Notification |
| POST/notifications/seen | Set the timestamp of the most recently seen Notification |
| POST/notifications/read | Mark a set of Notifications as read |
| Resource | Description |
|---|---|
| GET/test/$ID | Test GET requests |
| POST/test/$ID | Test POST requests |