Posterous API Reference

Working with Users

Users

Retrieve the current user’s information GET users/me

Parameter Name Value Description
api_token Please login to get your API token. Your authentication token
Loading × Clear Response
  • Request URL:
  • Response:

        

Creating Users

Create a user with a primary site POST users

Platform users only. Learn more about platform.
Parameter Name Value Description
api_token Please login to get your API token. Your authentication token
nickname The user's nickname
password The user's password
site[hostname] The hostname of the new site i.e. hostname.posterous.com
site[virtual_host] The custom domain name of the new site i.e. myawesomesite.com
site[name] The name of the site
site[is_private] Set to true or 1 to make this site private, or false or 0 to make it public
site[is_group] Set to true or 1 to make this site a group, false or 0 otherwise
site[time_zone] A valid time zone name, as found here
site[subhead] The subtitle for the site
Loading × Clear Response
  • Request URL:
  • Response:

        

Subscriptions

Retrieve a user's subscribed sites GET users/me/subscriptions

Parameter Name Value Description
api_token Please login to get your API token. Your authentication token
page The page number
Loading × Clear Response
  • Request URL:
  • Response:

        

Retrieve the posts for a user's subscriptions GET users/me/subscriptions/posts

Parameter Name Value Description
api_token Please login to get your API token. Your authentication token
page The page number
Loading × Clear Response
  • Request URL:
  • Response:

        

Working with Sites

Including autopost, site profiles, themes, and contributors.

Sites

Retrieve a list of sites GET sites

Parameter Name Value Description
api_token Please login to get your API token. Your authentication token
Loading × Clear Response
  • Request URL:
  • Response:

        

Create a new site POST sites

Parameter Name Value Description
api_token Please login to get your API token. Your authentication token
site[hostname] The hostname of the new site i.e. hostname.posterous.com
site[virtual_host] The custom domain name of the new site i.e. myawesomesite.com
site[name] The name of the site
site[is_private] Set to true or 1 to make this site private, or false or 0 to make it public
site[is_group] Set to true or 1 to make this site a group, false or 0 otherwise
site[time_zone] A valid time zone name, as found here
site[subhead] The subtitle for the site
Loading × Clear Response
  • Request URL:
  • Response:

        

Retrieve a single site GET sites/:id

Parameter Name Value Description
api_token Please login to get your API token. Your authentication token
id (URL param) The ID number of the site to retrieve
Loading × Clear Response
  • Request URL:
  • Response:

        

Update a single site PUT sites/:id

Parameter Name Value Description
api_token Please login to get your API token. Your authentication token
id (URL param) The ID number of the site to update
site[hostname] The hostname of the new site i.e. hostname.posterous.com
site[name] The name of the site
site[is_private] Set to true or 1 to make this site private, or false or 0 to make it public
site[is_group] Set to true or 1 to make this site a group, false or 0 otherwise
site[time_zone] A valid time zone name, as found here
site[subhead] The subtitle for the site
Loading × Clear Response
  • Request URL:
  • Response:

        

Delete a single site DELETE sites/:id

Parameter Name Value Description
api_token Please login to get your API token. Your authentication token
id (URL param) The ID number of the site to delete
Loading × Clear Response
  • Request URL:
  • Response:

        

Retrieve twenty random photos GET sites/:id/photos/public

Parameter Name Value Description
id (URL param) The ID number of the site from which photos will be retrieved
page Determines which page of photos to return. Twenty photos are included on each page.
since_id Post ID number. Restricts the returned photos those attached to posts after the post with the provided ID number.
Loading × Clear Response
  • Request URL:
  • Response:

        

Subscribes the currently authenticated user to the site PUT sites/:id/subscribe

Parameter Name Value Description
api_token Please login to get your API token. Your authentication token
id (URL param) The site’s ID number
Loading × Clear Response
  • Request URL:
  • Response:

        

Unsubscribes the currently authenticated user from the site PUT sites/:id/unsubscribe

Parameter Name Value Description
api_token Please login to get your API token. Your authentication token
id (URL param) The site’s ID number
Loading × Clear Response
  • Request URL:
  • Response:

        

Set a new header image for the site POST sites/:id/header_image

Parameter Name Value Description
api_token Please login to get your API token. Your authentication token
id (URL param) The site’s ID number
file File uploads are not available in the API console The image to set as this site's header image
Loading × Clear Response
  • Request URL:
  • Response:

        

Delete the site’s header image DELETE sites/:id/header_image

Parameter Name Value Description
api_token Please login to get your API token. Your authentication token
id (URL param) The site’s ID number
Loading × Clear Response
  • Request URL:
  • Response:

        

