List

A list request is used to fetch one or more object representations of an entity. The result set is based on the default facility/company context filters and any optional filter parameters provided in the URI. The default results set is comprised of all resources for the given entity that are eligible to the requesting user. Since the result set may be of an arbitrarily size, a paginated data set is always returned.

The representation for all eligible objects can be requested by not providing the query string portion of the URI:

…/lgfapi/v10/company/

Query string filter parameters may optionally be used to further narrow down the data set. For example, to filter additionally by company code “ABC”, we would add the following:

…/lgfapi/v10/company/?code=ABC