Application Query Language (APQL)
The Application Query Language allows one to filter applications using different modifiers.
Multiple modifiers in one query are supported, e.g. company.country:"DK" gateways.name:"QuickPay"
.
You can check for the existence of a property by suffixing the modifier with ?
, e.g. company.country?
.
You can do negative search by prefixing a modifier with !
, e.g. !company.country
. A common case for this is to search for resources without a certain property, e.g. !company.country?
.
Application
Query | Will search for… |
---|---|
id:"6c1ce8b0" | applications with id "6c1ce8b0" |
signer.name:"Mia M. Lassen" | applications with signer name "Mia M. Lassen" |
signer.email:"MiaMLassen@example.com" | applications with signer email "MiaMLassen@example.com" |
business_model.trading_name:"Acme Co." | applications with trading name "Acme Co." |
business_model.description:"Prime non-generic products" | applications with business model "Prime non-generic products" |
metadata.state:"unsubmitted"1 | applications with state "unsubmitted" |
metadata.created_at:>2016-07-252 | applications created after July 25th, 2016 |
1
One of:
archived
, unsubmitted
, submitted
, needs_information
, declined
, under_review
, accepted
.
2
Please refer to Date modifier for all supported values.
Bank Accounts
Query | Will search for… |
---|---|
bank_accounts.currency:"DKK" | applications with currency "DKK" |
bank_accounts.bank:"Acme Bank" | applications with bank "Acme Bank" |
bank_accounts.swift_code:"DABADKKK" | applications with SWIFT code "DABADKKK" |
bank_accounts.iban:"DK9230055205310542" | applications with IBAN "DK9230055205310542" |
Company
Query | Will search for… |
---|---|
company.name:"Acme Corporation" | applications with company name "Acme Corporation" |
company.registration_number:"33749996" | applications with company registration number "33749996" |
company.email:"info@example.com" | applications with company email "info@example.com" |
company.phone:"+45 23850071" | applications with company phone number "+45 23850071" |
company.address_line_1:"Nørrebrovænget 64" | applications with company address line 1 "Nørrebrovænget 64" |
company.address_line_2:"1st Floor" | applications with company address line 2 "1st Floor" |
company.zipcode:"1106" | applications with company zipcode "1106" |
company.city:"København K" | applications with company city "København K" |
company.country:"DK" | applications with company country "DK" |
Company People
Query | Will search for… |
---|---|
company.people.name:"Emile T. Madsen" | applications with people name "Emile T. Madsen" |
company.people.address_line_1:"Tårup Byvej 24" | applications with people address line 1 "Tårup Byvej 24" |
company.people.address_line_2:"1st Floor" | applications with people address line 2 "1st Floor" |
company.people.zipcode:"1265" | applications with people zipcode "1265" |
company.people.city:"København K" | applications with people city "København K" |
company.people.country:"DK" | applications with people country "DK" |
Contact
Query | Will search for… |
---|---|
contact.name:"Caroline S. Bech" | applications with contact name "Caroline S. Bech" |
contact.email:"CarolineSBech@example.com" | applications with contact email "CarolineSBech@example.com" |
contact.phone:"+45 41168678" | applications with contact phone number "+45 41168678" |
Websites
Query | Will search for… |
---|---|
websites.url:"www.example.com" | applications with website URL "www.example.com" |
Gateways
Query | Will search for… |
---|---|
gateways.name:"QuickPay" | applications with gateway name "QuickPay" |
Date
Query | Will search for… |
---|---|
metadata.created_at:today | applications created today |
metadata.created_at:yesterday | applications created yesterday |
metadata.created_at:last_week | applications created last week |
metadata.created_at:last_month | applications created last month |
metadata.created_at:last_year | applications created last year |
metadata.created_at:this_week | applications created from the beginning of this week until now |
metadata.created_at:this_month | applications created from the beginning of this month until now |
metadata.created_at:this_year | applications created from the beginning of this year until now |
metadata.created_at:>=2016-01-20 | applications created after or during January 20th, 2016 |
metadata.created_at:>2016-01-20 | applications created after January 20th, 2016 |
metadata.created_at:<=2016-01-20 | applications created before or during January 20th, 2016 |
metadata.created_at:<2016-01-20 | applications created before January 20th, 2016 |
metadata.created_at:*..2016-01-20 | applications created before or during January 20th, 2016 |
metadata.created_at:2016-01-20..* | applications created after or during January 20th, 2016 |
metadata.created_at:2016-01-18..2016-01-20 | applications created after or during January 18th and before or during January 20th, 2016 |