Get Presence Groups

User Guide > Resources > Get Presence Groups

This request returns a list of presence groups.
The results are always in ascending order and is ordered by index.

Only the next results link is given, there is no way to go back in results (except remembering the previous API call).

Resource

GET /presencegroups

Parameters

Name Type Description

Name	Type	Description
`name`	String	Select objects whose common name matches this string.
`limit`	Integer	The maximum number of objects to return. Default: 15.
`after`	[value]	Return objects with Value larger then this Value.

name

String

Select objects whose common name matches this string.

limit

Integer

The maximum number of objects to return. Default: 15.

after

[value]

Return objects with Value larger then this Value.

Payload

None

Response

Object Response < PresenceGroup >

Context

Authorization

User

Errors

Common Errors

Example

Request

GET https://xelion.nl/api/v1/master/presencegroups

Response

{
    "data": [
        {
            "object": {
                "index": 1,
                "all": false,
                "commonName": "test",
                "oid": "2005143",
                "objectType": "PresenceGroup"
            },
            "links": [
                {
                    "rel": "self",
                    "href": "https://xelion.nl/api/v1/master/presencegroups/2005143",
                    "method": "GET"
                }
            ]
        },
        {
            "object": {
                "index": 2,
                "all": false,
                "commonName": "not all",
                "oid": "2005158",
                "objectType": "PresenceGroup"
            },
            "links": [
                {
                    "rel": "self",
                    "href": "https://xelion.nl/api/v1/master/presencegroups/2005158",
                    "method": "GET"
                }
            ]
        }
    ],
    "meta": {
        "links": [
            {
                "rel": "refresh",
                "href": "https://xelion.nl/api/v1/master/presencegroups",
                "method": "GET"
            },
            {
                "rel": "next",
                "href": "https://xelion.nl/api/v1/master/presencegroups?after=2_2005158",
                "method": "GET"
            }
        ],
        "paging": {
            "nextId": "2_2005158"
        }
    }
}