Site Profile

Retrieve a site’s profile GET sites/:site_id/profile

Parameter Name Value Description
api_token Please login to get your API token. Your authentication token
site_id (URL param) The site’s ID number
Loading × Clear Response
  • Request URL:
  • Response:

        

Create a new site profile POST sites/:site_id/profile

Parameter Name Value Description
api_token Please login to get your API token. Your authentication token
site_id (URL param) The site’s ID number
site_profile[group_profile_name] The site profile name.
site_profile[body] The site profile’s information and bio.
Loading × Clear Response
  • Request URL:
  • Response:

        

Update a site’s profile PUT sites/:site_id/profile

Parameter Name Value Description
api_token Please login to get your API token. Your authentication token
site_id (URL param) The site’s ID number
site_profile[group_profile_name] The site profile name.
site_profile[body] The site profile’s information and bio.
Loading × Clear Response
  • Request URL:
  • Response:

        

Delete a site’s profile DELETE sites/:site_id/profile

Parameter Name Value Description
api_token Please login to get your API token. Your authentication token
site_id (URL param) The site’s ID number
Loading × Clear Response
  • Request URL:
  • Response:

        

Update a site’s profile image PUT sites/:site_id/profile/image

Parameter Name Value Description
api_token Please login to get your API token. Your authentication token
site_id (URL param) The site’s ID number
file File uploads are not available in the API console The image to use for the profile image.
Loading × Clear Response
  • Request URL:
  • Response:

        

Delete a site’s profile image DELETE sites/:site_id/profile/image

Parameter Name Value Description
api_token Please login to get your API token. Your authentication token
site_id (URL param) The site’s ID number
Loading × Clear Response
  • Request URL:
  • Response:

        

Tags

Retrieve a site’s tags GET sites/:site_id/tags

Parameter Name Value Description
api_token Please login to get your API token. Your authentication token
site_id (URL param) The site’s ID number
Loading × Clear Response
  • Request URL:
  • Response:

        

Contributors

Retrieve a site’s contributors GET sites/:site_id/contributors

Parameter Name Value Description
api_token Please login to get your API token. Your authentication token
site_id (URL param) The site’s ID number
Loading × Clear Response
  • Request URL:
  • Response:

        

Add a new contributor to a site POST sites/:site_id/contributors

Platform users only. Learn more about platform.
Parameter Name Value Description
api_token Please login to get your API token. Your authentication token
site_id (URL param) The site’s ID number
contributor[user_id] The ID number of the user to add to the list of contributors
emails Contributors can also be added with a comma delimited list of email addresses. (me@somesite.com, you@anothersite.com...).
Loading × Clear Response
  • Request URL:
  • Response:

        

Remove a contributor from a site DELETE sites/:site_id/contributors/:id

Parameter Name Value Description
api_token Please login to get your API token. Your authentication token
site_id (URL param) The site’s ID number
id The ID number of the user to remove from the list of contributors
Loading × Clear Response
  • Request URL:
  • Response:

        

Subscribers

Retrieve a site’s subscribers GET sites/:site_id/subscribers

Parameter Name Value Description
api_token Please login to get your API token. Your authentication token
site_id (URL param) The site’s ID number
Loading × Clear Response
  • Request URL:
  • Response:

        

Add a new subscriber to a site POST sites/:site_id/subscribers

Platform users only. Learn more about platform.
Parameter Name Value Description
api_token Please login to get your API token. Your authentication token
site_id (URL param) The site’s ID number
subscriber[user_id] The ID number of the user to add to the list of subscribers
Loading × Clear Response
  • Request URL:
  • Response:

        

Remove a subscriber from a site DELETE sites/:site_id/subscribers/:id

Parameter Name Value Description
api_token Please login to get your API token. Your authentication token
site_id (URL param) The site’s ID number
id The ID number of the user to remove from the list of subscribers
Loading × Clear Response
  • Request URL:
  • Response:

        

External Autopost Sites

Retrieve a site’s external autopost sites GET sites/:site_id/external_sites

Autopost Types:
ExtBliptv, ExtBlogger, ExtBuzz, ExtDelicious, ExtEbay, ExtFacebook, ExtFacebookPage, ExtFlickr, ExtFriendfeed, ExtIdentica, ExtJaiku, ExtLinkedIn, ExtLivejournal, ExtMetaWeblog, ExtPicasa, ExtPlurk, ExtScribd, ExtShopify, ExtTumblr, ExtTwitterBasic, ExtTwitterOauth, ExtViddler, ExtVimeo, ExtYoutube, ExternalSite, ExternalSitesController
Parameter Name Value Description
api_token Please login to get your API token. Your authentication token
site_id (URL param) The site’s ID number
Loading × Clear Response
  • Request URL:
  • Response:

        

