API documentation

Hello curios developer! As we're very new here our API is pretty limited and very experimental at the moment. Hence the URL /api/v0/… If you plan to use it make sure that you follow us on Twitter and our blog to stay updated. Expect heavy changes, but dont let that hold you back. Go ahead, play and have fun!

Questions? Send an email to [email protected] or ping us on Twitter.


Resource: Articles

GET /api/v0/articles

Params

per_page Amount of articles per page (the default is 5) Default: 5 Example: GET /api/v0/articles?per_page=100
page Page to display Default: 1 Example: GET /api/v0/articles?page=2
sort[property] Sort by Default: N/A Example: GET /api/v0/articles?sort[property]=title
sort[order] Sort direction Default: asc Example: GET /api/v0/articles?sort[order]=desc
published Is article published? Default: true Example: GET /api/v0/articles?published=false
title Filter by title Default: N/A Example: GET /api/v0/articles?title=my title
link Filter by link Default: N/A Example: GET /api/v0/articles?link=www.example.com
client Filter by client Default: N/A Example: GET /api/v0/articles?client=Kollegorna
created_at[le] Creted at is less than Default: N/A Example: GET /api/v0/articles?created_at[le]=2016-01-01
created_at[leq] Creted at is less or equal than Default: N/A Example: GET /api/v0/articles?created_at[leq]=2016-01-01
created_at[ge] Creted at is greater than Default: N/A Example: GET /api/v0/articles?created_at[ge]=2016-01-01
created_at[geq] Creted at is greater or equal than Default: N/A Example: GET /api/v0/articles?created_at[geq]=2016-01-01
Same as created at goes for updated_at

Example result:

{
  "articles":[
    {
      "id":5,
      "title":"Article title",
      "link":"www.example.com",
      "published":true,
      "description":"",
      "updated_at":"2015-10-30T11:52:55Z",
      "created_at":"2015-10-30T11:52:55Z",
      "link_apple_app_store":"",
      "link_google_play_store":"",
      "link_windows_store":""
    }
  ]
}
      

GET /api/v0/articles/:id

Example result:

{
  "article": {
    "id":5,
    "title":"Article title",
    "link":"www.example.com",
    "published":true,
    "description":"",
    "updated_at":"2015-10-30T11:52:55Z",
    "created_at":"2015-10-30T11:52:55Z",
    "link_apple_app_store":"",
    "link_google_play_store":"",
    "link_windows_store":""
  }
}