GET v1/Lists?addItems={addItems}&forMenu={forMenu}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| addItems | boolean |
Default value is False |
|
| forMenu | boolean |
Default value is False |
Body Parameters
None.
Response Information
Resource Description
Collection of ListOutModel| Name | Description | Type | Additional information |
|---|---|---|---|
| items | Collection of BaseModel |
None. |
|
| id | integer |
None. |
|
| name | string |
Required |
|
| description | string |
None. |
|
| isMenuList | boolean |
None. |
|
| listType | integer |
None. |
Response Formats
application/json, text/json, application/vnd.team.do+json
Sample:
[
{
"items": [
{
"id": 1,
"name": "sample string 2",
"listId": 3,
"orderRow": 4,
"color": "sample string 5",
"textColor": "sample string 6"
},
{
"id": 1,
"name": "sample string 2",
"listId": 3,
"orderRow": 4,
"color": "sample string 5",
"textColor": "sample string 6"
}
],
"id": 1,
"name": "sample string 2",
"description": "sample string 3",
"isMenuList": true,
"listType": 5
},
{
"items": [
{
"id": 1,
"name": "sample string 2",
"listId": 3,
"orderRow": 4,
"color": "sample string 5",
"textColor": "sample string 6"
},
{
"id": 1,
"name": "sample string 2",
"listId": 3,
"orderRow": 4,
"color": "sample string 5",
"textColor": "sample string 6"
}
],
"id": 1,
"name": "sample string 2",
"description": "sample string 3",
"isMenuList": true,
"listType": 5
}
]
text/html
Sample:
[{"items":[{"id":1,"name":"sample string 2","listId":3,"orderRow":4,"color":"sample string 5","textColor":"sample string 6"},{"id":1,"name":"sample string 2","listId":3,"orderRow":4,"color":"sample string 5","textColor":"sample string 6"}],"id":1,"name":"sample string 2","description":"sample string 3","isMenuList":true,"listType":5},{"items":[{"id":1,"name":"sample string 2","listId":3,"orderRow":4,"color":"sample string 5","textColor":"sample string 6"},{"id":1,"name":"sample string 2","listId":3,"orderRow":4,"color":"sample string 5","textColor":"sample string 6"}],"id":1,"name":"sample string 2","description":"sample string 3","isMenuList":true,"listType":5}]