Home / GraphQL API

Search

Overview

All entities follow the same search and sorting conventions. When filtering for matches use the following examples to build your queries. Results will always be returned as a paginated list that you can traverse using cursors.

Filtering Basics

Every entity in our graph can be filtered by different fields. However, all fields of the same type follow similar conventions.

Date Filters

if you want to filter by a date range, you can use greaterThan, lessThan, greaterThanOrEqualTo, lessThanOrEqualTo, equals, or notEquals filters.

Number Filters

Like date filters, number filters have specific conditionals. You can use greaterThan, lessThan, greaterThanOrEqualTo, lessThanOrEqualTo, equals, or notEquals conditionals.

String Filters

You can filter with common string matching using, contains, equals, notEquals, startsWith, or endsWith.

List Filters

You can filter multiple values by choosing what values to include or exclude from the results.

Enum Filters

You can filter enums by including the values of the enum you wish to include, exclude, or match exactly.

Combine Filters

You can combine multiple filters together to construct more advanced queries.

Supported Types & Fields

TypeFieldFilter
TransactionEventpaymentCardIdList
eventTypeEnum
cardProductIdList
idList
PersonAccountHoldergivenNameString
middleNameString
familyNameString
dateOfBirthDate
emailString
LedgerEntryledgerNameEnum
createdAtString

Provide Feedback

Was this content helpful?