List News Stories

GET /api/blog/list

Get's paginated news stories

Query parameters

Responses

GET /api/blog/list
curl \
 -X GET http://api.example.com/api/blog/list \
 -H "Authorization: Bearer $ACCESS_TOKEN"
Response examples (default)
{
  "hits": [
    {
      "permissions": {
        "view": true,
        "edit": false,
        "admin": false,
        "delete": false
      },
      "_source": {
        "relatedTo": "agreementt",
        "date": "2023-05-04T09:42:00+00:00",
        "created": "2023-05-04T09:42:00+00:00",
        "relatedID": 42,
        "categoryID": 6,
        "sticky": 1,
        "importance": 4,
        "modified": "2023-05-04T09:42:00+00:00",
        "id": 42,
        "documentID": 42,
        "document": {
          "fileType": "pdf",
          "shortDescription": "string",
          "timeSensitive": true,
          "validFrom": "2023-05-04T09:42:00+00:00",
          "size": 1023752,
          "id": 42,
          "name": "FileName"
        },
        "comments": [
          {
            "CONTENT": "An example comment!",
            "SECURITY": "public",
            "COMPANY_ID": 42,
            "RELATEDID": 42,
            "REMINDERDATE": "2023-05-04T09:42:00+00:00",
            "TYPE_ID": 42,
            "permissions": {
              "view": true,
              "edit": false,
              "admin": false,
              "delete": false
            },
            "CONTACTID": 42,
            "CTYPE": "note",
            "SURNAME": "Bloggs",
            "FIRST_NAME": "Joe",
            "STAMP": "2023-05-04T09:42:00+00:00",
            "STATUS": "open",
            "RELATIONSHIPURL": "string",
            "ATTACHMENTS": "string",
            "ID": 42,
            "RELATEDSUBTYPE": "string",
            "TITLE": "comment title",
            "RELATEDTYPE": "blog",
            "EMAIL": "hello@example.com"
          }
        ],
        "title": "Example News Heading",
        "deal": {
          "period_from": "2023-05-04",
          "supplierName": "Supplier Name",
          "supplierID": "string",
          "name": "Deal Name",
          "period_to": "2023-05-04"
        },
        "description": "Example News Body"
      }
    }
  ],
  "max_score": "string",
  "total": 42
}