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

get

/votes

Authorizations

Query parameters

limitinteger · default: 20

Limits the number of items on a page

afterstring

The after cursor - used for pagination

idea_idxstring

A unique identifier for the idea. Only fetch votes for this idea

user_idxstring

A unique identifier for the follower. Only fetch votes for this follower

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.frill.co/v1/votes' \
  --header 'Authorization: Basic username:password'

200

400

200

{
  "pagination": {
    "total": 10,
    "before": "before-cursor",
    "after": "after-cursor"
  },
  "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": 1,
        "comment_count": 1,
        "note_count": 1,
        "is_pined": true,
        "is_bug": true,
        "is_archived": true,
        "is_completed": true,
        "show_in_roadmap": true,
        "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"
          }
        ]
      }
    }
  ]
}

Successfully returned a list of votes

Vote on an idea

post

/votes

Authorizations

Body

idea_idxstring

voter_idxstring

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.frill.co/v1/votes' \
  --header 'Authorization: Basic username:password' \
  --header 'Content-Type: application/json'

200

400

200

{
  "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": 1,
    "comment_count": 1,
    "note_count": 1,
    "is_pined": true,
    "is_bug": true,
    "is_archived": true,
    "is_completed": true,
    "show_in_roadmap": true,
    "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"
      }
    ]
  }
}

Successfully voted on an idea

Unvote an idea

delete

/votes

Authorizations

Path parameters

idea_idxstringrequired

voter_idxstringrequired

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://api.frill.co/v1/votes' \
  --header 'Authorization: Basic username:password'

200

400

200

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

Request was successful