List usage summaries
get/usage/summaries
Request
- Base URLhttps://sandbox.checkhq.com
- AuthAPI key in header Authorization
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
companystring
category'company' | 'employee' | 'contractor' | 'company_funding_failure' | 'payee_failed_payment' | 'wire' | 'one_day_payroll_processing_period'
period_startstring date
period_endstring date
Response
200
Example response
{
"results": [
{
"company": "com_dXE2p4wCM251HmlJB0Mn",
"category": "company",
"count": 1,
"period_start": "2024-05-01",
"period_end": "2024-05-31"
}
]
}Changes
No recorded changes to this operation across all 2 revisions of this API.