Retrieve a single external autopost site GET sites/:site_id/external_sites/:id

Parameter Name Value Description
api_token Please login to get your API token. Your authentication token
site_id (URL param) The site’s ID number
id (URL param) The external site’s ID number
Loading × Clear Response
  • Request URL:
  • Response:

        

Delete a single external autopost site DELETE sites/:site_id/external_sites/:id

Parameter Name Value Description
api_token Please login to get your API token. Your authentication token
site_id (URL param) The site’s ID number
id (URL param) The external site’s ID number
Loading × Clear Response
  • Request URL:
  • Response:

        

Theme

Retrieve a site’s theme GET sites/:site_id/theme

Parameter Name Value Description
api_token Please login to get your API token. Your authentication token
site_id (URL param) The site’s ID number
Loading × Clear Response
  • Request URL:
  • Response:

        

Create a new theme for a site POST sites/:site_id/theme

Parameter Name Value Description
api_token Please login to get your API token. Your authentication token
site_id (URL param) The site’s ID number
theme[friendly_name] The theme name
theme[byline] Theme attribution
theme[raw_theme] The raw template code
theme[designer_url] The theme designers URL
theme[thumb] A thumbnail for the theme (jpg or png)
Loading × Clear Response
  • Request URL:
  • Response:

        

Working with Posts

Including posts, photos, videos, audio files, comments, and likes.

Posts

Retrieve popular posts from all users GET explore/public

Parameter Name Value Description
Loading × Clear Response
  • Request URL:
  • Response:

        

Retrieve a site’s posts GET sites/:site_id/posts

Parameter Name Value Description
api_token Please login to get your API token. Your authentication token
site_id (URL param) The site’s ID number
page The page number
since_id Return only posts after the post with this ID number
tag Return only posts with this tag (e.g. "apple")
Loading × Clear Response
  • Request URL:
  • Response:

        

Retrieve a site’s public posts GET sites/:site_id/posts/public

Parameter Name Value Description
api_token Please login to get your API token. Your authentication token
site_id (URL param) The site’s ID number
page The page number
since_id Return only posts after the post with this ID number
tag Return only posts with this tag (e.g. "apple")
Loading × Clear Response
  • Request URL:
  • Response:

        

Retrieve a site’s draft posts GET sites/:site_id/posts/drafts

Parameter Name Value Description
api_token Please login to get your API token. Your authentication token
site_id (URL param) The site’s ID number
page The page number
since_id Return only posts after the post with this ID number
Loading × Clear Response
  • Request URL:
  • Response:

        

Create a new post POST sites/:site_id/posts

Parameter Name Value Description
api_token Please login to get your API token. Your authentication token
site_id (URL param) The site’s ID number
post[title] The post’s title
post[body] The post’s body
post[tags] Comma-delimited list of tags e.g. "apple, android"
post[autopost] Set to true or 1 to autopost to external sites, or false or 0 otherwise.
post[display_date] This post’s date
post[source] The name of your application or website
post[is_private] Set to true or 1 to make this post private, or false or 0 to make it public
media An array of media to attach to the post. Images will be converted to a gallery.
Loading × Clear Response
  • Request URL:
  • Response:

        

Retrieve a single post GET sites/:site_id/posts/:id

Parameter Name Value Description
api_token Please login to get your API token. Your authentication token
site_id (URL param) The site’s ID number
id (URL param) The ID number of the post to return
Loading × Clear Response
  • Request URL:
  • Response:

        

Update a single post PUT sites/:site_id/posts/:id

Parameter Name Value Description
api_token Please login to get your API token. Your authentication token
site_id (URL param) The site’s ID number
id (URL param) The ID number of the post to edit.
post[title] The post’s title
post[body] The post’s body
post[tags] Comma-delimited list of tags e.g. "apple, android"
post[autopost] Set to true or 1 to autopost to external sites, or false or 0 otherwise.
post[display_date] This post’s date
post[source] The name of your application or website
post[is_private] Set to true or 1 to make this post private, or false or 0 to make it public
media An array of media to attach to the post. Images will be converted to a gallery.
Loading × Clear Response
  • Request URL:
  • Response:

        

Delete a single post DELETE sites/:site_id/posts/:id

Parameter Name Value Description
api_token Please login to get your API token. Your authentication token
site_id (URL param) The site’s ID number
id (URL param) The ID of the post to delete
Loading × Clear Response
  • Request URL:
  • Response:

        

