Gusto App Integrations

https://docs.gusto.com/
Admin
API documentation and developer resources for building integrations with Gusto's payroll and HR...
Tokens:990,147
Snippets:7,008
Trust Score:9.5
Update:1 week ago
Show doc for...
Tokens:
Raw
### Example Response for Get a Generated Document

Source: https://docs.gusto.com/embedded-payroll/reference/get-v1-generated_documents-document_type-request_uuid

Example response body showing a successful generation request with status 'succeeded' and a document URL.

```json
{
  "status": "succeeded",
  "document_urls": [
    "https://document.url.com"
  ],
  "request_uuid": "p83d0ca8-7d41-42a9-834y-7d218ef6cb20"
}
```

--------------------------------

### Finish onboarding - check status and finish

Source: https://docs.gusto.com/embedded-payroll/docs/onboard-a-company

Call GET /v1/companies/{company_uuid}/onboarding_status to confirm all steps show completed: true, then call PUT /v1/companies/{company_uuid}/finish_onboarding.

```http
GET /v1/companies/{company_uuid}/onboarding_status
```

```http
PUT /v1/companies/{company_uuid}/finish_onboarding
```

--------------------------------

### Preview paid holidays - sample response

Source: https://docs.gusto.com/embedded-payroll/docs/create-a-holiday-pay-policy

Example JSON response from the GET paid_holidays endpoint, showing a list of holidays with their keys, names, start and end dates.

```JSON
[
    {
        "holiday_key": "new_years_day",
        "holiday_name": "New Year's Day",
        "start_date": "2026-01-01",
        "end_date": "2026-01-01"
    },
    {
        "holiday_key": "veterans_day",
        "holiday_name": "Veterans Day",
        "start_date": "2026-11-11",
        "end_date": "2026-11-11"
    }
]
```

--------------------------------

### 200 Response Example

Source: https://docs.gusto.com/embedded-payroll/reference/get-v1-company-finish-onboarding

Example response body for a successful finish onboarding request. Shows the company UUID, onboarding completion flag, and a list of onboarding steps with their statuses.

```json
{
  "uuid": "c44d66dc-c41b-4a60-9e25-5e93ff8583f2",
  "onboarding_completed": false,
  "onboarding_steps": [
    {
      "title": "Add Your Company's Addresses",
      "id": "add_addresses",
      "required": true,
      "completed": true,
      "completed_at": "2025-02-18T10:00:00Z",
      "skippable": false,
      "requirements": []
    },
    {
      "title": "Enter Your Federal Tax Information",
      "id": "federal_tax_setup",
      "required": true,
      "completed": true,
      "completed_at": "2025-02-18T10:00:00Z",
      "skippable": false,
      "requirements": []
    },
    {
      "title": "Select Industry",
      "id": "select_industry",
      "required": true,
      "completed": true,
      "completed_at": "2025-02-18T10:00:00Z",
      "skippable": false,
      "requirements": []
    },
    {
      "title": "Add Your Bank Account",
      "id": "add_bank_info",
      "required": true,
      "completed": true,
      "completed_at": "2025-02-18T10:00:00Z",
      "skippable": false,
      "requirements": []
    },
    {
      "title": "Add Your Employees",

```

--------------------------------

### GET contribution_exclusions response example

Source: https://docs.gusto.com/embedded-payroll/docs/create-company-benefits

Example JSON response from GET /company_benefits/{company_benefit_id}/contribution_exclusions, showing an array of contribution objects with contribution_uuid, contribution_type, and excluded flags.

```JSON
[
  {  
    "contribution_uuid": "b82e35c5-d7c6-4705-9e16-9f87499ade18",  
    "contribution_type": "Bonus",  
    "excluded": false  
  },  
  {  
    "contribution_uuid": "f5618c94-ed7d-4366-b2c4-ff05e430064f",  
    "contribution_type": "Cash Tips",  
    "excluded": false  
  },  
  {  
    "contribution_uuid": "60191999-004a-49d9-b163-630574433653",  
    "contribution_type": "Commission",  
    "excluded": false  
  },  
  {  
    "contribution_uuid": "75a7a827-1f2d-4d6f-94f2-514c1fc32b13",  
    "contribution_type": "Regular",  
    "excluded": false  
  },  
  {  
    "contribution_uuid": "eead3c7c-7964-4e3c-b609-670456127b09",  
    "contribution_type": "Life insurance imputed benefit",  
    "excluded": true  
  }
]
```

