Customize the API with the &select Operator for Custom Objects

The API supports the &select operator which allows you to return custom objects from the API. Custom objects are slimmed down versions of the full subject-based models the API has used since its inception.

Custom objects are a way to greatly reduce the amount of properties returned from the API. By default, the API returns a full object which has all of the API-exposed properties related to the subject you are using. 

The benefits to using &select and custom objects are:

  • Performance of each API call is approx. 25% faster.

  • You get only what you need.

Use &select and Custom Objects

Getting a custom object is a simple change to your existing API queries.

Support has been added for the "&select" operator to help you define your custom object. Here are some examples using the Events subject:

/api/v2/Events?orgCode=10&search=EventID eq 5756&select=EventID,Designation,StartDateTime,EndDateTime

The result of the query is an object that looks like this:

[
{
"EventID": 5756,
"Designation": "X",
"StartDateTime": "1998-05-15T07:30:00",
"EndDateTime": "1998-05-15T16:15:00"
}
]