Get Todo Line

This request returns the todo list items of a line.
The items are always returned in an ascending order, ordered by start date (1) + orderNumber (2).

Resource

GET /me/todo_lines/<OID>

Where OID is the object ID of the phone line.

Parameters

Name Type Description

Name	Type	Description
`where`	[String] separate by comma if you want to include multiple fields	Add additional search parameters [where=<parameter>=<value>]+ Search parameters: -status=Todo list status → Searches for all items with the selected status. -assignedTo= → Searches for all items with the selected assigned to.
`limit`	Integer	The maximum number of objects to return. Default: 15.
`only_open_items`		Only show the open items.
`before`	String	Return objects with Value smaller then this Value, this is a combination of start date (as instant) and order number.
`after`	String	Return objects with Value larger then this Value, this is a combination of start date (as instant) and order number.

where

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

Add additional search parameters [where=<parameter>=<value>]+ Search parameters:
-status=Todo list status → Searches for all items with the selected status. -assignedTo= → Searches for all items with the selected assigned to.

limit

Integer

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

only_open_items

Only show the open items.

before

String

Return objects with Value smaller then this Value, this is a combination of start date (as instant) and order number.

after

String

Return objects with Value larger then this Value, this is a combination of start date (as instant) and order number.

Payload

None

Response

List Response < List Item >

Context

Authorization

User

Errors

Common Errors

Example

Request

GET https://xelion.nl/api/v1/master/me/todo_lines/1651614?where=status=booked&limit=3&before=_2

Response

{
    "data": [
        {
            "object": {
                "item": {
                    "commonName": "Xelion B.V.",
                    "oid": "1041861",
                    "objectType": "Organisation"
                },
                "isUser": false,
                "comments": "Terugbellen",
                "orderNumber": 1,
                "startTime": "2023-02-09 14:00:00",
                "endTime": "2023-02-09 15:00:00",
                "status": "booked",
                "assignedTo": {
                    "person": {
                        "commonName": "Wesley",
                        "oid": "1650975",
                        "objectType": "Person"
                    },
                    "commonName": "wes",
                    "oid": "1651218",
                    "objectType": "UserProfile"
                },
                "oid": "2082029",
                "objectType": "X1ListItem"
            },
            "links": [
                {
                    "rel": "self",
                    "method": "GET"
                }
            ]
        },
        {
            "object": {
                "item": {
                    "commonName": "Org123",
                    "oid": "1966741",
                    "objectType": "Organisation"
                },
                "isUser": false,
                "comments": "Terugbellen",
                "orderNumber": 2,
                "startTime": "2023-02-10 10:00:00",
                "endTime": "2023-02-10 11:00:00",
                "status": "booked",
                "assignedTo": {
                    "person": {
                        "commonName": "Wesley",
                        "oid": "1650975",
                        "objectType": "Person"
                    },
                    "commonName": "wes",
                    "oid": "1651218",
                    "objectType": "UserProfile"
                },
                "oid": "2082032",
                "objectType": "X1ListItem"
            },
            "links": [
                {
                    "rel": "self",
                    "method": "GET"
                }
            ]
        }
    ],
    "meta": {
        "links": [
            {
                "rel": "refresh",
                "href": "https://xelion.nl/api/v1/master/me/todo_lines/1651614",
                "method": "GET"
            },
            {
                "rel": "next",
                "href": "https://xelion.nl/api/v1/master/me/todo_lines/1651614?after=1676023200_2",
                "method": "GET"
            },
            {
                "rel": "previous",
                "href": "https://xelion.nl/api/v1/master/me/todo_lines/1651614?before=1675951200_1",
                "method": "GET"
            }
        ],
        "paging": {
            "previousId": "1675951200_1",
            "nextId": "1676023200_2"
        }
    }
}