--------------------------------

### Get a Single Wire In Request - Example Response

Source: https://docs.gusto.com/embedded-payroll/docs/payroll-submission-blockers-unblock-options

Example JSON response from the Get a Single Wire In Request endpoint. Contains status, requested_amount, wire_in_deadline, and bank details.

```JSON
[
    {
        "status": "awaiting_funds",
        "uuid": "4cb59feb-fa96-481f-8477-0d0b8c61f4d2",
        "origination_bank": "JP Morgan Chase",
        "origination_bank_address": "1 Chase Plaza, New York, NY 10081",
        "recipient_name": "Gusto, Inc",
        "recipient_address": "525 20th Street, San Francisco, CA 94107",
        "recipient_account_number": "813369829",
        "recipient_routing_number": "322271627",
        "additional_notes": null,
        "bank_name": null,
        "date_sent": null,
        "unique_tracking_code": "1trvxwgpe5bc",
        "payment_type": "Payroll",
        "payment_uuid": "f691942f-d475-42e6-b807-d2c2306217a1",
        "amount_sent": null,
        "requested_amount": "315237.55",
        "wire_in_deadline": "2024-09-24T18:00:00Z"
    }
]
```

--------------------------------

### Get onboarding status - sample response

Source: https://docs.gusto.com/embedded-payroll/docs/onboard-a-contractor-only-company

Sample JSON response from the onboarding_status endpoint showing the onboarding steps for a contractor-only company. The steps include add_addresses, federal_tax_setup, select_industry, add_bank_info, add_contractors, sign_all_forms, and verify_bank_info.

```json
{
    "uuid": "8e75cd53-9427-40a1-9f7c-4542d56d7e6e",
    "onboarding_completed": false,
    "onboarding_steps": [
        {
            "title": "Add Your Company’s Addresses",
            "id": "add_addresses",
            "required": true,
            "completed": true,
            "skippable": false,
            "requirements": []
        },
        {
            "title": "Enter Your Federal Tax Information",
            "id": "federal_tax_setup",
            "required": true,
            "completed": true,
            "skippable": false,
            "requirements": []
        },
        {
            "title": "Select Industry",
            "id": "select_industry",
            "required": true,
            "completed": true,
            "skippable": false,
            "requirements": []
        },
        {
            "title": "Add Your Bank Account",
            "id": "add_bank_info",
            "required": true,
            "completed": true,
            "skippable": false,
            "requirements": []
        },
        {
            "title": "Add Your Contractors",
            "id": "add_contractors",
            "required": false,
            "completed": true,
            "skippable": false,
            "requirements": [
                "add_addresses"
            ]
        },
        {
            "title": "Sign Documents",
            "id": "sign_all_forms",
            "required": true,
            "completed": true,
            "skippable": false,
            "requirements": [
                "federal_tax_setup",
                "add_bank_info"
            ]
        },
        {
            "title": "Verify Your Bank Account",
            "id": "verify_bank_info",
            "required": true,
            "completed": true,
            "skippable": false,
            "requirements": [
                "add_bank_info"
            ]
        }
    ]
}
```

--------------------------------

### GET companies/{company_uuid}/payrolls/blockers - cURL and JavaScript

Source: https://docs.gusto.com/embedded-payroll/docs/payroll-blockers

Examples for retrieving payroll blockers for a company using the GET companies/{company_uuid}/payrolls/blockers endpoint. The cURL example uses the demo base URL and API version 2023-09-01. The JavaScript example uses node-fetch and requires a valid company UUID.

```cURL
curl --request GET \
     --url https://api.gusto-demo.com/v1/companies/{company_uuid}/payrolls/blockers \
     --header 'X-Gusto-API-Version: 2023-09-01' \
     --header 'accept: application/json'
```