Retrieve a post’s photos GET sites/:site_id/posts/:id/photos

Parameter Name Value Description
api_token Please login to get your API token. Your authentication token
site_id (URL param) The site’s ID number
id (URL param) The post’s ID number
Loading × Clear Response
  • Request URL:
  • Response:

        

Retrieve a post’s videos GET sites/:site_id/posts/:id/videos

Parameter Name Value Description
api_token Please login to get your API token. Your authentication token
site_id (URL param) The site’s ID number
id (URL param) The post’s ID number
Loading × Clear Response
  • Request URL:
  • Response:

        

Retrieve a post’s audio files GET sites/:site_id/posts/:id/audio_files

Parameter Name Value Description
api_token Please login to get your API token. Your authentication token
site_id (URL param) The site’s ID number
id (URL param) The post’s ID number
Loading × Clear Response
  • Request URL:
  • Response:

        

Comments

Retrieve a posts comments GET sites/:site_id/posts/:post_id/comments

Parameter Name Value Description
api_token Please login to get your API token. Your authentication token
site_id (URL param) The site’s ID number
post_id (URL param) The post’s ID number
Loading × Clear Response
  • Request URL:
  • Response:

        

Create a new comment POST sites/:site_id/posts/:post_id/comments

Parameter Name Value Description
api_token Please login to get your API token. Your authentication token
site_id (URL param) The site’s ID number
post_id (URL param) The post’s ID number
comment[body] The comment body
Loading × Clear Response
  • Request URL:
  • Response:

        

Retrieve a single comment GET sites/:site_id/posts/:post_id/comments/:id

Parameter Name Value Description
api_token Please login to get your API token. Your authentication token
site_id (URL param) The site’s ID number
post_id (URL param) The post’s ID number
id (URL param) The comment’s ID number
Loading × Clear Response
  • Request URL:
  • Response:

        

Update a single comment PUT sites/:site_id/posts/:post_id/comments/:id

Parameter Name Value Description
api_token Please login to get your API token. Your authentication token
site_id (URL param) The site’s ID number
post_id (URL param) The post’s ID number
id (URL param) The comment’s ID number
comment[body] The comment body
Loading × Clear Response
  • Request URL:
  • Response:

        

Delete a single comment DELETE sites/:site_id/posts/:post_id/comments/:id

Parameter Name Value Description
api_token Please login to get your API token. Your authentication token
site_id (URL param) The site’s ID number
post_id (URL param) The post’s ID number
id (URL param) The comment’s ID number
Loading × Clear Response
  • Request URL:
  • Response:

        

Likes

Retrieve a post’s likes GET sites/:site_id/posts/:post_id/likes

Parameter Name Value Description
api_token Please login to get your API token. Your authentication token
site_id (URL param) The site’s ID number
post_id (URL param) The post’s ID number
Loading × Clear Response
  • Request URL:
  • Response:

        

Create a new like POST sites/:site_id/posts/:post_id/likes

Parameter Name Value Description
api_token Please login to get your API token. Your authentication token
site_id (URL param) The site’s ID number
post_id (URL param) The post’s ID number
Loading × Clear Response
  • Request URL:
  • Response:

        

Retrieve a single like GET sites/:site_id/posts/:post_id/likes/:id

Parameter Name Value Description
api_token Please login to get your API token. Your authentication token
site_id (URL param) The site’s ID number
post_id (URL param) The post’s ID number
id (URL param) The like’s ID number
Loading × Clear Response
  • Request URL:
  • Response:

        

Delete a single like DELETE sites/:site_id/posts/:post_id/likes/:id

Parameter Name Value Description
api_token Please login to get your API token. Your authentication token
site_id (URL param) The site’s ID number
post_id (URL param) The post’s ID number
id (URL param) The like’s ID number
Loading × Clear Response
  • Request URL:
  • Response:

        

Working with Pages

Including pages, links, and link categories

Pages

Retrieve a site’s pages GET sites/:site_id/pages

Parameter Name Value Description
api_token Please login to get your API token. Your authentication token
site_id (URL param) The site’s ID number
Loading × Clear Response
  • Request URL:
  • Response:

        

Create a new page POST sites/:site_id/pages

Parameter Name Value Description
api_token Please login to get your API token. Your authentication token
site_id (URL param) The site’s ID number
page[title] The page’s title.
page[body] The page’s body content.
media File uploads are not available in the API console An array of media items to attach to this page. If images, they will be converted to a gallery.
Loading × Clear Response
  • Request URL:
  • Response:

        

