--- title: "Get contractor payment groups for a company" method: GET path: "/v1/companies/{company_id}/contractor_payment_groups" tags: ["Contractor Payment Groups"] --- # Get contractor payment groups for a company `GET /v1/companies/{company_id}/contractor_payment_groups` ## Request - Base URL: `https://api.gusto-demo.com` - URL: `https://api.gusto-demo.com/v1/companies/{company_id}/contractor_payment_groups` - Auth: HTTP bearer - TypeScript: (a function with typed inputs; its response is checked against the schema) Returns a list of minimal contractor payment groups within a given time period, including totals but not associated contractor payments. scope: `payrolls:read` ## Path parameters - `company_id` string, required ## Query parameters - `start_date` string - `end_date` string - `page` integer - `per` integer ## Headers - `X-Gusto-API-Version` '2026-06-15' ## Response `200` List of Contractor Payment Groups - ContractorPaymentGroupWithBlockers[] - `uuid` string: The unique identifier of the contractor payment group. - `company_uuid` string: The UUID of the company. - `check_date` string: The check date of the contractor payment group. - `debit_date` string: The debit date of the contractor payment group. - `status` 'Unfunded' | 'Funded': The status of the contractor payment group. Will be `Funded` if all payments that should be funded (i.e. have `Direct Deposit` for payment method) are funded. A group can have status `Funded` while having associated payments that have status `Unfunded`, i.e. payment with `Check` payment method. - `creation_token` string, nullable: Token used to make contractor payment group creation idempotent. Will error if attempting to create a group with a duplicate token. - `partner_owned_disbursement` boolean, nullable: Whether the disbursement is partner owned. - `submission_blockers` PayrollSubmissionBlockerType[]: List of submission blockers for the contractor payment group. - `blocker_type` string: The type of blocker that's blocking the payment submission. - `blocker_name` string: The name of the submission blocker. - `unblock_options` object[]: The available options to unblock a submission blocker. - `unblock_type` string: The type of unblock option for the submission blocker. - `check_date` string: The payment check date associated with the unblock option. - `metadata` object: Additional data associated with the unblock option. - `selected_option` string, nullable: The unblock option that's been selected to resolve the submission blocker. - `status` 'unresolved' | 'resolved': The status of the submission blocker. - `credit_blockers` PayrollCreditBlockerType[]: List of credit blockers for the contractor payment group. - `blocker_type` string: The type of blocker that's blocking the payment from being credited. - `blocker_name` string: The name of the credit blocker. - `unblock_options` union[]: The available options to unblock a credit blocker. - union - PayrollCreditBlockerUnblockOptionSubmitWire: Unblock option to resolve a credit blocker by submitting a wire transfer - `unblock_type` 'submit_wire', required: The type of unblock option for the credit blocker - `check_date` string, required: The payment check date associated with the unblock option - `metadata` object, required - `wire_in_amount` string, required: The amount to be wired in (decimal string) - `wire_in_deadline` string, date-time, required: Deadline for the wire transfer to be received - `wire_in_request_uuid` string, required: UUID of the wire in request - PayrollCreditBlockerUnblockOptionSubmitBankScreenshot: Unblock option to resolve a credit blocker by submitting a bank screenshot - `unblock_type` 'submit_bank_screenshot', required: The type of unblock option for the credit blocker - `check_date` string, required: The payment check date associated with the unblock option - `metadata` object, required - `information_request_uuid` string, required: UUID of the information request - `bank_account_last_four_digits` string, nullable: Last 4 digits of the bank account number for the bank screenshot RFI - PayrollCreditBlockerUnblockOptionRespondToHighRiskFraudRfi: Unblock option to resolve a credit blocker by responding to high risk fraud RFI - `unblock_type` 'respond_to_high_risk_fraud_rfi', required: The type of unblock option for the credit blocker - `check_date` string, required: The payment check date associated with the unblock option - `metadata` object, required - `information_request_uuid` string, required: UUID of the information request - PayrollCreditBlockerUnblockOptionWaitForReverseWire: Unblock option to resolve a credit blocker by waiting for reverse wire - `unblock_type` 'wait_for_reverse_wire', required: The type of unblock option for the credit blocker - `check_date` string, required: The payment check date associated with the unblock option - `metadata` object, required - `selected_option` string, nullable: The unblock option that's been selected to resolve the credit blocker. - `status` 'unresolved' | 'pending_review' | 'resolved' | 'failed': The status of the credit blocker - `totals` object - `amount` string: The total amount for the group of contractor payments. - `debit_amount` string: The total debit amount for the group of contractor payments. Sum of wage & reimbursement amount. - `wage_amount` string: The total wage amount for the group of contractor payments. - `reimbursement_amount` string: The total reimbursement amount for the group of contractor payments. - `check_amount` string: The total check amount for the group of contractor payments. ## Other responses - `404`: Not Found The requested company does not exist. Make sure the provided UUID is valid. --- [API](https://skmtc.dev/gusto/apis/gusto-api.md) - [All operations](https://skmtc.dev/gusto/apis/gusto-api/llms.txt) - [OpenAPI document](https://skmtc.dev/gusto/apis/gusto-api/revisions/f98575fa2a5e?raw)