```javascript
const fetch = require('node-fetch');

const url = 'https://api.gusto-demo.com/v1/companies/company_uuid/payrolls/blockers';
const options = {method: 'GET', headers: {accept: 'application/json'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));
```

--------------------------------

### 200 Success Response Example

Source: https://docs.gusto.com/embedded-payroll/reference/get-v1-company-onboarding-status

Example 200 response showing a company with onboarding not completed and a list of onboarding steps. Each step includes title, id, required, completed, completed_at, skippable, and requirements fields.

```json
{
  "uuid": "c44d66dc-c41b-4a60-9e25-5e93ff8583f2",
  "onboarding_completed": false,
  "onboarding_steps": [
    {
      "title": "Add Your Company's Addresses",
      "id": "add_addresses",
      "required": true,
      "completed": true,
      "completed_at": "2025-02-18T10:00:00Z",
      "skippable": false,
      "requirements": []
    },
    {
      "title": "Enter Your Federal Tax Information",
      "id": "federal_tax_setup",
      "required": true,
      "completed": true,
      "completed_at": "2025-02-18T10:00:00Z",
      "skippable": false,
      "requirements": []
    },
    {
      "title": "Select Industry",
      "id": "select_industry",
      "required": true,
      "completed": true,
      "completed_at": "2025-02-18T10:00:00Z",
      "skippable": false,
      "requirements": []
    },
    {
      "title": "Add Your Bank Account",
      "id": "add_bank_info",
      "required": true,
      "completed": true,
      "completed_at": "2025-02-18T10:00:00Z",
      "skippable": false,
      "requirements": []
    },
    {
      "title": "Add Your Employees",
      "id": "add_employees",
      "required": true,
      "completed": true,
      "completed_at": "2025-02-18T10:00:00Z",
      "skippable": false,
      "requirements": []
    }
  ]
}
```

--------------------------------

### Generate company onboarding flow with JavaScript

Source: https://docs.gusto.com/embedded-payroll/docs/onboard-a-contractor-only-company

This JavaScript example uses the fetch API to POST to the /v1/companies/{company_uuid}/signatories endpoint, which is part of the onboarding flow. It includes a sample home address, SSN, and personal details. The example uses the node-fetch library and logs the JSON response.

```javascript
const fetch = require('node-fetch');

const url = 'https://api.gusto-demo.com/v1/companies/{company_uuid}/signatories';
const options = {
  method: 'POST',
  headers: {
    accept: 'application/json',
    'content-type': 'application/json',
    authorization: 'Bearer COMPANY_API_TOKEN'
  },
  body: JSON.stringify({
    home_address: {
      street_1: '35 Fantine Street',
      street_2: 'Suite 17',
      city: 'Paris',
      state: 'TX',
      zip: '75460'
    },
    ssn: '254324601',
    first_name: 'Jean',
    last_name: 'Valjean',
    email: 'stringthemiserable@example.com"',
    title: 'Business Man',
    phone: '8002331000',
    birthday: '1983-12-01'
  })
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));
```

--------------------------------

### GET /v1/notifications/{notification_uuid} response example

Source: https://docs.gusto.com/embedded-payroll/changelog/added-fields-to-get-a-notifications-details

Example JSON response from the GET /v1/notifications/{notification_uuid} endpoint, showing the new template_variables and status fields. Use template_variables to build custom messages and status to filter or display notification states.

```json
{
  "uuid": "7b1d0df1-6403-4a06-8768-c1dd7d24d27a",
  "company_uuid": "88f7cca1-dcad-4d20-84db-7fb80303d69f",
  "title": "Action required: Additional information needed to process payroll",
  "message": "If we do not receive this information as soon as possible, your payroll may not be processed on time.",
  "status": "open",
  "category": "information_request",
  "actionable": true,
  "can_block_payroll": true,
  "published_at": "2022-01-01T00:00:00.000Z",
  "due_at": "2022-02-01T00:00:00.000Z",
  "template_variables": {
    "blocked_task": "Payroll"
  },
  "resources": [
    {
      "entity_type": "Employee",
      "entity_uuid": "21b6f9ce-0ac4-4745-8d8a-127f8c0f00f2"
    }
  ]
}
```

