openapi: 3.2.0 info: title: check-api Setups API version: '2025-01-01' servers: - url: https://sandbox.checkhq.com security: - sec0: [] tags: - name: Setups paths: /setups: get: summary: List setups description: Returns setups in the most recently created order. You can additionally filter setups by company. operationId: list-setups parameters: - name: company in: query description: Filter setups by company ID. schema: type: string - name: id in: query description: Filter the list to the specified IDs. For more details, check out the [Bulk Get Requests guide](https://docs.checkhq.com/docs/bulk-resource-get-requests). schema: type: array items: type: string responses: '200': description: '200' content: application/json: examples: Result: value: "{\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \"id\": \"ese_NEgjqOcAv7wSgYCfLzI5\",\n \"company\": \"com_KKVEd7FBm3MigJH02s7d\",\n \"submitted_at\": \"2024-09-03T20:04:45Z\",\n \"completed_at\": null,\n \"closed_at\": null,\n \"created_at\": \"2024-09-03T20:04:45.026017Z\",\n \"profile\": {\n \"previous_payroll_provider\": \"quickbooks_online\",\n \"first_payroll\": null,\n \"first_payroll_of_year\": null,\n \"employee_count\": 10,\n \"contractor_count\": 2\n },\n \"setup_due\": \"2024-09-13T14:20:13Z\",\n \"phases\": [\n {\n \"name\": \"preliminary_review\",\n \"completed_at\": null\n },\n {\n \"name\": \"team_setup\",\n \"completed_at\": null\n },\n {\n \"name\": \"final_steps\",\n \"completed_at\": null\n }\n ]\n },\n {\n \"id\": \"ese_BJQyDV3FqOsSyvxpQrvI\",\n \"company\": \"com_F9GiqkhM7QGt2SyxIunm\",\n \"submitted_at\": \"2024-08-28T12:53:49.978168Z\",\n \"completed_at\": null,\n \"closed_at\": null,\n \"created_at\": \"2024-08-28T12:53:49.972954Z\",\n \"profile\": {\n \"previous_payroll_provider\": \"quickbooks_online\",\n \"first_payroll\": null,\n \"first_payroll_of_year\": null,\n \"employee_count\": 10,\n \"contractor_count\": 2\n },\n \"setup_due\": \"2024-09-09T21:00:00Z\",\n \"phases\": [\n {\n \"name\": \"preliminary_review\",\n \"completed_at\": \"2024-09-03T18:37:56.341758Z\"\n },\n {\n \"name\": \"team_setup\",\n \"completed_at\": \"2024-09-03T18:42:31.899396Z\"\n },\n {\n \"name\": \"final_steps\",\n \"completed_at\": null\n }\n ]\n },\n {\n \"id\": \"ese_5eQdfX3d7rnNtFvgiLSY\",\n \"company\": \"com_QMN7n7Bim4IOJryY70sO\",\n \"submitted_at\": \"2024-08-27T01:15:12.426860Z\",\n \"completed_at\": null,\n \"closed_at\": null,\n \"created_at\": \"2024-08-27T01:15:12.424150Z\",\n \"profile\": {\n \"previous_payroll_provider\": \"quickbooks_online\",\n \"first_payroll\": null,\n \"first_payroll_of_year\": null,\n \"employee_count\": 10,\n \"contractor_count\": 2\n },\n \"setup_due\": \"2024-09-06T21:00:00Z\",\n \"phases\": [\n {\n \"name\": \"preliminary_review\",\n \"completed_at\": \"2024-08-27T01:20:57.928574Z\"\n },\n {\n \"name\": \"team_setup\",\n \"completed_at\": null\n },\n {\n \"name\": \"final_steps\",\n \"completed_at\": null\n }\n ]\n },\n {\n \"id\": \"ese_P7ApXILg1CBhtrDOKB3S\",\n \"company\": \"com_BEM6SCOI2o0woPAZ8plj\",\n \"submitted_at\": \"2024-07-10T22:09:03Z\",\n \"completed_at\": null,\n \"closed_at\": null,\n \"created_at\": \"2024-07-10T22:09:03.223581Z\",\n \"profile\": {\n \"previous_payroll_provider\": \"quickbooks_online\",\n \"first_payroll\": null,\n \"first_payroll_of_year\": null,\n \"employee_count\": 10,\n \"contractor_count\": 2\n },\n \"setup_due\": \"2024-07-09T21:00:00Z\",\n \"phases\": [\n {\n \"name\": \"preliminary_review\",\n \"completed_at\": \"2024-08-26T21:39:03.127737Z\"\n },\n {\n \"name\": \"team_setup\",\n \"completed_at\": \"2024-08-27T00:55:05Z\"\n },\n {\n \"name\": \"final_steps\",\n \"completed_at\": null\n }\n ]\n },\n {\n \"id\": \"ese_buBUXQPxXNd4lXKeatpy\",\n \"company\": \"com_hQV92Fibbg0t7DkVU6FN\",\n \"submitted_at\": null,\n \"completed_at\": null,\n \"closed_at\": null,\n \"created_at\": \"2024-07-03T23:54:53.186826Z\",\n \"profile\": {\n \"previous_payroll_provider\": null,\n \"first_payroll\": null,\n \"first_payroll_of_year\": null,\n \"employee_count\": null,\n \"contractor_count\": null\n },\n \"setup_due\": null,\n \"phases\": []\n },\n {\n \"id\": \"ese_2qH3hz0gBJ6sgSEl3pY6\",\n \"company\": \"com_wfI2TSC5eRv1X2IXqEWD\",\n \"submitted_at\": \"2024-06-21T19:20:49.515198Z\",\n \"completed_at\": null,\n \"closed_at\": null,\n \"created_at\": \"2024-06-21T19:20:49.511307Z\",\n \"profile\": {\n \"previous_payroll_provider\": \"quickbooks_online\",\n \"first_payroll\": null,\n \"first_payroll_of_year\": null,\n \"employee_count\": 10,\n \"contractor_count\": 2\n },\n \"setup_due\": \"2024-07-02T21:00:00Z\",\n \"phases\": [\n {\n \"name\": \"preliminary_review\",\n \"completed_at\": \"2024-06-21T19:27:11.822369Z\"\n },\n {\n \"name\": \"team_setup\",\n \"completed_at\": \"2024-06-21T19:27:50.044903Z\"\n },\n {\n \"name\": \"final_steps\",\n \"completed_at\": \"2024-06-21T19:28:46.331412Z\"\n }\n ]\n },\n {\n \"id\": \"ese_ev50DoMrXRsz4z17gjTD\",\n \"company\": \"com_ea8cT33B0ouIABkWckxo\",\n \"submitted_at\": \"2024-05-20T15:12:42Z\",\n \"completed_at\": null,\n \"closed_at\": null,\n \"created_at\": \"2024-05-20T15:12:42.625048Z\",\n \"profile\": {\n \"previous_payroll_provider\": \"quickbooks_online\",\n \"first_payroll\": null,\n \"first_payroll_of_year\": null,\n \"employee_count\": 10,\n \"contractor_count\": 2\n },\n \"setup_due\": \"2024-05-30T21:00:00Z\",\n \"phases\": [\n {\n \"name\": \"preliminary_review\",\n \"completed_at\": \"2024-08-27T15:29:09.737546Z\"\n },\n {\n \"name\": \"team_setup\",\n \"completed_at\": \"2024-08-27T15:29:42.261309Z\"\n },\n {\n \"name\": \"final_steps\",\n \"completed_at\": null\n }\n ]\n },\n {\n \"id\": \"ese_jOYjUFO2lFYcAySleGpr\",\n \"company\": \"com_BEM6SCOI2o0woPAZ8plj\",\n \"submitted_at\": \"2024-05-20T13:48:45Z\",\n \"completed_at\": null,\n \"closed_at\": \"2024-07-03T22:13:53Z\",\n \"created_at\": \"2024-05-20T13:48:45.515101Z\",\n \"profile\": {\n \"previous_payroll_provider\": \"quickbooks_online\",\n \"first_payroll\": null,\n \"first_payroll_of_year\": null,\n \"employee_count\": 10,\n \"contractor_count\": 2\n },\n \"setup_due\": null,\n \"phases\": [\n {\n \"name\": \"preliminary_review\",\n \"completed_at\": null\n },\n {\n \"name\": \"team_setup\",\n \"completed_at\": null\n },\n {\n \"name\": \"final_steps\",\n \"completed_at\": null\n }\n ]\n }\n ]\n}" schema: type: object properties: next: {} previous: {} results: type: array items: type: object properties: id: type: string example: ese_NEgjqOcAv7wSgYCfLzI5 company: type: string example: com_KKVEd7FBm3MigJH02s7d submitted_at: type: string example: '2024-09-03T20:04:45Z' completed_at: {} closed_at: {} created_at: type: string example: '2024-09-03T20:04:45.026017Z' profile: type: object properties: previous_payroll_provider: type: string example: quickbooks_online first_payroll: {} first_payroll_of_year: {} employee_count: type: integer example: 10 default: 0 contractor_count: type: integer example: 2 default: 0 setup_due: type: string example: '2024-09-13T14:20:13Z' phases: type: array items: type: object properties: name: type: string example: preliminary_review completed_at: {} '400': description: '400' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} deprecated: false tags: - Setups /setups/{setup}: get: summary: Get a setup description: Returns the setup of the specified ID. operationId: get-a-setup parameters: - name: setup in: path description: Id of the setup to return. schema: type: string required: true responses: '200': description: '200' content: application/json: examples: Result: value: "{\n \"id\": \"ese_NEgjqOcAv7wSgYCfLzI5\",\n \"company\": \"com_KKVEd7FBm3MigJH02s7d\",\n \"created_at\": \"2024-09-03T20:04:45.026017Z\", \n \"submitted_at\": \"2024-09-03T20:04:45.030161Z\",\n \"completed_at\": null,\n \"closed_at\": null,\n \"profile\": {\n \"previous_payroll_provider\": \"quickbooks_online\",\n \"first_payroll\": null,\n \"first_payroll_of_year\": null,\n \"employee_count\": 10,\n \"contractor_count\": 2\n },\n \"setup_due\": null,\n \"phases\": [\n {\n \"name\": \"preliminary_review\",\n \"completed_at\": null\n },\n {\n \"name\": \"team_setup\",\n \"completed_at\": null\n },\n {\n \"name\": \"final_steps\",\n \"completed_at\": null\n }\n ]\n}" schema: type: object properties: id: type: string example: ese_NEgjqOcAv7wSgYCfLzI5 company: type: string example: com_KKVEd7FBm3MigJH02s7d created_at: type: string example: '2024-09-03T20:04:45.026017Z' submitted_at: type: string example: '2024-09-03T20:04:45.030161Z' completed_at: {} closed_at: {} profile: type: object properties: previous_payroll_provider: type: string example: quickbooks_online first_payroll: {} first_payroll_of_year: {} employee_count: type: integer example: 10 default: 0 contractor_count: type: integer example: 2 default: 0 setup_due: {} phases: type: array items: type: object properties: name: type: string example: preliminary_review completed_at: {} '400': description: '400' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} deprecated: false tags: - Setups components: securitySchemes: sec0: type: apiKey in: header name: Authorization x-bearer-format: bearer x-default: YOUR_API_KEY x-readme-fauxas: true x-provenance: method: searched source: https://docs.checkhq.com/reference harvested: '2026-10-14' tool: harvest-readme-openapi.py note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored. assembled_from: - https://docs.checkhq.com/reference/add-filing-blockers.md - https://docs.checkhq.com/reference/approve-a-correction.md - https://docs.checkhq.com/reference/approve-an-external-payroll.md - https://docs.checkhq.com/reference/approve-payroll.md - https://docs.checkhq.com/reference/bulk-get-employee-tax-parameter-settings.md - https://docs.checkhq.com/reference/bulk-get-employee-tax-params.md - https://docs.checkhq.com/reference/bulk-update-employee-tax-parameters.md - https://docs.checkhq.com/reference/cancel-a-payment.md - https://docs.checkhq.com/reference/company-business-details.md - https://docs.checkhq.com/reference/company-checklist-component.md - https://docs.checkhq.com/reference/company-connect-bank-account.md - https://docs.checkhq.com/reference/company-employee-setup.md - https://docs.checkhq.com/reference/company-filing-authorization.md - https://docs.checkhq.com/reference/company-pay-history.md - https://docs.checkhq.com/reference/company-payment-setup.md - https://docs.checkhq.com/reference/company-progress-tracker.md - https://docs.checkhq.com/reference/company-signatory-agreements.md - https://docs.checkhq.com/reference/company-tax-setup.md - https://docs.checkhq.com/reference/company-team-setup.md - https://docs.checkhq.com/reference/company-terms-of-service.md - https://docs.checkhq.com/reference/company-verification-documents.md - https://docs.checkhq.com/reference/contractor-roster.md - https://docs.checkhq.com/reference/create-a-bank-account.md - https://docs.checkhq.com/reference/create-a-company-provided-document.md - https://docs.checkhq.com/reference/create-a-contractor-payment.md - https://docs.checkhq.com/reference/create-a-correction.md - https://docs.checkhq.com/reference/create-a-pay-schedule.md - https://docs.checkhq.com/reference/create-a-payroll-item.md - https://docs.checkhq.com/reference/create-a-post-tax-deduction.md - https://docs.checkhq.com/reference/create-a-report-run.md - https://docs.checkhq.com/reference/create-a-workplace.md - https://docs.checkhq.com/reference/create-an-earning-code.md - https://docs.checkhq.com/reference/create-an-earning-rate.md - https://docs.checkhq.com/reference/create-an-external-payroll.md - https://docs.checkhq.com/reference/create-company-tax-elections.md - https://docs.checkhq.com/reference/create-net-pay-split.md - https://docs.checkhq.com/reference/create-payroll.md - https://docs.checkhq.com/reference/create-the-enrollment-profile.md - https://docs.checkhq.com/reference/credit-limits.md - https://docs.checkhq.com/reference/delete-a-bank-account.md - https://docs.checkhq.com/reference/delete-a-company-benefit.md - https://docs.checkhq.com/reference/delete-a-contractor-payment.md - https://docs.checkhq.com/reference/delete-a-correction.md - https://docs.checkhq.com/reference/delete-a-pay-schedule.md - https://docs.checkhq.com/reference/delete-a-payroll-copy-1.md - https://docs.checkhq.com/reference/delete-a-payroll-item-1.md - https://docs.checkhq.com/reference/delete-a-payroll-item.md - https://docs.checkhq.com/reference/delete-a-payroll.md - https://docs.checkhq.com/reference/delete-a-post-tax-deduction.md - https://docs.checkhq.com/reference/delete-a-webhook-config.md - https://docs.checkhq.com/reference/delete-an-employee-benefit.md - https://docs.checkhq.com/reference/download-a-report-run.md - https://docs.checkhq.com/reference/download-a-setup-document.md - https://docs.checkhq.com/reference/download-a-tax-package.md - https://docs.checkhq.com/reference/employee-roster.md - https://docs.checkhq.com/reference/employee-tax-setup.md - https://docs.checkhq.com/reference/employee-tax-statements-1.md - https://docs.checkhq.com/reference/employee-withholdings-setup.md - https://docs.checkhq.com/reference/filing-preview-component.md - https://docs.checkhq.com/reference/full-service-setup-submission.md - https://docs.checkhq.com/reference/generate-contractor-onboard-link.md - https://docs.checkhq.com/reference/generate-onboard-link.md - https://docs.checkhq.com/reference/get-a-communication.md - https://docs.checkhq.com/reference/get-a-company-filing.md - https://docs.checkhq.com/reference/get-a-contractor-pay-statement.md - https://docs.checkhq.com/reference/get-a-contractor-payment.md - https://docs.checkhq.com/reference/get-a-correction-receipt-download.md - https://docs.checkhq.com/reference/get-a-correction-receipt.md - https://docs.checkhq.com/reference/get-a-correction.md - https://docs.checkhq.com/reference/get-a-form.md - https://docs.checkhq.com/reference/get-a-fulfillment-receipt-2.md - https://docs.checkhq.com/reference/get-a-fulfillment.md - https://docs.checkhq.com/reference/get-a-log.md - https://docs.checkhq.com/reference/get-a-notification.md - https://docs.checkhq.com/reference/get-a-paper-check-2.md - https://docs.checkhq.com/reference/get-a-paper-check.md - https://docs.checkhq.com/reference/get-a-pay-schedule.md - https://docs.checkhq.com/reference/get-a-report-run.md - https://docs.checkhq.com/reference/get-a-setup-document.md - https://docs.checkhq.com/reference/get-a-setup.md - https://docs.checkhq.com/reference/get-a-tax-package.md - https://docs.checkhq.com/reference/get-a-tax.md - https://docs.checkhq.com/reference/get-a-webhook-delivery.md - https://docs.checkhq.com/reference/get-an-agency.md - https://docs.checkhq.com/reference/get-an-earning-code.md - https://docs.checkhq.com/reference/get-an-earning-rate.md - https://docs.checkhq.com/reference/get-an-employees-paystubs.md - https://docs.checkhq.com/reference/get-an-external-payroll.md - https://docs.checkhq.com/reference/get-an-integration-partner-copy.md - https://docs.checkhq.com/reference/get-child-support-payments-report.md - https://docs.checkhq.com/reference/get-company-paydays.md - https://docs.checkhq.com/reference/get-paper-checks-report.md - https://docs.checkhq.com/reference/get-paper-checks.md - https://docs.checkhq.com/reference/get-paydays.md - https://docs.checkhq.com/reference/get-payroll-journal.md - https://docs.checkhq.com/reference/get-payroll.md - https://docs.checkhq.com/reference/integration-partners-copy.md - https://docs.checkhq.com/reference/integration-partners.md - https://docs.checkhq.com/reference/list-a-webhook-config.md - https://docs.checkhq.com/reference/list-active-funding-strikes.md - https://docs.checkhq.com/reference/list-agencies.md - https://docs.checkhq.com/reference/list-bank-accounts.md - https://docs.checkhq.com/reference/list-benefits.md - https://docs.checkhq.com/reference/list-communications.md - https://docs.checkhq.com/reference/list-companies.md - https://docs.checkhq.com/reference/list-company-authorization-documents.md - https://docs.checkhq.com/reference/list-company-benefits.md - https://docs.checkhq.com/reference/list-company-filings.md - https://docs.checkhq.com/reference/list-company-tax-documents.md - https://docs.checkhq.com/reference/list-company-tax-elections.md - https://docs.checkhq.com/reference/list-company-tax-parameter-settings.md - https://docs.checkhq.com/reference/list-company-tax-parameters.md - https://docs.checkhq.com/reference/list-contractor-forms.md - https://docs.checkhq.com/reference/list-contractor-payments.md - https://docs.checkhq.com/reference/list-contractor-tax-documents.md - https://docs.checkhq.com/reference/list-contractors.md - https://docs.checkhq.com/reference/list-corrections.md - https://docs.checkhq.com/reference/list-earning-codes.md - https://docs.checkhq.com/reference/list-earning-rates.md - https://docs.checkhq.com/reference/list-employee-tax-documents.md - https://docs.checkhq.com/reference/list-employee-tax-elections.md - https://docs.checkhq.com/reference/list-employee-tax-parameter-settings.md - https://docs.checkhq.com/reference/list-employee-tax-statements.md - https://docs.checkhq.com/reference/list-employees-tax-parameters.md - https://docs.checkhq.com/reference/list-employees.md - https://docs.checkhq.com/reference/list-external-payrolls.md - https://docs.checkhq.com/reference/list-forms.md - https://docs.checkhq.com/reference/list-fulfillments.md - https://docs.checkhq.com/reference/list-integration-accesses-1.md - https://docs.checkhq.com/reference/list-integration-permissions-copy.md - https://docs.checkhq.com/reference/list-integration-permissions.md - https://docs.checkhq.com/reference/list-logs.md - https://docs.checkhq.com/reference/list-net-pay-splits.md - https://docs.checkhq.com/reference/list-notifications.md - https://docs.checkhq.com/reference/list-pay-schedules.md - https://docs.checkhq.com/reference/list-payments.md - https://docs.checkhq.com/reference/list-payroll-items.md - https://docs.checkhq.com/reference/list-payrolls.md - https://docs.checkhq.com/reference/list-post-tax-deductions.md - https://docs.checkhq.com/reference/list-report-runs.md - https://docs.checkhq.com/reference/list-setup-documents.md - https://docs.checkhq.com/reference/list-setups.md - https://docs.checkhq.com/reference/list-tax-deposits.md - https://docs.checkhq.com/reference/list-taxes.md - https://docs.checkhq.com/reference/list-usage-records.md - https://docs.checkhq.com/reference/list-usage-summaries.md - https://docs.checkhq.com/reference/list-webhook-deliveries.md - https://docs.checkhq.com/reference/list-workplaces.md - https://docs.checkhq.com/reference/preview-a-correction.md - https://docs.checkhq.com/reference/preview-an-external-payroll.md - https://docs.checkhq.com/reference/preview-payroll.md - https://docs.checkhq.com/reference/previous-payroll-provider-access.md - https://docs.checkhq.com/reference/refund-a-payment.md - https://docs.checkhq.com/reference/remove-filing-blockers.md - https://docs.checkhq.com/reference/reopen-a-correction.md - https://docs.checkhq.com/reference/reopen-a-pending-payroll.md - https://docs.checkhq.com/reference/reopen-payroll.md - https://docs.checkhq.com/reference/request-a-tax-package.md - https://docs.checkhq.com/reference/request-embedded-setup.md - https://docs.checkhq.com/reference/retry-a-payment.md - https://docs.checkhq.com/reference/retry-a-webhook-delivery-in-sandbox.md - https://docs.checkhq.com/reference/reveal-account-number.md - https://docs.checkhq.com/reference/reveal-contractor-ssn.md - https://docs.checkhq.com/reference/reveal-employee-ssn.md - https://docs.checkhq.com/reference/run-payroll.md - https://docs.checkhq.com/reference/sandbox-complete-disbursements.md - https://docs.checkhq.com/reference/sandbox-complete-funding.md - https://docs.checkhq.com/reference/sandbox-correction-complete-funding.md - https://docs.checkhq.com/reference/sandbox-correction-fail-funding.md - https://docs.checkhq.com/reference/sandbox-correction-start-processing.md - https://docs.checkhq.com/reference/sandbox-fail-funding.md - https://docs.checkhq.com/reference/sandbox-start-processing.md - https://docs.checkhq.com/reference/submit-a-contractor-form.md - https://docs.checkhq.com/reference/update-a-bank-account.md - https://docs.checkhq.com/reference/update-a-company.md - https://docs.checkhq.com/reference/update-a-correction.md - https://docs.checkhq.com/reference/update-a-webhook-config.md - https://docs.checkhq.com/reference/update-a-workplace.md - https://docs.checkhq.com/reference/update-an-earning-rate.md - https://docs.checkhq.com/reference/update-an-external-payroll.md - https://docs.checkhq.com/reference/update-company-tax-elections.md - https://docs.checkhq.com/reference/update-employee-tax-elections.md - https://docs.checkhq.com/reference/update-payroll.md - https://docs.checkhq.com/reference/update-the-enrollment-profile.md - https://docs.checkhq.com/reference/validate-address.md - https://docs.checkhq.com/reference/validate-an-external-payroll.md - https://docs.checkhq.com/reference/void-a-payroll.md - https://docs.checkhq.com/reference/workplace-roster.md merge: pages: 188 deduped: 195 conflicts_kept_first: 0