Pagination, Filtering & Sorting

When filtering using the API, we offer the following three options to assist you in querying your data:

• Filter
• Pagination
• Sort

For sample requests, please see the code samples section.

Filter

🚧

The filter object accepts either operator and operands as group expressions or it accepts field and comparator and value as field-value comparisons.

Group expressions:

• operator An optional string whose values can be either and or or.
• operands Is a list of self referencing filter objects.

Field-value comparison:

• field The key which you would like to search against.
• comparator A comparator enum value.
• value A value you would like to filter against.

JSON

{
	"operator": (optional)string,
	"operands": (optional)[]filter,

	"field": (optional)string,
	"comparator": (optional)string,
	"value": (optional)any,
}

Pagination

page accepts the following:

• offset The number of results to skip over.
• limit The number of results to return.

JSON

{
	"offset": (optional)int,
	"limit": (optional)int,
}

Sort

When using sort, you can use multiple sort objects to order your outputs in your preferred order. It is important to remember that null values are considered the lower possible value. When using the asc direction null values will appear first, and when using desc they will appear last.

[]sort accepts the following:

• field is the field by which you would like to sort.
• direction the direction in which you would like the results returned. This can be either asc or desc.

JSON

[
	{
		"field": string,
		"direction": enum,
	}
]

Comparators

Comparator	Description
eq	equal
ne	not equal
gt	greater than
ge	greater or equal
lt	less than
le	less than or equal
contains	contains
not_contains	does not contain
is_any	is any (compare a single element against an array)
is_not_any	is not any (compare a single element against an array)
includes_any	includes any (array)
includes_all	includes all (array)
excludes_any	excludes any (array)
excludes_all	excludes all (array)
eq_date	equals date
ne_date	does not equal date
rp_eq_date	relative past equal date
rp_lt	relative past less than date
rp_gt	relative past greater than date
rf_eq_date	relative future equal date
rf_lt	relative future less than date
rf_gt	relative future greater than date

Code Samples

Find a supplier by name

Using the filter rule, we can find a supplier by name:

JSON

{
  "filter": {
    "field": "name",
    "comparator": "eq",
    "value": "ACME Corp"
  }
}

Find suppliers with more than 3 remediation requests

JSON

{
  "filter": {
    "field": "numRemediationRequests",
    "comparator": "gt",
    "value": 3
  }
}

Find suppliers who have not yet approved a connection, who are located in London and return them two at a time in descending order

JSON

{
  "filter": {
    "operator": "and",
    "operands": [
      {
        "field": "approvalStatus",
        "comparator": "eq",
        "value": "unapproved"
      },
      {
        "field": "city",
        "comparator": "eq",
        "value": "London"
      }
    ]
  },
  "page": {
    "offset": 0,
    "limit": 2
  },
  "sort": [
    {
      "field": "connectedAt",
      "direction": "desc"
    }
  ]
}