--------------------------------

### 200 Response Example for Get Tax Payments

Source: https://docs.gusto.com/embedded-payroll/reference/get-tax-payments

Example 200 response for the Get Tax Payments endpoint. Shows two tax payment objects with fields such as uuid, company_uuid, agency_name, jurisdiction, period_start, period_end, due_date, payment_sent_on, amount, and amount_paid.

```json
{
  "0": {
    "uuid": "44444444-4444-4444-4444-444444444444",
    "company_uuid": "f0e1d2c3-b4a5-6789-0fed-cba987654321",
    "agency_name": "Internal Revenue Service",
    "jurisdiction": "US",
    "period_start": "2026-01-01",
    "period_end": "2026-03-31",
    "due_date": "2026-04-30",
    "payment_sent_on": "2026-04-12",
    "amount": "1325.00",
    "amount_paid": "1325.00"
  },
  "1": {
    "uuid": "66666666-6666-6666-6666-666666666666",
    "company_uuid": "f0e1d2c3-b4a5-6789-0fed-cba987654321",
    "agency_name": "Illinois Department of Revenue",
    "jurisdiction": "IL",
    "period_start": "2026-01-01",
    "period_end": "2026-03-31",
    "due_date": "2026-04-30",
    "payment_sent_on": null,
    "amount": "200.00",
    "amount_paid": "0.00"
  }
}
```

--------------------------------

### 200 Response Example for Contractor Onboarding Status

Source: https://docs.gusto.com/embedded-payroll/reference/get-v1-contractors-contractor_uuid-onboarding_status

Example response body showing the contractor's onboarding status and steps. The onboarding_status is 'admin_onboarding_incomplete' and includes steps like 'Basic details' and 'Sign and acknowledge documents'.

```json
{
  "uuid": "bc57832c-d8bc-43a7-ae99-3a03380ff037",
  "onboarding_status": "admin_onboarding_incomplete",
  "onboarding_steps": [
    {
      "title": "Basic details",
      "id": "basic_details",
      "required": true,
      "completed": false,
      "requirements": []
    },
    {
      "title": "Enter compensation details",
      "id": "compensation_details",
      "required": true,
      "completed": false,
      "requirements": []
    },
    {
      "title": "Add an address",
      "id": "add_address",
      "required": true,
      "completed": false,
      "requirements": []
    },
    {
      "title": "Payment details",
      "id": "payment_details",
      "required": true,
      "completed": false,
      "requirements": []
    },
    {
      "title": "Sign and acknowledge documents",
      "id": "sign_documents",
      "required": false,
      "completed": false,
      "requirements": [
        "basic_details",
        "add_address"
      ]
    }
  ]
}
```

--------------------------------

### Track onboarding status (JSON response)

Source: https://docs.gusto.com/embedded-payroll/docs/employee-self-management

Sample response showing the employee's current onboarding status and a list of onboarding steps with their completion state and requirements.

```JSON
{
  "uuid": "<employee-uuid>",
  "onboarding_status": "self_onboarding_invited",
  "onboarding_steps": [
    {
      "title": "Personal details",
      "id": "personal_details",
      "required": true,
      "completed": false,
      "requirements": []
    },
    {
      "title": "Enter compensation details",
      "id": "compensation_details",
      "required": true,
      "completed": false,
      "requirements": []
    },
    {
      "title": "Add work address",
      "id": "add_work_address",
      "required": true,
      "completed": false,
      "requirements": []
    },
    {
      "title": "Add home address",
      "id": "add_home_address",
      "required": true,
      "completed": false,
      "requirements": []
    },
    {
      "title": "Enter federal tax withholdings",
      "id": "federal_tax_setup",
      "required": true,
      "completed": false,
      "requirements": []
    },
    {
      "title": "Enter state tax information",
      "id": "state_tax_setup",
      "required": true,
      "completed": false,
      "requirements": [
        "add_work_address",
        "add_home_address"
      ]
    },
    {
      "title": "Direct deposit setup",
      "id": "direct_deposit_setup",
      "required": false,
      "completed": false,
      "requirements": []
    },
    {
      "title": "Employee form signing",
      "id": "employee_form_signing",
      "required": true,
      "completed": false,
      "requirements": [
        "federal_tax_setup",
        "state_tax_setup"
      ]
    },
    {
      "title": "File new hire report",
      "id": "file_new_hire_report",
      "required": true,
      "completed": false,
      "requirements": [
        "add_work_address"
      ]
    },
    {
      "title": "Admin review",
      "id": "admin_review",
      "required": true,
      "completed": false,
      "requirements": [
        "personal_details",
        "compensation_details",
        "add_home_address",
        "add_work_address",
        "federal_tax_setup",
        "state_tax_setup"
      ]
    }
  ]
}
```

