Collections
Collection resources provide access to information about a list of objects of the same type. For example, you can use a collection resource to access information about a list of users. Collection resources are paged and may be sorted and filtered (depending on availability) - and will always return an object of type list.
Filters
Some collections support the ability to filter the results. Filtering a collection resource is conducted via the filter query parameter using the following notation:
?filter=[property].[condition]([value])
All filter values should be URL encoded:
?filter=URLEncode(*)
Accessing Properties
Properties are accessed using the following notation object.property.
Supported Conditions
eq | Equals |
bt | Between two values - used for date range filtering. |
gt | Greater than |
gteq | Greater than or equal to |
lt | Less than |
lteq | Less than or equal to |
ne | Not equals (only currently for Institutions endpoint) |
Where available, you can apply multiple filters to a collection by separating them with a comma.
?filter=transaction.postDate.bt('2018-01-28','2018-02-27'),account.id.eq('aef3g')
Multiple filters are treated as an and (&) operation example:
Note the examples above have not url encoded the filters. You will need to ensure that the filter values are url encoded before calling the resource.
GET /users/ea3a81/transactions?filter=transaction.postDate.bt('2018-01-01','2018-02-26') HTTP/1.1
Authorization: Bearer YOUR_ACCESS_TOKEN