API Documentation

forums/listPosts

Returns a list of posts within a forum.

URL

https://disqus.com/api/3.0/forums/listPosts.json

Accessibility

public key, secret key

Supported request methods

GET

Supported formats

json, jsonp, rss

Requires authentication

no

Rate limited

inherits global rate limit

Arguments

Required

  • forum

    Looks up a forum by ID (aka short name)

Optional

  • since

    Defaults to null

    Unix timestamp (or ISO datetime standard)

  • related allows multiple

    Defaults to []

    You may specify relations to include with your response.
    Choices: thread

  • cursor

    Defaults to null

  • limit

    Defaults to 25

    Maximum number of posts to return.
    Maximum value of 100

  • query

    Defaults to null

  • include allows multiple

    Defaults to [ "approved" ]

    Choices: unapproved, approved, spam, deleted, flagged, highlighted

  • order

    Defaults to "desc"

    Choices: asc, desc

Example Responses

Expand json

GET forum=bobross

{
  "cursor":{
    "prev":null,
    "hasNext":false,
    "next":"1213061528000000:1:0",
    "hasPrev":false,
    "total":null,
    "id":"1213061528000000:1:0",
    "more":false
  },
  "code":0,
  "response":[
    {
      "isJuliaFlagged":true,
      "isFlagged":false,
      "forum":"bobross",
      "parent":1,
      "author":{
        "username":"disqus_api",
        "about":"",
        "name":"disqus_api",
        "url":"",
        "isFollowing":false,
        "isFollowedBy":false,
        "profileUrl":"http://disqus.com/disqus_api/",
        "emailHash":"67f79ed8e10b74abf07a8dfe101bbab2",
        "avatar":{
          "permalink":"http://disqus.com/api/users/avatars/disqus_api.jpg",
          "cache":"http://mediacdn.disqus.com/1091/images/noavatar92.png"
        },
        "id":"1",
        "isAnonymous":false,
        "email":"example@disqus.com"
      },
      "media":[],
      "isApproved":true,
      "dislikes":0,
      "raw_message":"\"Happy little bush.\"",
      "id":"3",
      "thread":"1",
      "points":0,
      "createdAt":"2008-06-10T01:45:27",
      "isEdited":false,
      "message":"\"Happy little bush.\"",
      "isHighlighted":false,
      "ipAddress":"127.0.0.1",
      "isSpam":false,
      "isDeleted":false,
      "likes":0
    },
    {
      "isJuliaFlagged":true,
      "isFlagged":false,
      "forum":"bobross",
      "parent":null,
      "author":{
        "name":null,
        "url":null,
        "profileUrl":"",
        "emailHash":"575007c5f1370d7cf76cbd79e5a81584",
        "avatar":{
          "permalink":"http://www.gravatar.com/avatar.php?gravatar_id=575007c5f1370d7cf76cbd79e5a81584&size=32&default=http://mediacdn.disqus.com/1091/images/noavatar32.png",
          "cache":"http://www.gravatar.com/avatar.php?gravatar_id=575007c5f1370d7cf76cbd79e5a81584&size=32&default=http://mediacdn.disqus.com/1091/images/noavatar32.png"
        },
        "isAnonymous":true,
        "email":"richard.nixon@example.com"
      },
      "media":[],
      "isApproved":true,
      "dislikes":0,
      "raw_message":"\"Happy little tree limb.\"",
      "id":"2",
      "thread":"1",
      "points":0,
      "createdAt":"2008-06-10T01:45:04",
      "isEdited":false,
      "message":"\"Happy little tree limb.\"",
      "isHighlighted":false,
      "ipAddress":"127.0.0.1",
      "isSpam":false,
      "isDeleted":false,
      "likes":0
    },
    {
      "isJuliaFlagged":true,
      "isFlagged":false,
      "forum":"bobross",
      "parent":null,
      "author":{
        "username":"disqus_api",
        "about":"",
        "name":"disqus_api",
        "url":"",
        "isFollowing":false,
        "isFollowedBy":false,
        "profileUrl":"http://disqus.com/disqus_api/",
        "emailHash":"67f79ed8e10b74abf07a8dfe101bbab2",
        "avatar":{
          "permalink":"http://disqus.com/api/users/avatars/disqus_api.jpg",
          "cache":"http://mediacdn.disqus.com/1091/images/noavatar92.png"
        },
        "id":"1",
        "isAnonymous":false,
        "email":"example@disqus.com"
      },
      "media":[],
      "isApproved":true,
      "dislikes":0,
      "raw_message":"\"We want happy paintings. Happy paintings. If you want sad things, watch the news.\"",
      "id":"1",
      "thread":"1",
      "points":1,
      "createdAt":"2008-06-10T01:32:08",
      "isEdited":false,
      "message":"\"We want happy paintings. Happy paintings. If you want sad things, watch the news.\"",
      "isHighlighted":false,
      "ipAddress":"127.0.0.1",
      "isSpam":false,
      "isDeleted":false,
      "likes":1
    }
  ]
}
Expand json

GET related=thread&forum=bobross

