How to get a specific list item

• 1 minute to read

The List endpoint provides methods that we can use to retrieve a single entry of a given list by providing the unique identifier of the list as a parameter. For example, we can get a specific country by using the method GetCountry and providing the country ID as the parameter.

The following list contains a few of the many methods available.

GetCountry
GetBusiness
GetCategory
GetCredited
GetCurrency

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

Specify which category Id by using the categoryId query string parameter.

POST https://{{env}}.superoffice.com/{{tenant}}/api/v1/Agents/List/GetCategory?categoryId=3 HTTP/1.1
Authorization: Bearer {{token}}
Accept: application/json; charset=utf-8

Get a list item using the SuperOffice.WebApi proxy client.

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

var listEntity = agent.GetCategoryAsync(3).Result;

Back