-
Notifications
You must be signed in to change notification settings - Fork 0
Beta docs
Welcome to the Exposure API Beta docs. While things are quite stable, the endpoint URLs and/or response payloads may change a bit, although unlikely.
Also, with the pending release of our Gallery feature, anywhere you see "story/stories", that includes gallery posts as well as our original, storytelling posts.
Any questions, suggestions, or other feedback, please email [email protected] -- thanks and happy building.
- GET /api/3/site/:username/stories
Returns a user's public stories, paginated, most recently published first. Public means 1) published and 2) not password-protected.
- GET /api/3/site/:username/stories/:slug
Returns a response containing a single story, including story data (title, cover photo URL if set) as well as photo groups, position-ordered, with each group containing position-ordered photos.
- GET /api/3/site/:username
Returns data about the given user.
- 404 Not Found: returned with an empty payload if a given user is not found
- 402 Payment Required: returned when a given user does not have a Business level subscription (the API is currently only available to Business subscribers.)
- 400 Bad Request: returned when the user has not chosen to enable API access for their account
Payloads generally include the requested data, pagination data in the case of stories, user data in the case of stories, and a urls hash, containing relevant API and web endpoints to make traversing user and story data easier.
The :username/stories endpoint can be paginated by passing page=:page_number as a query param. The response payload will include a pager hash which contains useful data, like the previous and next page API endpoints, if available.
Some endpoints (currently only :username/stories) support expanded response payloads. Pass expand=groups as a query param and the stories returned will include photo groups and photos as well. By default, these are excluded to save on response time and size.