List setups
Changed onReturns setups in the most recently created order. You can additionally filter setups by company.
get/setups
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
Filter setups by company ID.
idstring[]
Filter the list to the specified IDs. For more details, check out the Bulk Get Requests guide.
Response
200
Example response
{
"results": [
{
"id": "ese_NEgjqOcAv7wSgYCfLzI5",
"company": "com_KKVEd7FBm3MigJH02s7d",
"submitted_at": "2024-09-03T20:04:45Z",
"created_at": "2024-09-03T20:04:45.026017Z",
"profile": {
"previous_payroll_provider": "quickbooks_online",
"employee_count": 10,
"contractor_count": 2
},
"setup_due": "2024-09-13T14:20:13Z",
"phases": [
{
"name": "preliminary_review"
}
]
}
]
}Changes
- info
added the new optional
queryrequest parameterid
- info