Search Addressables

User Guide > Resources > Search Addressables

This request returns a list of addressables.

Sort by MRU if you want to search with keywords (like a phonenumber).
When MRU sort is used, not all extra fields can be included.

Resource

GET /addressables[?parameters]

Parameters

Addressables Search Parameters

Payload

None

Response

List Response < Addressable >

Context

Authorization

User

Errors

Common Errors

Examples

Search by mru

Request
GET https://xelion.nl/api/v1/master/addressables?order_by=mru&name=06123
Response
{
  "data": [
    {
      "object": {
        "commonName": "Arnon Ron",
        "oid": "1556377",
        "objectType": "Person",
        "keywords": "[0612348765]"
      },
      "links": [
        {
          "rel": "self",
          "href": "http://xelion.nl/api/v1/master/addressables/1556377",
          "method": "GET"
        }
      ]
    },
    {
      "object": {
        "iconId": "1566787",
        "commonName": "Sergey Novitsky",
        "oid": "1557797",
        "objectType": "Person",
        "keywords": "[0612345678]"
      },
      "links": [
        {
          "rel": "self",
          "href": "http://xelion.nl/api/v1/master/addressables/1557797",
          "method": "GET"
        }
      ]
    },
    {
      "object": {
        "commonName": "Sander Kloos",
        "oid": "1557855",
        "objectType": "Person",
        "keywords": "[061237777]"
      },
      "links": [
        {
          "rel": "self",
          "href": "http://xelion.nl/api/v1/master/addressables/1557855",
          "method": "GET"
        }
      ]
    },

    ..

  "meta": {
    "paging": {
      "refresh": {
        "rel": "refresh",
        "href": "http://xelion.nl/api/v1/master/addressables",
        "method": "GET"
      }
    }
  }
}

Search without mru

Request
GET https://xelion.nl/api/v1/master/addressables?name=Arno
Response
{
  "data": [
    {
      "object": {
        "commonName": "Arnon Ron",
        "oid": "1556377",
        "objectType": "Person"
      },
      "links": [
        {
          "rel": "self",
          "href": "http://xelion.nl/api/v1/master/addressables/1556377",
          "method": "GET"
        }
      ]
    },
    {
      "object": {
        "iconId": "1566787",
        "commonName": "Arno Brugman",
        "oid": "1557797",
        "objectType": "Person"
      },
      "links": [
        {
          "rel": "self",
          "href": "http://xelion.nl/api/v1/master/addressables/1557797",
          "method": "GET"
        }
      ]
    },

    ..

  "meta": {
    "paging": {
      "refresh": {
        "rel": "refresh",
        "href": "http://xelion.nl/api/v1/master/addressables",
        "method": "GET"
      }
    }
  }
}

Include status and employment

Request
GET https://xelion.nl/api/v1/master/addressables?order_by=mru&name=06123&include=status,employment
Response
{
  "data": [
    {
        "object": {
        "employments": [
          {
            "commonName": "Xelion",
            "organisation": {
              "name": "Xelion",
              "commonName": "Xelion",
              "oid": "1650916",
              "objectType": "Organisation"
            },
            "oid": "1651104",
            "objectType": "Employee"
          }
        ],
        "status": "offline",
        "busy": false,
        "commonName": "Arnon Ron",
        "oid": "1556377",
        "objectType": "Person",
        "keywords": "[0612348765]"
      },
      "links": [
        {
          "rel": "self",
          "href": "http://xelion.nl/api/v1/master/addressables/1556377",
          "method": "GET"
        }
      ]
    },
    {
      "object": {
        "employments": [
          {
            "commonName": "Programmer (Xelion)",
            "organisation": {
              "name": "Xelion",
              "commonName": "Xelion",
              "oid": "1650916",
              "objectType": "Organisation"
            },
            "oid": "1651104",
            "objectType": "Employee"
          }
        ],
        "status": "available",
        "busy": true,
        "iconId": "1566787",
        "commonName": "Sergey Novitsky",
        "oid": "1557797",
        "objectType": "Person",
        "keywords": "[0612345678]"
      },
      "links": [
        {
          "rel": "self",
          "href": "http://xelion.nl/api/v1/master/addressables/1557797",
          "method": "GET"
        }
      ]
    },
    {
      "object": {
        "commonName": "Xelion",
        "oid": "1557855",
        "objectType": "Organisation",
        "keywords": "[06123999]"
      },
      "links": [
        {
          "rel": "self",
          "href": "http://xelion.nl/api/v1/master/addressables/1557855",
          "method": "GET"
        }
      ]
    },

    ..

  "meta": {
    "paging": {
      "refresh": {
        "rel": "refresh",
        "href": "http://xelion.nl/api/v1/master/addressables",
        "method": "GET"
      }
    }
  }
}

Search chattables

Request
GET https://xelion.nl/api/v1/master/addressables?order_by=mru&name=arno&type=chattables
Response
{
  "data": [
    {
      "object": {
        "commonName": "Arnon Ron",
        "oid": "1556377",
        "objectType": "Person",
        "keywords": "[arnon]"
      },
      "links": [
        {
          "rel": "self",
          "href": "http://xelion.nl/api/v1/master/addressables/1556377",
          "method": "GET"
        }
      ]
    },
    {
      "object": {
        "iconId": "1566787",
        "commonName": "Arno Brugman",
        "oid": "1557797",
        "objectType": "Person",
        "keywords": "[arno]"
      },
      "links": [
        {
          "rel": "self",
          "href": "http://xelion.nl/api/v1/master/addressables/1557797",
          "method": "GET"
        }
      ]
    },

    ..

  "meta": {
    "paging": {
      "refresh": {
        "rel": "refresh",
        "href": "http://xelion.nl/api/v1/master/addressables",
        "method": "GET"
      }
    }
  }
}