--------------------------------

### Example Response for Get Contractor Document PDF

Source: https://docs.gusto.com/embedded-payroll/reference/get-v1-contractor-document-pdf

Example 200 response body. Contains the document UUID and the URL to the PDF.

```json
{
  "uuid": "e83b3c20-dc4f-4382-bee3-b478fc42c68b",
  "document_url": "https://app.gusto-demo.com/assets/personal_documents/23/original.pdf?1724367941"
}
```

--------------------------------

### 200 Example Response

Source: https://docs.gusto.com/app-integrations/reference/get-v1-company_benefits-company_benefit_id

Example response for a successful GET request, showing the company benefit details including employee benefits array.

```json
{
  "uuid": "d2cec746-caee-464a-bcaf-00d93f7049c9",
  "version": "98jr3289h3298hr9329gf9egskt3kagri32qqgiqe3872",
  "active": true,
  "description": "Kaiser Permanente",
  "source": "external",
  "partner_name": "XYZ Corp",
  "deletable": true,
  "supports_percentage_amounts": true,
  "responsible_for_employer_taxes": false,
  "responsible_for_employee_w2": false,
  "catch_up_type": "elective",
  "employee_benefits": [
    {
      "employee_uuid": "ae44a0b2-3c89-41e1-91c8-5f8224a779ca",
      "company_benefit_uuid": "d2cec746-caee-464a-bcaf-00d93f7049c9",
      "active": true,
      "deduct_as_percentage": false,
      "employee_deduction": "3",
      "company_contribution": "0",
      "uuid": "9988f241-9aee-4383-bfca-eac79cf58135",
      "contribution": {
        "type": "amount",
        "value": "0"
      }
    }
  ]
}
```

--------------------------------

### Create self-onboarding flow (JSON response)

Source: https://docs.gusto.com/embedded-payroll/docs/employee-self-management

Sample response containing the self-onboarding URL to share with the employee.

```JSON
{
  "url": "https://flows.gusto-demo.com/flows/fN4yJDNiJLtMqfdjTzr6ANLzySpA-ImGrA6CqZ1q8cM"
}
```

--------------------------------

### Example Response for Get Approved Payroll Reversals

Source: https://docs.gusto.com/embedded-payroll/reference/get-v1-companies-company_id-payroll_reversals

Example response body showing a payroll reversal object with fields like `reversed_payroll_uuid`, `reason`, and `reversed_employee_uuids`. The `approved_at` field is null in this example.

```json
{
  "0": {
    "reversed_payroll_uuid": "09505984-8d8c-41a3-adbe-5740322ae8e9",
    "reversal_payroll_uuid": "0424688e-0a2e-4cd0-ac86-42283e788fb3",
    "reason": "Customer Request",
    "approved_at": null,
    "category": "convert_check_ee_requested",
    "reversed_employee_uuids": [
      "5f036964-185e-4c85-bbf2-3873e1203b30"
    ]
  }
}
```

--------------------------------

### Custom onboarding flow with flow_type string

Source: https://docs.gusto.com/embedded-payroll/docs/flows-quickstart

