How to get all lists

• 1 minute to read

To get all available lists, use the Lists keyword.

GET https://{{env}}.superoffice.com/{{tenant}}/api/v1/List 
Authorization: Bearer {{token}}
Accept: application/json; charset=utf-8

Ironically, it's not possible to get all lists from the List endpoint. Use the MDO endpoint to get all built-in and user-defined lists.

This has some limitations in that the results do not specify if the list uses Groups and Headings. For that, use the RESTful REST List endpoint.

POST https://{{env}}.superoffice.com/{{tenant}}/api/v1/Agents/MDO/GetList HTTP/1.1
Authorization: Bearer {{token}}
Accept: application/json; charset=utf-8
Content-Type: application/json; charset=utf-8

{
  "Name": "Lists",
  "ForceFlatList": false,
  "AdditionalInfo": "",
  "OnlyHistory": false
}

Ironically, it's not possible to get all lists from the ListAgent. Use the MDO endpoint to get all built-in and user-defined lists.

This has some limitations in that the results do not specify if the list uses Groups and Headings. For that, use the RESTful REST List endpoint.

var config = new WebApiOptions(tenant.WebApiUrl);
config.Authorization = new AuthorizationAccessToken("8A:Cust12345.Example-Token", OnlineEnvironment.SOD);
var mdoAgent = new MDOAgent(config);

var allLists = mdoAgent.GetSimpleListAsync("lists").Result;

Back