List lists

User Guide > Resources > List lists

This request searches lists.

Resource

GET /lists

Parameters

Common Search Parameters

Name Type Description

where

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

Add additional search parameters [where=<parameter>=<value>]+ Search parameters:
-referable=<addressable OID> → Searches for all lists that contain the specified addressable.

Payload

None

Response

Object Response < List >

Context

Authorization

User

Errors

Common Errors

Example

Request
GET https://xelion.nl/api/v1/master/lists?name=Fav&limit=2
Response
{
    "data": [
        {
            "object": {
                "commonName": "Favorieten",
                "oid": "1035127",
                "objectType": "FavoritesList"
            },
            "links": [
                {
                    "rel": "self",
                    "href": "http://xelion.nl/api/v1/master/lists/1035127",
                    "method": "GET"
                }
            ]
        },
        {
            "object": {
                "commonName": "Favorieten",
                "oid": "1556336",
                "objectType": "FavoritesList"
            },
            "links": [
                {
                    "rel": "self",
                    "href": "http://xelion.nl/api/v1/master/lists/1556336",
                    "method": "GET"
                }
            ]
        }
    ],
    "meta": {
        "links": [
            {
                "rel": "refresh",
                "href": "http://xelion.nl/api/v1/master/lists",
                "method": "GET"
            },
            {
                "rel": "next",
                "href": "http://xelion.nl/api/v1/master/lists?after=1556336",
                "method": "GET"
            },
            {
                "rel": "previous",
                "href": "http://xelion.nl/api/v1/master/lists?before=1035127",
                "method": "GET"
            }
        ],
        "paging": {
            "previousId": "1035127",
            "nextId": "1556336"
        }
    }
}