Use a comma-delimited string to specify the flow types for a custom onboarding flow. This example includes add_addresses, add_employees, and sign_all_forms. Note that data dependencies between steps should be considered for the best user experience.

```JSON
{  
	flow_type: "add_addresses,add_employees,sign_all_forms"  
}
```

--------------------------------

### Employee object with onboarding_documents_config (JSON)

Source: https://docs.gusto.com/embedded-payroll/docs/i-9-employment-verification

Example response showing the employee object with the new onboarding_documents_config field, including i9_document set to true.

```JSON
{
    "uuid": "32015fb9-7a3b-4e91-abc6-f4007f9154c0",
    "first_name": "Fitchner",
    "middle_initial": "A",
    "last_name": "Barca",
    "email": "fitchner@julii.com",
    "company_uuid": "23acf457-d2c9-4136-99f0-c5618569616f",
    "manager_uuid": null,
    "version": "a7fb2921b0dc044c2a769e8e8f8da80f",
    "current_employment_status": null,
    "onboarding_status": "self_onboarding_pending_invite",
    "preferred_first_name": null,
    "department_uuid": null,
    "payment_method": "Check",
    "department": null,
    "terminated": false,
    "two_percent_shareholder": null,
    "onboarded": false,
    "historical": false,
    "has_ssn": true,
    "onboarding_documents_config": {
        "uuid": "9d7f3c7a-1015-45a8-92a2-8872975023e4",
        "i9_document": true
    }
```

--------------------------------

### 200 Response Example for Get Webhook Subscription

Source: https://docs.gusto.com/embedded-payroll/reference/get-v1-webhook-subscription-uuid

Example response body showing a verified webhook subscription with its UUID, URL, and subscription types.

```json
{
  "uuid": "c5fdae57-5483-4529-9aae-f0edceed92d4",
  "url": "https://partner-app.com/subscriber",
  "status": "verified",
  "subscription_types": [
    "BankAccount",
    "Company",
    "CompanyBenefit",
    "Contractor",
    "ContractorPayment",
    "Employee",
    "EmployeeBenefit",
    "EmployeeJobCompensation",
    "ExternalPayroll",
    "Form",
    "Location",
    "Notification",
    "Payroll",
    "PayrollSync",
    "PaySchedule",
    "Signatory"
  ]
}
```

--------------------------------

### Simulate approval in demo environment

Source: https://docs.gusto.com/embedded-payroll/docs/onboard-a-company

Use PUT /v1/companies/{company_uuid}/approve to simulate approval instantly in the demo environment.

```http
PUT /v1/companies/{company_uuid}/approve
```

--------------------------------

### 200 response example for get report

Source: https://docs.gusto.com/app-integrations/reference/get-reports-request_uuid

Example response for a successful report request. The status is 'succeeded' and the report URL is provided in the report_urls array.

```json
{
  "status": "succeeded",
  "report_urls": [
    "https://report.url.com"
  ],
  "request_uuid": "p83d0ca8-7d41-42a9-834y-7d218ef6cb20"
}
```

--------------------------------

### Example response for GET /v1/company/onboarding_status

Source: https://docs.gusto.com/embedded-payroll/changelog/added-completed_at-field-to-company-onboarding-status-endpoint

Shows the JSON response structure with the new completed_at field in each onboarding step. The field is null for incomplete steps.

```json
{
  "uuid": "c44d66dc-c41b-4a60-9e25-5e93ff8583f2",
  "onboarding_completed": false,
  "onboarding_steps": [
    {
      "title": "Add Your Company's Addresses",
      "id": "add_addresses",
      "required": true,
      "completed": true,
      "skippable": false,
      "completed_at": "2025-07-10T11:54:00.00Z", // New "completed_at" field
      "requirements": []
    },
   [...]
  ]
}
```

--------------------------------

### Get a specific form - Sample response

Source: https://docs.gusto.com/embedded-payroll/docs/contractor-forms-guide

Example JSON response from the GET /v1/contractors/{contractor_uuid}/forms/{form_id} endpoint, showing a single form object.

