Custom lists

Details of a specific custom list

To retrieve the details of a specific list, the endpoint must be passed with the custom list ID. The link can be usually found in the link attribute of each customlist item.

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

createdDate

String

Specifies the date of the list creation.

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.

customlabellists

Object

Contains the individual list items that make up this list.

  • The ‘name’ is the text that is shown to the user.
  • The ‘value’ is the internally passed in value.

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/4E2101D0E5D16229?apikey=[your_api_key]

Authorization: Basic asdf98nf89asdvasd2r398h8sdf

x-api-key: your_api_key

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

{

"id": "4E2101D0E5D16229",

"name": "Category",

"type": "INCIDENT",

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

"sortType": "As Displayed",

"linked": "disabled",

"customlabellists": [

{

"name": "Internal Systems",

"value": "Internal Systems"

},

{

"name": "External Systems",

"value": "External Systems"

},

{

"name": "Infrastructure",

"value": "Infrastructure"

}

],

"link": [

{

"uri": "https://api.<region>.whispir.com/customlists/40E5D16229E2101D?apikey=7qyxe7z37tsdy9spv6sw6uec",

"rel": "self",

"method": "GET"

}

]

}

{{codeEnd}}