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

get

/statuses

Authorizations

Query parameters

limitinteger · default: 20

Limits the number of items on a page

afterstring

The after cursor - used for pagination

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

200

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

Successfully returned a list of statuses

Create a status

Create a new status

post

/statuses

Authorizations

Body

namestring

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

200

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

Successfully created a new status

Update a status

Update a Status

post

/statuses/{statusIdx}

Authorizations

Path parameters

statusIdxstringrequired

Body

namestring

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

200

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

Successfully updated a status

Delete a status

Delete a Status

delete

/statuses/{statusIdx}

Authorizations

Path parameters

statusIdxstringrequired

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

200

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

Request was successful