List Chattables

User Guide > Resources > List Chattables

This request returns a list of addressables that can be chatted.

Resource

GET /addressables?type=chattable[&parameters]

Where the parameter 'type' is saying that only chattable addressables should be searched.
Chattables are always sorted by MRU and the sorting cannot be changed to something else.
Because it is sorted as MRU no paging is available for this API call.

Parameters

Common Search Parameters

Name Type Description

type

[chattable]

If type is chattables then return objects you can chat with.

include

[String]
seperate by comma if you want to include multiple fields

Include fields to the result.
-The field status/busy supported for presence information: include=status

Payload

None

Response

List Response < Addressable >

Context

Authorization

User

Errors

Common Errors

Example

Request
GET https://xelion.nl/api/v1/master/addressables/525125525/colleagues?limit=2&include=status
Response
{
    "data": [
        {
            "object": {
                "commonName": "Wesley",
                "oid": "1650975",
                "objectType": "Person"
            },
            "links": [
                {
                    "rel": "self",
                    "href": "https://xelion.nl/api/v1/master/addressables/1650975",
                    "method": "GET"
                }
            ]
        },
        {
            "object": {
                "commonName": "Chris",
                "oid": "1818085",
                "objectType": "Person"
            },
            "links": [
                {
                    "rel": "self",
                    "href": "https://xelion.nl/api/v1/master/addressables/1818085",
                    "method": "GET"
                }
            ]
        }
    ],
    "meta": {
        "links": [
            {
                "rel": "refresh",
                "href": "https://xelion.nl/api/v1/master/addressables",
                "method": "GET"
            }
        ]
    }
}