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 25.

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

Filtering

The Lightfield API supports filtering over a set of records. Depending on the data type(s) of the field(s) you want to filter by, different comparison operators are available.

Currently, the Lightfield API only supports filtering by fields. This means filtering by relationships is not yet supported.

Data Type	equal 2	greaterThan, etc.	startsWith	contains 2
NUMBER	yes	yes	no	no
CURRENCY	yes	yes	no	no
DATETIME	yes	yes	no	no
TEXT	yes	no	yes	no
FULL_NAME	yes	no	yes	no
SOCIAL_HANDLE	yes	no	yes	no
ADDRESS	yes	no	yes	no
CHECKBOX	yes	no	no	no
SINGLE_SELECT	yes	no	no	no
EMAIL	no	no	no	yes
TELEPHONE	no	no	no	yes
URL	no	no	no	yes
MULTI_SELECT 1	no	no	no	no
MARKDOWN1	no	no	no	no

¹ Rows with all no means filtering by that data type is not yet supported.

² If an operator is not provided, it will default to equal if equal is valid, or contains otherwise.

All operators can be negated by prefixing them with -; for instance, -equal means “everything not equal to this value”.

Examples

This is especially useful if you want to check if a record exists according to certain criteria before creation. We highly recommend searching if record already exists before creation. This will make sure Lightfield does not accumulate duplicate records.

# Check if the Lightfield account exists.
curl https://api.lightfield.app/v1/accounts \
  -G \
  --data-urlencode '$name[equals]=lightfield'

# Check if a contact exists with a given email.
curl https://api.lightfield.app/v1/contacts \
  -G \
  --data-urlencode '$email[contains]=example@lightfield.app'

Other examples

# Find accounts with at least 10,000 employees AND
# an ICP score lower than 6. ICP score is a user-defined attribute.
curl https://api.lightfield.app/v1/accounts \
  -G \
  --data-urlencode '$headcount[equal]=10001+' \
  --data-urlencode 'icp-score[lessThan]=6

# Find very valuable opportunities that had an
# interaction since March 1st, 2026.
curl https://api.lightfield.app/v1/opportunities \
  -G \
  --data-urlencode '$amount[greaterThanOrEqual]=100000000' \
  --data-urlencode '$lastInteractionAt[greaterThanOrEqual]=2026-03-01T00:00:00.000Z'

You can query a field that supports startWith with an empty string to find all records that have that value set, but not empty.

# Find all C-suite executives that we can reach out
# to through Instagram, except Alice Bob.
curl https://api.lightfield.app/v1/contacts \
  -G \
  --data-urlencode '$doNotContact[equal]=false' \
  --data-urlencode '$instagram[startsWith]=' \
  --data-urlencode '$title[startsWith]=Chief' \
  --data-urlencode '$name[-equal]=Alice Bob'