Hellonext API V3

Get Started

Hellonext API V3 is an organization based access. Use this to query for latest posts, submit a post and more.

First, you will need to obtain an API token.

  1. Navigate to the “Advanced Settings” page. Dashboard > Settings > Advanced > API Key

  2. Click on the “Generate” button in the API Key section.

Generate API Token

  1. Copy the generated token. (In this case it is “3IIlJZNFukq3BRh76_aw4Q”)

Copy API Token

  1. This token will need to be sent in the header section of every API request.
header[“API-KEY”] = “3IIlJZNFukq3BRh76_aw4Q”
  1. All requests must have the following headers set to return a JSON response.
  • Must have a Content-Type header set to application/json
  • Must have a Accept header set to application/json

API Documentation

Organization Information

This endpoint helps you extract organization information such as name, profile picture, list of public buckets and more.

Request

GET /api/v3/organizations/info

Request Header

API-KEY 3IIlJZNFukq3BRh76_aw4Q

Response

{
  "success": true,
  "organization": {
    "id": xxx,
    "name": "hellonext",
    "display_name": "Hellonext",
    "description": "",
    "url": null,
    "profile": null
  },
  "buckets": [
    {
      "id": xxx,
      "name": "ABC",
      "default": false
    },
    {
      "id": xxx,
      "name": "XYZ",
      "default": false
    }
  ]
}

Submit Post

A post can be submitted by sending the required attributes such as title, description, and bucket.

Request

POST /api/v3/feature_requests/submit

Request Body

{
  "title": "Test",
  "description": "Test Description",
  "email": "test@example.com",
  "bucket_id": 1
}

Bucket ID can be obtained from the Organization Information call.

Request Header

API-KEY 3IIlJZNFukq3BRh76_aw4Q

Response

{
  "id": xxx,
  "slug": "abc",
  "title": "ABC",
  "description": "ABC ABC ABC",
  "attachments": [],
  "submitter": "Swaathi Kakarla",
  "status": "under_review",
  "bucket": "Internal Suggestions",
  "url": "https://feedback.hellonext.co/features/xxx",
  "votes_count": 1,
  "comments_count": 0,
  "created_at": "2020-07-15T12:51:06.000+05:30",
  "updated_at": "2020-07-15T12:51:06.000+05:30"
}

View Latest Posts

Fetch latest submitted posts with a paginated response. You can control the page of the data by passing a page parameter in the request.

Request

GET /api/v3/feature_requests/latest

Optional Parameters

  • page: page can be set to any positive integer to retrieve a paginated response
  • bucket_id: bucket_id can be set to any board ID obtained from the View All Boards call

Request Header

API-KEY 3IIlJZNFukq3BRh76_aw4Q

Response

{
  "success": true,
  "feature_requests": [
    {
      "id": xxx,
      "slug": "pqr",
      "title": "PQR",
      "description": "PQR PQR",
      "attachments": [],
      "submitter": "Praveen Juge",
      "status": "in_progress",
      "bucket": "Feature Requests",
      "url": "https://feedback.hellonext.co/features/pqr",
      "votes_count": 3,
      "comments_count": 1,
      "created_at": "2020-06-30T12:36:36.000+05:30",
      "updated_at": "2020-07-01T10:18:14.000+05:30"
    },
    {
      "id": xxx,
      "slug": "abc",
      "title": "ABC",
      "description": "ABC ABC",
      "attachments": [],
      "submitter": "Swaathi Kakarla",
      "status": "in_progress",
      "bucket": "Feature Requests",
      "url": "https://feedback.hellonext.co/features/abc",
      "votes_count": 1,
      "comments_count": 0,
      "created_at": "2020-06-30T12:36:36.000+05:30",
      "updated_at": "2020-07-01T10:18:14.000+05:30"
    }
  ]
}

View All Boards

Fetch a list of all public and private boards.

Request

GET /api/v3/buckets

Request Header

API-KEY 3IIlJZNFukq3BRh76_aw4Q

Response

{
  "success": true,
  "buckets": [
    {
      "id": 1,
      "slug": "feedback",
      "name": "Feedback",
      "default": true,
      "private": false
    },
    {
      "id": 2,
      "slug": "Private-Board",
      "name": "Private Board",
      "default": false,
      "private": true
    },
    {
      "id": 3,
      "slug": "Disabled-Comments-Board",
      "name": "Disabled Comments Board",
      "default": false,
      "private": false
    },
    {
      "id": 4,
      "slug": "17",
      "name": "17",
      "default": false,
      "private": false
    }
  ]
}

View Paginated Votes

Fetch a list of all votes made in your organization across all boards.

Request

GET /api/v3/votes

Optional Parameters

  • page: page can be set to any positive integer to retrieve a paginated response

Request Header

API-KEY 3IIlJZNFukq3BRh76_aw4Q

Response

{
  "success": true,
  "votes": [
    {
      "id": 10,
      "kind": "upvote",
      "source": "hellonext",
      "created_at": "2021-06-05T13:25:05.000Z",
      "feature_request": {
        "id": 10,
        "bucket_id": 2,
        "title": "Test Post {Tagged} 10",
        "status": "Under Review",
        "approved": true,
        "url": "https://feedback.hellonext.co/b/Private-Board/p/test-post-tagged-10"
      },
      "user": {
        "name": "Swaathi",
        "email": "swaathi@example.com"
      }
    },
    {
      "id": 9,
      "kind": "upvote",
      "source": "hellonext",
      "created_at": "2021-06-05T13:25:05.000Z",
      "feature_request": {
        "id": 9,
        "bucket_id": 3,
        "title": "Test Post {Assigned} 9",
        "status": "Under Review",
        "approved": true,
        "url": "https://feedback.hellonext.co/b/Disabled-Comments-Board/p/test-post-assigned-9"
      },
      "user": {
        "name": "Swaathi",
        "email": "swaathi@example.com"
      }
    }
  ]
}

View Comments of a Post

Fetch a paginated list of all the comments made on a post.

Request

GET /api/v3/feature_requests/:post_id/comments

Optional Parameters

  • page: page can be set to any positive integer to retrieve a paginated response

Request Header

API-KEY 3IIlJZNFukq3BRh76_aw4Q

Response

{
  "success": true,
  "comments": [
    {
      "id": 26573,
      "comment": "<p>Hey there!</p>",
      "parent_id": 26571,
      "pinned": false,
      "internal": false,
      "approval_status": "approved",
      "created_at": "2021-08-17T05:29:37.000Z",
      "updated_at": "2021-08-17T05:29:37.000Z",
      "feature_request": {
        "id": 6065,
        "url": "https://feedback.hellonext.co/b/feedback/p/hello-world",
        "title": "Hello World"
      }
    },
    ...
  ]
}