Sign in
ClientListValuesApiAgentResource

List the values of a client list, or check one key

Returns a page of the list's values, newest first. With key, returns only the value whose key equals it exactly, or an empty result when the list does not hold it — use this to check one key instead of paging the whole list. For a phone list, key is converted to E.164 first, as when adding it.

get/resources/api/agent/clientLists/{listId}/values

Path parameters

listIdstring required

Id of the list.

Query parameters

keystring

Exact key to look up. Omit it to get a page of values.

offsetinteger

Number of values to skip.

limitinteger

Maximum number of values to return.

Response

default response

errorstring
totalItemsinteger

Example response

{
  "items": [
    {
      "desc": "Germany",
      "key": "DEU"
    }
  ]
}

Changes

Changed in 1 of the 39 revisions of this API.1