Custom lists

Retrieving custom lists

You need to supply one of the following headers (for retrieving JSON or XML):

  • Accept: application/vnd.whispir.customlist-v1+xml
  • Accept: application/vnd.whispir.customlist-v1+json

An array of custom lists will be returned to you in the HTTP response body.

High-level response elements

id

Number

Specifies the unique ID of the list.

name

String

Specifies the name of the list.

type

String

Specifies the type. The type can be one of the following:

  • INCIDENT
  • MESSAGE
  • CONTACT
  • RSS

sorttype

String

Specifies the sorting order. The order can be one of the following:

  • As Displayed.
  • Ascending.
  • Descending.

linked

String

Specifies the linked status. Linked list item values are dependent on other lists. The ‘linked’ value can be one of the following:

  • disabled
  • list ID to which this is linked.

link

Array

Provides a list of URLs that can be used to manipulate or access the list:

  • uri: The link to access the list.
  • rel: The descriptor for what the link will do.
  • method: The HTTP method to use with this particular link.


  • JSON
  • XML

{{codeStart}}

HTTP 1.1 GET https://api.<region>.whispir.com/customlists?apikey=[your_api_key]

Authorization: Basic asdf98nf89asdvasd2r398h8sdf

x-api-key: your_api_key

Accept: application/vnd.whispir.customlist-v1+json

{

"status": "1 to 5 of 5",

"customlabels": [

{

"id": "4E2101D0E5D16229",

"name": "Category",

"type": "INCIDENT",

"createdDate": "02/08/19 14:20",

"sortType": "As Displayed",

"linked": "disabled",

"link": [

{

"uri": "https://api.<region>.whispir.com/customlists/40E5D16229E2101D?apikey=[your_api_key]",

"rel": "self",

"method": "GET"

}

]

},

{

"id": "0CA7B9E2B21A3B1A",

"name": "Day of Month",

"type": "MESSAGE",

"createdDate": "13/10/19 16:30",

"sortType": "As Displayed",

"linked": "disabled",

"link": [

{

"uri": "https://api.<region>.whispir.com/customlists/0CA7B9E2B21A3B1A?apikey=[your_api_key]",

"rel": "self",

"method": "GET"

}

]

},

{

"id": "87F23964C25ECF22",

"name": "Day of Week",

"type": "MESSAGE",

"createdDate": "07/01/19 09:51",

"sortType": "As Displayed",

"linked": "disabled",

"link": [

{

"uri": "https://api.<region>.whispir.com/customlists/87F23964C25ECF22?apikey=[your_api_key]",

"rel": "self",

"method": "GET"

}

]

},

{

"id": "F0771B97F1EF770B",

"name": "External Vendor",

"type": "INCIDENT",

"createdDate": "02/08/19 14:20",

"sortType": "As Displayed",

"linked": "disabled",

"link": [

{

"uri": "https://api.<region>.whispir.com/customlists/F0771B97F1EF770B?apikey=[your_api_key]",

"rel": "self",

"method": "GET"

}

]

},

{

"id": "768E4ACA5DA7500C",

"name": "Finish Time",

"type": "MESSAGE",

"createdDate": "01/08/19 12:38",

"sortType": "As Displayed",

"linked": "disabled",

"link": [

{

"uri": "https://api.<region>.whispir.com/customlists/768E4ACA5DA7500C?apikey=[your_api_key]",

"rel": "self",

"method": "GET"

}

]

}

],

"link": []

}

{{codeEnd}}