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

Returns a list of statuses

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

Query parameters

Response

200400

Successfully returned a list of statuses

Body

application/json

dataarray of Status (object)

paginationPagination (object)

Request

JavaScriptCurlPython

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

Response

200400

{
  "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

Create a new status

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

Body

application/json

namestring

Response

200400

Successfully created a new status

Body

application/json

idx*string

A unique identifier for the status

Example: "status_abcd1234"

namestring

Name of the status

Example: "Completed"

colorstring

Color associated with the status (displayed in the App)

Example: "#ff00ff"

created_atstring

The date & time the Status was last updated (UTC timezone)

updated_atstring

The date & time the Status was last updated (UTC timezone)

Request

JavaScriptCurlPython

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

Response

200400

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

Update a status

Update a Status

POSThttps://api.frill.co/v1/statuses/{statusIdx}

Path parameters

statusIdx*string

Body

application/json

namestring

Response

200400

Successfully updated a status

Body

application/json

idx*string

A unique identifier for the status

Example: "status_abcd1234"

namestring

Name of the status

Example: "Completed"

colorstring

Color associated with the status (displayed in the App)

Example: "#ff00ff"

created_atstring

The date & time the Status was last updated (UTC timezone)

updated_atstring

The date & time the Status was last updated (UTC timezone)

Request

JavaScriptCurlPython

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

Response

200400

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

Delete a status

Delete a Status

DELETEhttps://api.frill.co/v1/statuses/{statusIdx}

Path parameters

statusIdx*string

Response

200400

Request was successful

Body

application/json

successboolean

messagestring

Example: "Request was successful"

Request

JavaScriptCurlPython

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

Response

200400

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