LIST status {#list}

Get data on a list of status objects. Objects are order by default.

On retrieving large set of data, requester should use pagination parameters such as page and page_size to manage multiple requests.

Parameters

Parameters | Detail ----------------------------------- | ----------------------------------- campaign_id
optional |Filter return by campaign ID
Sample value: "11111111-1111-1111-1111-1111111 idea_count
optional |Specifies number of ideas in every status.
page_size
optional |Specifies number of records returns per page. Default: 20. Minimum: 1. Maximum: 100
Sample value: 50 page
optional |Specifies which page of records to return. Default: 1. Minimum: 1. Maximum: {pagecount}
Sample value: 5 order
optional |A SQL style string that specifies the order the records should return in.
Sample value: "datecreated ASC, Accepted attributes: "id", "name" format
optional |Specifies returned data format
Accepted value: "json", "xml"

Resource Information

Authentication: See Access Permission

HTTP Methods: GET

Request URL Format: https://{api_domain}/api3/status

Access Permission {#listPermission}

Access to data varies base on system setting and requester roles. See Authentication for details on authentication.

Private WebStorms: Requester must authenticate to get data.

Public WebStorms: No authentication required to get data.

Errors

Invalid object ID or you don't have access to this object

Example Request

Method: GET
Header: Authorization=Bearer 85f7b2462570acdde9a458ba6495b8763dcd040c
URL: https://example.brightidea.com/api3/status

~~~ { "status_list": [ { "id": "6F46DD30-896D-409B-BF96-E3920858CC55" "name": "Pending" }
```
    {
     "id": "5F6F93AF-FFDE-4FCB-94E9-AB8EF9A422DC"
     "name": "Under Review"
    }
]
"stats": {
    "total": "2"
    "page_count": 1
    "current_page": 1
}
```
} ~~~

FAQ {#faq}

Question: LIST status only return 100 objects maximum per request. How do I retrieve more results.

Answer: LIST status response is automatically paginated. You can specify which page of the result a request should return. For example, if you requested for 100 status objects in the initial request, pass "page_size=100&page=2" to get the next 100. page_count is returned with every LIST request so your application can figure out when it hits the end.

Question: How do I create a status?

Answer: CREATE status is not currently an available functionality.

Question: How do I delete a status?

Answer: DELETE status is not corrently an available functionality.