Query Overview (Shared Parameters)

Overview

These parameters apply to all POST Query endpoints unless otherwise noted. Use the headings below to quickly find the information you need when constructing API requests.

Pagination

The API supports two pagination methods:

• Cursor-based – recommended for large exports.
• Page-based – recommended for user interface scenarios.

Parameters:

• page (Integer) – The page number to retrieve. Default: 1.
• limit (Integer) – The number of items per page. Default: X. Max: X.

Sparse Fieldsets

To improve performance, request only the specific fields you need using the fields parameter.

Usage: ?fields=id,name,email,created_at

Filtering

Filters are passed as query parameters using the syntax field[operator]=value.

General Rules

• Case Sensitivity: Operator names are case-sensitive. Compared values are not case-sensitive.
• Text Handling:
  • Standard characters allowed: a-z, A-Z, 0-9, space.
  • Special characters allowed: |.!@#$%^&*()_+={}[]/?;:,<>~-\ `.
  • Quotes: Values containing single quotes ('), double quotes ("), or spaces in the middle do not need enclosing quotes. However, leading/trailing spaces or values containing commas must be enclosed in quotes (e.g., "Sunrise, Florida").
  • Escaping: When using platforms like Postman, escape double quotes appearing in text values (e.g., \").

Supported Operators

Operator	Syntax	Example	Description
Equals	eq (default)	?status=active	Exact match. Supports Text, Numeric, Date, Boolean, and GUID fields.
Not Equals	ne	?status[ne]=archived	Exclude values (Source operator <>).
Greater Than	gt	?amount[gt]=100	Values greater than X. Valid for Text, Numeric, and Date fields.
Less Than	lt	?amount[lt]=500	Values less than X. Valid for Text, Numeric, and Date fields.
Greater/Equal	ge	?amount[ge]=100	Values greater than or equal to X.
Less/Equal	le	?amount[le]=500	Values less than or equal to X.
In List	in	?id[in]=1,2,3	Matches a comma-separated list of values.
Not In List	notin	?id[notin]=4,5	Excludes a comma-separated list of values.
Like	like	?name[like]=Smith	Wildcard match. If no % is provided, it assumes wildcards at start/end (%Smith%).
Not Like	notlike	?name[notlike]=Test	Excludes text matching the wildcard pattern. Note: Not available in Boomi connector.
Is Null	isnull	?status[isnull]=NULL	Matches records where the value is NULL.
Is Not Null	isnotnull	?status[isnotnull]=NULL	Matches records where the value is NOT NULL.

Data Type Formatting

• Boolean Fields: Queries support equivalent values interchangeably.

  • True: 1, true, True, Yes, yes.
  • False: 0, false, False, No, no.

• Date/Time Fields: Valid formats follow the T-SQL CONVERT DATE function standards.

  • Note: Dates containing commas (e.g., "July 1, 2022") must be enclosed in single or double quotes.

• Multiple Pick List Fields:

  • Exact Match: Enclose values in vertical bars. For multiple values, separate with bars: |value1|value2|. Order must match exactly as selected on the web page.
  • Contains: To filter for records containing one or more ad-hoc selected values, use the like operator (e.g., MyField LIKE |Value1|).

• Wildcards (for Like/Not Like):

  • % – Any string of zero or more characters.
  • _ – Any single character.
  • [ ] – Any single character within a range (e.g., [a-f]).
  • [^] – Any single character not within a range (e.g., [^a-f]).

Sorting

Use the sort parameter. Prefix with - for descending order.

• Ascending: ?sort=created_at
• Descending: ?sort=-amount
• Multi-field: ?sort=-priority,created_at (Sort by priority desc, then date asc).