GET
/
v2
/
status
Get Status
curl --request GET \
  --url https://api.sonderplan.com/v2/status \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": 1,
      "name": "Confirmed",
      "description": "The confirmed status",
      "type_id": 1,
      "notification": true,
      "order": 3,
      "color_background": "#B0A7F1",
      "color_text": "#000000",
      "created_id": 3,
      "created": 1388552400,
      "updated_id": 3,
      "updated": 1388552400
    }
  ],
  "meta": {
    "pagination": {
      "total": 1,
      "count": 1,
      "per_page": 1,
      "current_page": 1
    }
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
id
string

One or more (comma seperated) IDs of statuses to retrieve

​
name
string

Perform a full text search for the status name

​
description
string

Perform a full text search for the status description

​
fields
string

Comma seperated list of fields you wish to return

​
page
integer

Specify the page of results you wish to return

​
limit
integer

The number of results returned per page. Default if not specified is 10

​
order_asc
string

Specify the field (with type of string or integer) you wish to order (ascending) the response with

​
order_desc
string

Specify the field (with type of string or integer) you wish to order (descending) the response with

​
filter_operator
enum<string>
default:OR

Specify if multiple filters should be combined with OR or AND logic

Available options:
OR,
AND

Response

Successful Operation

​
data
Status Model · object[]
​
meta
object