List Colleagues or Employees


This request returns a list of employees that work at the same organisation(s) as the specified person or the specified organisation.

Resource

GET /addressables/<OID>/colleagues[?parameters]

Where OID is the object ID of the person or organisation.

Payload

None

Response

Context

Authorization

User

Errors

Example

Request
GET https://xelion.nl/api/v1/master/addressables/525125525/colleagues?limit=2&include=status
Response
{
    "data": [
        {
            "object": {
                "nrCommunications": 8,
                "status": "offline",
                "busy": false,
                "commonName": "Arno Brugman",
                "x1syncsource": "csv",
                "oid": "1650938",
                "objectType": "Person"
            },
            "links": [
                {
                    "rel": "self",
                    "href": "http://xelion.nl/api/v1/master/addressables/1650938",
                    "method": "GET"
                }
            ]
        },
        {
            "object": {
                "nrCommunications": 0,
                "status": "offline",
                "busy": false,
                "commonName": "Vossen van der Vossen",
                "x1syncsource": "csv",
                "oid": "1650953",
                "objectType": "Person"
            },
            "links": [
                {
                    "rel": "self",
                    "href": "http://xelion.nl/api/v1/master/addressables/1650953",
                    "method": "GET"
                }
            ]
        }
    ],
    "meta": {
        "links": [
            {
                "rel": "refresh",
                "href": "http://xelion.nl/api/v1/master/addressables/1650975/colleagues",
                "method": "GET"
            },
            {
                "rel": "next",
                "href": "http://xelion.nl/api/v1/master/addressables/1650975/colleagues?after=1650953",
                "method": "GET"
            },
            {
                "rel": "previous",
                "href": "http:/xelion.nl/api/v1/master/addressables/1650975/colleagues?before=1650938",
                "method": "GET"
            }
        ],
        "paging": {
            "previousId": "1650938",
            "nextId": "1650953"
        }
    }
}