Pentameter
latest
  • Foreword
  • Installation
  • Quickstart
  • Config
  • Testing
  • Gitflow
  • Deploying
  • API
    • Overview
    • Response Types
      • Author Response
      • List of Author
      • Collection Response
      • List of Collections
      • Poem Response
      • List of Poems
    • Endpoints
      • Quickref
      • Auth
      • Author
      • Collection
      • Me
      • Poem
  • Front End
  • Changelog
  • License
Pentameter
  • Docs »
  • API
  • Edit on GitHub

API¶

Overview¶

All endpoints are prepended with /api/ and will respond with JSON back with everything under a top level data key:

{
    "data": {
        ...
    }
}

Response Types¶

  • Author Response
  • List of Author
  • Collection Response
  • List of Collections
  • Poem Response
  • List of Poems

Endpoints¶

  • Quickref
    • auth
    • author
    • collection
    • me
    • poem
  • Auth
    • login
    • signup
    • logout
    • forgot password
    • reset password
    • verify email
    • email confirmation
  • Author
    • Get author by ID
    • Get one collection by author
    • Get collections by author
    • Get one poem by author
    • Get poems by author
    • Get author’s followers
    • follow
    • Unfollow
    • Get list of authors
  • Collection
    • get
    • get many poems in collection
    • get one poem in collection
    • follow
    • unfollow
    • get followers
  • Me
    • get
    • update
    • photo
    • delete
    • create poem
    • get all poems
    • get poem
    • update poem
    • delete poem
    • get all collections
    • create new collection
    • update collection
    • delete collection
    • get poems in collection
    • add poem to collection
    • remove poem from collection
  • Poem
    • get
    • increment metric
    • like
    • unlike
    • get likes
Next Previous

© Copyright 2016, Pentameter.org. Revision c3ed0436.

Built with Sphinx using a theme provided by Read the Docs.