Votes

Votes are expressions of support or preference that users cast for submitted ideas on your Frill account.

Vote object

Vote have the following fields

Field	Details
idx string	A unique identifier for the vote
created_at string	The date time the vote was created in UTC timezone
voter object	The user this vote is associated with
idea object	The idea this vote is associated with

Endpoints

You can use the following endpoints to manage Votes

Returns a list of votes

GEThttps://api.frill.co/v1/votes

Query parameters

Response

200400

Successfully returned a list of votes

Body

application/json

dataarray of Vote (object)

paginationPagination (object)

Request

JavaScriptCurl

const response = await fetch('https://api.frill.co/v1/votes', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "data": [
    {
      "idx": "vote_abcd1234",
      "created_at": "text",
      "voter": {
        "idx": "follower_abcd1234",
        "name": "John Smith",
        "avatar": "https://example.com/example.jpg"
      },
      "idea": {
        "idx": "idea_abcd1234",
        "name": "New idea",
        "slug": "new-idea",
        "description": "This is a new idea from a customer",
        "cover_image": "https://example.com/example.jpg",
        "vote_count": 0,
        "comment_count": 0,
        "note_count": 0,
        "is_pined": false,
        "is_bug": false,
        "is_archived": false,
        "is_completed": false,
        "show_in_roadmap": false,
        "approval_status": "text",
        "created_at": "text",
        "updated_at": "text",
        "author": {
          "idx": "follower_abcd1234",
          "name": "John Smith",
          "avatar": "https://example.com/example.jpg"
        },
        "status": {
          "idx": "status_abcd1234",
          "name": "Completed",
          "color": "#6392D9"
        },
        "topics": [
          {
            "idx": "topic_abcd1234",
            "name": "New feauture"
          }
        ]
      }
    }
  ],
  "pagination": {
    "total": 10,
    "before": "before-cursor",
    "after": "after-cursor"
  }
}

Vote on an idea

POSThttps://api.frill.co/v1/votes

Body

application/json

idea_idxstring

voter_idxstring

Response

200400

Successfully voted on an idea

Body

application/json

idx*string

A unique identifier for the vote

created_atstring

The date & time the idea was created in UTC timezone

voterVoter (object)

ideaIdea (object)

Request

JavaScriptCurl

const response = await fetch('https://api.frill.co/v1/votes', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "idx": "vote_abcd1234",
  "created_at": "text",
  "voter": {
    "idx": "follower_abcd1234",
    "name": "John Smith",
    "avatar": "https://example.com/example.jpg"
  },
  "idea": {
    "idx": "idea_abcd1234",
    "name": "New idea",
    "slug": "new-idea",
    "description": "This is a new idea from a customer",
    "cover_image": "https://example.com/example.jpg",
    "vote_count": 0,
    "comment_count": 0,
    "note_count": 0,
    "is_pined": false,
    "is_bug": false,
    "is_archived": false,
    "is_completed": false,
    "show_in_roadmap": false,
    "approval_status": "text",
    "created_at": "text",
    "updated_at": "text",
    "author": {
      "idx": "follower_abcd1234",
      "name": "John Smith",
      "avatar": "https://example.com/example.jpg"
    },
    "status": {
      "idx": "status_abcd1234",
      "name": "Completed",
      "color": "#6392D9"
    },
    "topics": [
      {
        "idx": "topic_abcd1234",
        "name": "New feauture"
      }
    ]
  }
}

Unvote an idea

DELETEhttps://api.frill.co/v1/votes

Path parameters

idea_idx*string

voter_idx*string

Response

200400

Request was successful

Body

application/json

successboolean

messagestring

Request

JavaScriptCurl

const response = await fetch('https://api.frill.co/v1/votes', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

{
  "success": false,
  "message": "Request was successful"
}