Statuses

Statuses reflect the current stage of an Idea or feature request for your product as it progresses from suggestion, through development, to completion.

Status object

Status have the following fields

Field	Details
idx string	A unique identifier for the idea
name string	Name of the status
color string	Color associated with the status (displayed in the App)

Endpoints

You can use the following endpoints to manage Statuses

List statuses

get

Returns a list of statuses

Authorizations

Query parameters

limitintegerOptional

Limits the number of items on a page

Default: 20

afterstringOptional

The after cursor - used for pagination

Responses

200

Successfully returned a list of statuses

application/json

400

Invalid request

application/json

get

HTTPcURLJavaScriptPython

GET /v1/statuses HTTP/1.1
Host: api.frill.co
Authorization: Basic username:password
Accept: */*

{
  "data": [
    {
      "idx": "status_abcd1234",
      "name": "Completed",
      "color": "#ff00ff",
      "created_at": "text",
      "updated_at": "text"
    }
  ],
  "pagination": {
    "total": 10,
    "before": "before-cursor",
    "after": "after-cursor"
  }
}

Create a status

post

Create a new status

Authorizations

Body

namestringOptional

Responses

200

Successfully created a new status

application/json

400

Invalid request

application/json

post

HTTPcURLJavaScriptPython

POST /v1/statuses HTTP/1.1
Host: api.frill.co
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "name": "text"
}

{
  "idx": "status_abcd1234",
  "name": "Completed",
  "color": "#ff00ff",
  "created_at": "text",
  "updated_at": "text"
}

Update a status

post

Update a Status

Authorizations

Path parameters

statusIdxstringRequired

Body

namestringOptional

Responses

200

Successfully updated a status

application/json

400

Invalid request

application/json

post

HTTPcURLJavaScriptPython

POST /v1/statuses/{statusIdx} HTTP/1.1
Host: api.frill.co
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "name": "text"
}

{
  "idx": "status_abcd1234",
  "name": "Completed",
  "color": "#ff00ff",
  "created_at": "text",
  "updated_at": "text"
}

Delete a status

delete

Delete a Status

Authorizations

Path parameters

statusIdxstringRequired

Responses

200

Request was successful

application/json

400

Invalid request

application/json

delete

HTTPcURLJavaScriptPython

DELETE /v1/statuses/{statusIdx} HTTP/1.1
Host: api.frill.co
Authorization: Basic username:password
Accept: */*

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