The Tabs list resource represents a set of tabs in a given agency. This can include both active and/or deleted tabs.
HTTP GET
GET /api/2013-12-01/Tabs/[Agency ID]
Returns a list of tabs for the given [Agency ID].
Paging
Paging can be accomplished by passing the page request parameter. By default only 100 tabs are returned per request. You can use the page_size request parameter to specify up to 10,000 tabs per request.
List Filters
The following list of parameters are available to help limit or filter the records returned. All parameters are case sensitive.
| Parameter | Description | Status | Only show tabs in the given Status. Valid values include [Active, Deleted] |
|---|---|
| Color | Only show tabs with the given background Color. Valid values include [Black, Blue, Green, Orange, Pink, Purple, Red, Yellow] |
| Name | Only show tabs that contain the given Name. |
| Subtitle | Only show tabs that contain the given Subtitle. |
Example Request
Fetch only active tabs.
$ curl -G https://[Site Name].readyop.com/api/2013-12-01/Tabs/[Agency ID] \
-u "[API Account ID]:[API Token]"Request Result
{
"code": 0,
"status": 200,
"detail": "Success",
"timestamp": "2019-01-31T19:51:14+00:00",
"tabs": [
{
"Tab ID": 23,
"Status": "Active",
"Name": "Main Dashboard",
"Subtitle": "",
"Date": "2019-01-31",
"Color": "Green"
},
], ...],
"results": 12,
"pages": 1,
"page": 0,
"page_start": 0,
"page_end": 11,
"page_size": 100
}