```JSON
{
  "uuid": "48cdd5ec-a4dd-4840-a424-ad79f38d8408",
  "name": "US_1099",
  "title": "Form 1099: 2020",
  "description": "Form 1099 records your annual income as a contractor.",
  "draft": false,
  "requires_signing": false,
  "year": 2020,
  "quarter": null,
  "contractor_uuid": "123dd616-6dbc-4724-938a-403f6217a933"
}
```

--------------------------------

### Sample response for onboarding_status PUT

Source: https://docs.gusto.com/embedded-payroll/docs/onboard-a-w2-employee

Sample response from the PUT onboarding_status request, showing the employee's UUID, the updated onboarding_status, and the onboarding steps with their completion status.

```json
{
  "uuid": "EMPLOYEE_UUID",
  "onboarding_status": "onboarding_completed",
  "onboarding_steps": [
    {
      "title": "Personal details",
      "id": "personal_details",
      "required": true,
      "completed": true,
      "requirements": []
    },
    {
      "title": "Enter compensation details",
      "id": "compensation_details",
      "required": true,
      "completed": true,
      "requirements": []
    }
  ]
}

```

--------------------------------

### Sample JSON response for contractor creation

Source: https://docs.gusto.com/embedded-payroll/docs/onboard-a-contractor

Example response from the POST contractors endpoint. Shows the created contractor object with fields like uuid, onboarding_status 'self_onboarding_started', and hourly_rate '40.00'.

```json
{
  "uuid": "cd84ccd5-3acb-4783-a8fa-722a135d76e2",
  "company_uuid": "<company-uuid>",
  "wage_type": "Fixed",
  "version": "5c6dfbf5cae5ba55fe06034a903cd8e0",
  "type": "Individual",
  "first_name": "Jenna",
  "last_name": "Hunterson",
  "middle_initial": null,
  "business_name": null,
  "ein": null,
  "has_ein": false,
  "email": "happinesspie@example.com",
  "department_uuid": null,
  "dismissal_date": null,
  "department_title": null,
  "start_date": "2022-03-14",
  "is_active": false,
  "address": null,
  "file_new_hire_report": false,
  "work_state": "GA",
  "onboarded": false,
  "onboarding_status": "self_onboarding_started",
  "payment_method": null,
  "has_ssn": false,
  "hourly_rate": "40.00"
}
```

--------------------------------

### Get a contractor's forms - Sample response

Source: https://docs.gusto.com/embedded-payroll/docs/contractor-forms-guide

Example JSON response from the GET /v1/contractors/{contractor_uuid}/forms endpoint, showing an array of form objects.

```JSON
[
  {
    "uuid": "48cdd5ec-a4dd-4840-a424-ad79f38d8408",
    "name": "US_1099",
    "title": "Form 1099: 2020",
    "description": "Form 1099 records your annual income as a contractor.",
    "draft": false,
    "requires_signing": false,
    "year": 2020,
    "quarter": null,
    "contractor_uuid": "123dd616-6dbc-4724-938a-403f6217a933"
  }
]
```

--------------------------------

### 200 response - config_with_i9

Source: https://docs.gusto.com/embedded-payroll/reference/put-v1-employees-employee_id-onboarding_documents_config

Example successful response body showing the configuration object with a UUID and the i9_document field set to true.

```json
{
  "uuid": "7b1d0df1-6403-4a06-8768-c1dd7d24d27a",
  "i9_document": true
}
```

--------------------------------

### 200 Response Example for Get a Company Form

Source: https://docs.gusto.com/embedded-payroll/reference/get-v1-company-form

Example response body for a successful request. The form is a Direct Deposit Authorization with requires_signing set to true and document_content_type application/pdf.

```json
{
  "uuid": "48cdd5ec-a4dd-4840-a424-ad79f38d8408",
  "name": "company_direct_deposit",
  "title": "Direct Deposit Authorization",
  "description": "We need you to sign paperwork to authorize us to debit and credit your bank account and file and pay your taxes.",
  "draft": false,
  "year": null,
  "quarter": null,
  "requires_signing": true,
  "document_content_type": "application/pdf"
}
```
Tokens:
Raw