Sign in

v1

latestOpenAPI 3.1.02026-07-243113441.2 MB
Contractor Payment Groups

Get a contractor payment group

Returns a contractor payment group with all associated contractor payments.

scope: payrolls:read

get/v1/contractor_payment_groups/{contractor_payment_group_uuid}

Path parameters

contractor_payment_group_uuidstring required

The UUID of the contractor payment group

Headers

X-Gusto-API-Version'2026-06-15'

Determines the date-based API version associated with your API call. If none is provided, your application's minimum API version is used.

Response

Successful response

uuidstring

The unique identifier of the contractor payment group.

company_uuidstring

The UUID of the company.

check_datestring

The check date of the contractor payment group.

debit_datestring

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_tokenstring nullable

Token used to make contractor payment group creation idempotent. Will error if attempting to create a group with a duplicate token.

partner_owned_disbursementboolean nullable

Whether the disbursement is partner owned.