List methods

The Lightfield API supports fetching lists for most of the entities in your CRM, such as accounts. When you get a list of entities:

• you usually don’t get all of the results because there could be thousands of results (see: pagination), and
• you may not want all of the results (filtering).

Lightfield’s API uses limit and offset based pagination for list methods through the limit and offset query parameters.

Information fetched from list methods is served out of a search index that may not have recent changes. If getting the latest version of a record is a requirement, you will need to use the individual Retrieve methods.

Pagination

The Lightfield API supports the following parameters for paginating over a set of records:

• offset: This offsets the start of each page by the number specified.
• limit: This imposes an upper bound on the number of objects that will be returned. A query response may contain a number of records up to the value of limit. A client can assume there are no more records to fetch when the number of returned records is less than the limit provided by the client. The lowest value for limit is 1 and the highest is 100.

Do not store specific limit and offset values. Query results quickly become stale as new records are created and deleted from Lightfield.

Filtering

Filtering will be coming to the Lightfield API soon.