{
  "cursor":{
    "prev":null,
    "hasNext":false,
    "next":"1213061528000000:1:0",
    "hasPrev":false,
    "total":null,
    "id":"1213061528000000:1:0",
    "more":false
  },
  "code":0,
  "response":[
    {
      "isJuliaFlagged":true,
      "isFlagged":false,
      "forum":"bobross",
      "parent":1,
      "author":{
        "username":"disqus_api",
        "about":"",
        "name":"disqus_api",
        "url":"",
        "isFollowing":false,
        "isFollowedBy":false,
        "profileUrl":"http://disqus.com/disqus_api/",
        "emailHash":"67f79ed8e10b74abf07a8dfe101bbab2",
        "avatar":{
          "permalink":"http://disqus.com/api/users/avatars/disqus_api.jpg",
          "cache":"http://mediacdn.disqus.com/1091/images/noavatar92.png"
        },
        "id":"1",
        "isAnonymous":false,
        "email":"example@disqus.com"
      },
      "media":[],
      "isApproved":true,
      "dislikes":0,
      "raw_message":"\"Happy little bush.\"",
      "id":"3",
      "thread":{
        "category":"1",
        "reactions":0,
        "identifiers":[
          "my-identifier"
        ],
        "forum":"bobross",
        "title":"Happy Accidents",
        "dislikes":0,
        "isDeleted":false,
        "author":"1",
        "userScore":0,
        "id":"1",
        "isClosed":false,
        "posts":25,
        "link":null,
        "likes":0,
        "message":"\"If you've painted before you know that we don't make mistakes -- we have happy accidents.\"",
        "ipAddress":"127.0.0.1",
        "slug":"happy_accidents",
        "createdAt":"2008-06-10T01:31:43"
      },
      "points":0,
      "createdAt":"2008-06-10T01:45:27",
      "isEdited":false,
      "message":"\"Happy little bush.\"",
      "isHighlighted":false,
      "ipAddress":"127.0.0.1",
      "isSpam":false,
      "isDeleted":false,
      "likes":0
    },
    {
      "isJuliaFlagged":true,
      "isFlagged":false,
      "forum":"bobross",
      "parent":null,
      "author":{
        "name":null,
        "url":null,
        "profileUrl":"",
        "emailHash":"575007c5f1370d7cf76cbd79e5a81584",
        "avatar":{
          "permalink":"http://www.gravatar.com/avatar.php?gravatar_id=575007c5f1370d7cf76cbd79e5a81584&size=32&default=http://mediacdn.disqus.com/1091/images/noavatar32.png",
          "cache":"http://www.gravatar.com/avatar.php?gravatar_id=575007c5f1370d7cf76cbd79e5a81584&size=32&default=http://mediacdn.disqus.com/1091/images/noavatar32.png"
        },
        "isAnonymous":true,
        "email":"richard.nixon@example.com"
      },
      "media":[],
      "isApproved":true,
      "dislikes":0,
      "raw_message":"\"Happy little tree limb.\"",
      "id":"2",
      "thread":{
        "category":"1",
        "reactions":0,
        "identifiers":[
          "my-identifier"
        ],
        "forum":"bobross",
        "title":"Happy Accidents",
        "dislikes":0,
        "isDeleted":false,
        "author":"1",
        "userScore":0,
        "id":"1",
        "isClosed":false,
        "posts":25,
        "link":null,
        "likes":0,
        "message":"\"If you've painted before you know that we don't make mistakes -- we have happy accidents.\"",
        "ipAddress":"127.0.0.1",
        "slug":"happy_accidents",
        "createdAt":"2008-06-10T01:31:43"
      },
      "points":0,
      "createdAt":"2008-06-10T01:45:04",
      "isEdited":false,
      "message":"\"Happy little tree limb.\"",
      "isHighlighted":false,
      "ipAddress":"127.0.0.1",
      "isSpam":false,
      "isDeleted":false,
      "likes":0
    },
    {
      "isJuliaFlagged":true,
      "isFlagged":false,
      "forum":"bobross",
      "parent":null,
      "author":{
        "username":"disqus_api",
        "about":"",
        "name":"disqus_api",
        "url":"",
        "isFollowing":false,
        "isFollowedBy":false,
        "profileUrl":"http://disqus.com/disqus_api/",
        "emailHash":"67f79ed8e10b74abf07a8dfe101bbab2",
        "avatar":{
          "permalink":"http://disqus.com/api/users/avatars/disqus_api.jpg",
          "cache":"http://mediacdn.disqus.com/1091/images/noavatar92.png"
        },
        "id":"1",
        "isAnonymous":false,
        "email":"example@disqus.com"
      },
      "media":[],
      "isApproved":true,
      "dislikes":0,
      "raw_message":"\"We want happy paintings. Happy paintings. If you want sad things, watch the news.\"",
      "id":"1",
      "thread":{
        "category":"1",
        "reactions":0,
        "identifiers":[
          "my-identifier"
        ],
        "forum":"bobross",
        "title":"Happy Accidents",
        "dislikes":0,
        "isDeleted":false,
        "author":"1",
        "userScore":0,
        "id":"1",
        "isClosed":false,
        "posts":25,
        "link":null,
        "likes":0,
        "message":"\"If you've painted before you know that we don't make mistakes -- we have happy accidents.\"",
        "ipAddress":"127.0.0.1",
        "slug":"happy_accidents",
        "createdAt":"2008-06-10T01:31:43"
      },
      "points":1,
      "createdAt":"2008-06-10T01:32:08",
      "isEdited":false,
      "message":"\"We want happy paintings. Happy paintings. If you want sad things, watch the news.\"",
      "isHighlighted":false,
      "ipAddress":"127.0.0.1",
      "isSpam":false,
      "isDeleted":false,
      "likes":1
    }
  ]
}