Retrieve a single page GET sites/:site_id/pages/:id

Parameter Name Value Description
api_token Please login to get your API token. Your authentication token
site_id (URL param) The site’s ID number
id (URL param) The page’s ID number
Loading × Clear Response
  • Request URL:
  • Response:

        

Update a single page PUT sites/:site_id/pages/:id

Parameter Name Value Description
api_token Please login to get your API token. Your authentication token
site_id (URL param) The site’s ID number
id (URL param) The page’s ID number
page[title] The page’s title.
page[body] The page’s body content.
media File uploads are not available in the API console An array of media items to attach to this page. If images, they will be converted to a gallery.
Loading × Clear Response
  • Request URL:
  • Response:

        

Delete a single page DELETE sites/:site_id/pages/:id

Parameter Name Value Description
api_token Please login to get your API token. Your authentication token
site_id (URL param) The site’s ID number
id (URL param) The page’s ID number
Loading × Clear Response
  • Request URL:
  • Response:

        

Link Categories

Retrieve a site’s link categories GET sites/:site_id/link_categories

Parameter Name Value Description
api_token Please login to get your API token. Your authentication token
site_id (URL param) The site’s ID number
Loading × Clear Response
  • Request URL:
  • Response:

        

Create a new link category POST sites/:site_id/link_categories

Parameter Name Value Description
api_token Please login to get your API token. Your authentication token
site_id (URL param) The site’s ID number
Loading × Clear Response
  • Request URL:
  • Response:

        

Retrieve a single link category GET sites/:site_id/link_categories/:id

Parameter Name Value Description
api_token Please login to get your API token. Your authentication token
site_id (URL param) The site’s ID number
id (URL param) The link category’s ID number
Loading × Clear Response
  • Request URL:
  • Response:

        

Update a single link category PUT sites/:site_id/link_categories/:id

Parameter Name Value Description
api_token Please login to get your API token. Your authentication token
site_id (URL param) The site’s ID number
id (URL param) The link category’s ID number
Loading × Clear Response
  • Request URL:
  • Response:

        

Move a single link category PUT sites/:site_id/link_categories/:id/move

Parameter Name Value Description
api_token Please login to get your API token. Your authentication token
site_id (URL param) The site’s ID number
id (URL param) The link category’s ID number
Loading × Clear Response
  • Request URL:
  • Response:

        

Delete a single link category DELETE sites/:site_id/link_categories/:id

Parameter Name Value Description
api_token Please login to get your API token. Your authentication token
site_id (URL param) The site’s ID number
id (URL param) The link category’s ID number
Loading × Clear Response
  • Request URL:
  • Response:

        

Links

Retrieve a link category's links GET sites/:site_id/link_categories/:link_category_id/links

Parameter Name Value Description
api_token Please login to get your API token. Your authentication token
site_id (URL param) The site’s ID number
Loading × Clear Response
  • Request URL:
  • Response:

        

Create a new link POST sites/:site_id/link_categories/:link_category_id/links

Parameter Name Value Description
api_token Please login to get your API token. Your authentication token
site_id (URL param) The site’s ID number
link[title] The link’s title
link[url] The link’s URL
Loading × Clear Response
  • Request URL:
  • Response:

        

Retrieve a single link GET sites/:site_id/link_categories/:link_category_id/links/:id

Parameter Name Value Description
api_token Please login to get your API token. Your authentication token
site_id (URL param) The site’s ID number
id (URL param) The link’s ID number
Loading × Clear Response
  • Request URL:
  • Response:

        

Update a single link PUT sites/:site_id/link_categories/:link_category_id/links/:id

Parameter Name Value Description
api_token Please login to get your API token. Your authentication token
site_id (URL param) The site’s ID number
id (URL param) The link’s ID number
link[title] The link’s title
link[url] The link’s URL
Loading × Clear Response
  • Request URL:
  • Response:

        

Move a single link PUT sites/:site_id/link_categories/:link_category_id/links/:id/move

Parameter Name Value Description
api_token Please login to get your API token. Your authentication token
site_id (URL param) The site’s ID number
id (URL param) The link’s ID number
link[position] The new position for this link. The links at this position and higher will be moved to accommodate it.
link[parent_id] The ID number of the link category this link should become a child of.
Loading × Clear Response
  • Request URL:
  • Response:

        

Delete a single link DELETE sites/:site_id/link_categories/:link_category_id/links/:id

Parameter Name Value Description
api_token Please login to get your API token. Your authentication token
site_id (URL param) The site’s ID number
id (URL param) The link’s ID number
Loading × Clear Response
  • Request URL:
  • Response: