# Gusto Component ![](/docs/img/components/icons/60/Z3VzdG8=.png) #### Manage payroll, benefits, and human resource within Gusto Component key: **gusto** · [Changelog ↓](#changelog) ## Description[​](#description "Direct link to Description") [Gusto](https://gusto.com) is a company that provides a cloud-based payroll, benefits, and human resource management software for businesses based in the United States. ## Connections[​](#connections "Direct link to Connections") ### OAuth 2.0[​](#gustooauth "Direct link to OAuth 2.0") **key: gustoOauth** To create an OAuth 2.0 app in Gusto, sign up for a Gusto developer account at and create a new Gusto application. Take note of your applications's **Client ID** and **Secret** and enter those values when you add a Gusto connection to your integration. Under **Redirect URI**, add the callback URL, `https://oauth2.prismatic.io/callback`. | Input | Notes | Example | | ------------- | ----------------------------------------- | -------------------------------------- | | Authorize URL | The OAuth 2.0 Authorization URL for Gusto | https\://api.gusto.com/oauth/authorize | | Client ID | Client Identifier of your app for the API | Client ID | | Client Secret | Client Secret of your app for the API | Client Secret | | Scopes | Scopes are not used for Gusto | | | Token URL | The OAuth 2.0 Token URL for Gusto | https\://api.gusto.com/oauth/token | ## Triggers[​](#triggers "Direct link to Triggers") ### Webhook[​](#gustowebhooktrigger "Direct link to Webhook") Receive and validate webhook requests from Gusto for webhooks you configure. | **key: gustoWebhookTrigger** | Input | Notes | Example | | ---------- | ----- | ------- | | Connection | | | A [Gusto](https://gusto.com/) [webhook subscription](https://docs.gusto.com/embedded-payroll/docs/webhooks) can be configured to send event notifications to a flow's webhook URL when resources change in a Gusto account (an "Employee" is created, a "Payroll" is paid, etc.). #### How It Works[​](#how-it-works "Direct link to How It Works") When a webhook subscription is first created, Gusto sends a verification request containing a `verification_token` to the webhook endpoint. This request is routed to the **URL Validation** branch beneath the trigger. The trigger automatically handles the verification by calling the Gusto API to confirm the token, then responds with the token in the response body. All subsequent webhook event notifications are routed to the **Notification** branch. #### Configuration[​](#configuration "Direct link to Configuration") The trigger requires an **OAuth 2.0** connection to authenticate with the Gusto API for webhook verification. To set up a webhook subscription: 1. Deploy the instance so the flow's webhook URL is available. 2. Use the **Create Webhook Subscription** action (or the Gusto API directly) to create a subscription, providing the flow's webhook URL and the desired subscription types. 3. Gusto sends a verification request to the webhook URL, which the trigger handles automatically. 4. Once verified, the subscription becomes active and event notifications begin flowing to the **Notification** branch. #### Event Types[​](#event-types "Direct link to Event Types") Available Subscription Types and Events (21 categories) | Subscription Type | Events | | ------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `BankAccount` | created, updated, deleted | | `Company` | provisioned, deprovisioned, partner\_authorized, migrated, updated, onboarded, approved, needs\_approval, marked\_as\_high\_risk\_business, marked\_as\_marijuana\_business, suspended, unsuspended, payroll\_transfer\_completed | | `CompanyBenefit` | created, updated, deleted | | `Contractor` | created, updated, onboarded, deactivated, reactivated, deleted | | `ContractorPayment` | created, cancelled | | `ContractorPaymentGroup` | created, cancelled | | `Document` | created, updated, signed | | `Employee` | created, updated, onboarded, marked\_for\_self\_onboarding, terminated, rehired, deleted, invited\_to\_partner\_portal | | `EmployeeBenefit` | created, updated, deleted | | `EmployeeJobCompensation` | created, updated, deleted | | `ExternalPayroll` | created, updated, deleted | | `FastAchConfig` | activated, deactivated | | `Form` | created, updated, signed | | `GeneratedDocument` | generated, failed | | `HomeAddress` | created, updated, deleted | | `Location` | created, updated | | `Notifications` | created, resolved | | `Payroll` | created, updated, calculated, submitted, processed, paid, reversed, partially\_reversed, cancelled, processing\_failed | | `PaySchedule` | created, updated | | `Signatory` | created, updated, deleted, marked\_for\_invite | | `WorkAddress` | created, updated, deleted | Refer to the [Gusto Webhook Events documentation](https://docs.gusto.com/embedded-payroll/docs/webhook-events) for the complete and up-to-date list of event types. #### Returned Data[​](#returned-data "Direct link to Returned Data") Example Payload ```json { "uuid": "evt_abc123-def456", "event_type": "payroll.paid", "resource_type": "Company", "entity_type": "Payroll", "entity_uuid": "pay_xyz789", "timestamp": 1705312200, "partner_uuid": "partner_abc123", "company_uuid": "company_def456" } ``` #### Notes[​](#notes "Direct link to Notes") * A single API request may generate multiple webhook events. * Gusto retries delivery up to 16 times over 3 days if the endpoint does not return a 2xx response within 10 seconds. * Gusto computes an HMAC-SHA256 signature of the event payload using the `verification_token` as the secret. The signature is sent in the `X-Gusto-Signature` header and can be used to validate that events originate from Gusto. *** ## Data Sources[​](#data-sources "Direct link to Data Sources") ### Select Company[​](#selectcompany "Direct link to Select Company") A picklist of companies in your Gusto account. | **key: selectCompany** | **type: picklist** | Input | Notes | Example | | ---------- | ----- | ------- | | Connection | | | ### Example Payload for Select Company ```json { "result": [ { "label": "Acme Corporation", "key": "c44d66dc-c41b-4a60-9e25-5e93ff8583f2" } ] } ``` *** ### Select Employee[​](#selectemployee "Direct link to Select Employee") A picklist of employees for the selected company. | **key: selectEmployee** | **type: picklist** | Input | Notes | Example | | ---------- | ------------------------------ | ------------------------------------ | | Company ID | A UUID representing a company. | 00000000-0000-0000-0000-000000000000 | | Connection | | | ### Example Payload for Select Employee ```json { "result": [ { "label": "Nicole Boehm", "key": "9779767c-6044-48e0-bf68-aeb370b9a2e7" } ] } ``` *** ### Select Pay Schedule[​](#selectpayschedule "Direct link to Select Pay Schedule") A picklist of pay schedules for the selected company. | **key: selectPaySchedule** | **type: picklist** | Input | Notes | Example | | ---------- | ------------------------------ | ------------------------------------ | | Company ID | A UUID representing a company. | 00000000-0000-0000-0000-000000000000 | | Connection | | | ### Example Payload for Select Pay Schedule ```json { "result": [ { "label": "Engineering (Twice per month)", "key": "2097fe08-407a-46d7-b35c-a32402a2355e" } ] } ``` *** ## Actions[​](#actions "Direct link to Actions") ### Create Employee[​](#createemployee "Direct link to Create Employee") Create an employee of a company | **key: createEmployee** | Input | Notes | Example | | ---------------------- | -------------------------------------- | ------------------------------------ | | Company ID | A UUID representing a company. | 00000000-0000-0000-0000-000000000000 | | Connection | | | | Date of Birth | The employee's date of birth. | 1990-12-30 | | Email Address | The employee's personal email address. | john.doe\@example.com | | First Name | The employee's first name. | | | Last Name | The employee's last name. | | | Middle Initial | The employee's middle initial. | | | Social Security Number | The employee's social security number. | 123-45-6789 | ### Example Payload for Create Employee ```json { "data": { "data": { "uuid": "9779767c-6044-48e0-bf68-aeb370b9a2e7", "first_name": "Nicole", "middle_initial": "M", "last_name": "Boehm", "email": "kory7757869450111548@barton-hermiston.io", "company_uuid": "c44d66dc-c41b-4a60-9e25-5e93ff8583f2", "manager_uuid": "5e53e257-c8d6-45aa-aa8a-ec99283a3acd", "version": "414dedaca594b77135e0b8d2f398516d", "department": "Stage Hand", "department_uuid": "1802465d-4f68-4865-920c-1307ab095f12", "terminated": false, "two_percent_shareholder": false, "onboarded": true, "jobs": [ { "uuid": "5d5e3ce5-ea8f-4885-90e5-7ebaed03f7c5", "version": "91179081a7309c9fbd31bb3cf7b9893e", "employee_uuid": "a987bce1-6d06-43f8-9978-9db886f479fb", "current_compensation_uuid": "798a962f-0fcf-491e-9b71-cfa6a1db114f", "payment_unit": "Hour", "primary": true, "title": "Client Support Manager", "compensations": [ { "uuid": "94f17a77-cfe5-436a-af94-422bbf8248ff", "version": "233f0096a8015e62d9795fadf1fd300d", "payment_unit": "Hour", "flsa_status": "Nonexempt", "job_uuid": "64711ac0-83ff-4aaf-bec1-db72f5a44e56", "effective_date": "2021-01-20", "rate": "22.00", "adjust_for_minimum_wage": false, "minimum_wages": [] } ], "rate": "22.00", "hire_date": "2020-01-20", "location": { "uuid": "a82843df-3e90-4f4c-93bc-808122f88a46", "street_1": "412 Kiera Stravenue", "street_2": "Suite 391", "city": "San Francisco", "state": "CA", "zip": "94107", "country": "USA", "inactive": false } } ], "eligible_paid_time_off": [ { "name": "Sick Hours", "accrual_unit": "Hour", "accrual_rate": "208.0", "accrual_method": "per_hour_worked", "accrual_period": "Year", "accrual_balance": "71.0", "maximum_accrual_balance": "240.0", "paid_at_termination": false }, { "name": "Vacation Hours", "accrual_unit": "Hour", "accrual_rate": "208.0", "accrual_period": "Year", "accrual_balance": "34.0", "maximum_accrual_balance": "240.0", "paid_at_termination": true } ], "terminations": [], "home_address": { "version": "7776defce07496b82f3f1ed469e48ae5", "employee_uuid": "628d203c-357b-4dd4-9ea1-8468b15dd58b", "street_1": "3772 Reynolds Centers", "street_2": "Suite 461", "city": "San Francisco", "state": "CA", "zip": "94107", "country": "USA", "active": true }, "garnishments": [], "date_of_birth": "1996-05-08", "has_ssn": true, "ssn": "", "phone": "1234567890", "preferred_first_name": "Vanessa", "work_email": "vanessa.boehm@example.com" }, "headers": {} } } ``` *** ### Create Webhook Subscription[​](#createwebhooksubscription "Direct link to Create Webhook Subscription") Creates a Webhook Subscription to receive notifications when entities change for Gusto. | **key: createWebhookSubscription** | Input | Notes | Example | | ------------------ | ---------------------------------------------------------------------------------------- | ----------------------------- | | Connection | | | | Subscription Types | Types of notifications to receive when entities change. Enter as comma-separated values. | type1,type2 | | Webhook URL | The URL for the webhook subscription. | https\://example.com/webhooks | *** ### Delete Webhook Subscription[​](#deletewebhooksubscription "Direct link to Delete Webhook Subscription") Deletes the Webhook Subscription associated with the provided UUID for Gusto. | **key: deleteWebhookSubscription** | Input | Notes | Example | | ------------------------- | ------------------------------ | ------------------------------------ | | Connection | | | | Webhook Subscription UUID | The webhook subscription UUID. | 00000000-0000-0000-0000-000000000000 | *** ### Find Employee by Email[​](#findemployeebyemail "Direct link to Find Employee by Email") Get an employee by personal email address. | **key: findEmployeeByEmail** | Input | Notes | Example | | ------------- | -------------------------------------- | ------------------------------------ | | Company ID | A UUID representing a company. | 00000000-0000-0000-0000-000000000000 | | Connection | | | | Email Address | The employee's personal email address. | john.doe\@example.com | ### Example Payload for Find Employee by Email ```json { "data": { "data": { "uuid": "9779767c-6044-48e0-bf68-aeb370b9a2e7", "first_name": "Nicole", "middle_initial": "M", "last_name": "Boehm", "email": "kory7757869450111548@barton-hermiston.io", "company_uuid": "c44d66dc-c41b-4a60-9e25-5e93ff8583f2", "manager_uuid": "5e53e257-c8d6-45aa-aa8a-ec99283a3acd", "version": "414dedaca594b77135e0b8d2f398516d", "department": "Stage Hand", "department_uuid": "1802465d-4f68-4865-920c-1307ab095f12", "terminated": false, "two_percent_shareholder": false, "onboarded": true, "jobs": [ { "uuid": "5d5e3ce5-ea8f-4885-90e5-7ebaed03f7c5", "version": "91179081a7309c9fbd31bb3cf7b9893e", "employee_uuid": "a987bce1-6d06-43f8-9978-9db886f479fb", "current_compensation_uuid": "798a962f-0fcf-491e-9b71-cfa6a1db114f", "payment_unit": "Hour", "primary": true, "title": "Client Support Manager", "compensations": [ { "uuid": "94f17a77-cfe5-436a-af94-422bbf8248ff", "version": "233f0096a8015e62d9795fadf1fd300d", "payment_unit": "Hour", "flsa_status": "Nonexempt", "job_uuid": "64711ac0-83ff-4aaf-bec1-db72f5a44e56", "effective_date": "2021-01-20", "rate": "22.00", "adjust_for_minimum_wage": false, "minimum_wages": [] } ], "rate": "22.00", "hire_date": "2020-01-20", "location": { "uuid": "a82843df-3e90-4f4c-93bc-808122f88a46", "street_1": "412 Kiera Stravenue", "street_2": "Suite 391", "city": "San Francisco", "state": "CA", "zip": "94107", "country": "USA", "inactive": false } } ], "eligible_paid_time_off": [ { "name": "Sick Hours", "accrual_unit": "Hour", "accrual_rate": "208.0", "accrual_method": "per_hour_worked", "accrual_period": "Year", "accrual_balance": "71.0", "maximum_accrual_balance": "240.0", "paid_at_termination": false }, { "name": "Vacation Hours", "accrual_unit": "Hour", "accrual_rate": "208.0", "accrual_period": "Year", "accrual_balance": "34.0", "maximum_accrual_balance": "240.0", "paid_at_termination": true } ], "terminations": [], "home_address": { "version": "7776defce07496b82f3f1ed469e48ae5", "employee_uuid": "628d203c-357b-4dd4-9ea1-8468b15dd58b", "street_1": "3772 Reynolds Centers", "street_2": "Suite 461", "city": "San Francisco", "state": "CA", "zip": "94107", "country": "USA", "active": true }, "garnishments": [], "date_of_birth": "1996-05-08", "has_ssn": true, "ssn": "", "phone": "1234567890", "preferred_first_name": "Vanessa", "work_email": "vanessa.boehm@example.com" }, "headers": {} } } ``` *** ### Get Company by ID[​](#getcompany "Direct link to Get Company by ID") Get company metadata by ID | **key: getCompany** | Input | Notes | Example | | ---------- | ------------------------------ | ------------------------------------ | | Company ID | A UUID representing a company. | 00000000-0000-0000-0000-000000000000 | | Connection | | | ### Example Payload for Get Company by ID ```json { "data": { "data": { "ein": "00-0000001", "entity_type": "C-Corporation", "tier": "core", "is_suspended": false, "company_status": "Approved", "uuid": "c7a07c73-a703-4462-9343-1b181182b6e0", "name": "Shoppe Studios LLC", "trade_name": "Record Shoppe", "is_partner_managed": false, "locations": [ { "street_1": "412 Kiera Stravenue", "street_2": "Suite 391", "city": "San Francisco", "state": "CA", "zip": "94107", "country": "USA", "active": true }, { "street_1": "644 Fay Vista", "street_2": "Suite 842", "city": "Richmond", "state": "VA", "zip": "23218", "country": "USA", "active": true } ], "compensations": { "hourly": [ { "name": "Overtime", "multiple": 1.5 }, { "name": "Double overtime", "multiple": 2 }, { "name": "Regular", "multiple": 1 }, { "name": "Outstanding vacation", "multiple": 1 }, { "name": "Holiday", "multiple": 1 }, { "name": "Emergency sick - self care", "multiple": 1 }, { "name": "Emergency sick - caring for others", "multiple": 1 }, { "name": "FMLA Public Health Emergency Leave", "multiple": 1 }, { "name": "Regular Hours", "multiple": 1 } ], "fixed": [ { "name": "Bonus" }, { "name": "Commission" }, { "name": "Paycheck Tips" }, { "name": "Cash Tips" }, { "name": "Correction Payment" }, { "name": "Severance" }, { "name": "Minimum Wage Adjustment" }, { "name": "Reimbursement" } ], "paid_time_off": [ { "name": "Vacation Hours" }, { "name": "Sick Hours" }, { "name": "Holiday Hours" } ] }, "primary_signatory": { "first_name": "Alda", "middle_initial": "", "last_name": "Carter", "phone": "1-565-710-7558", "email": "louie.hessel7757869450111547@zemlak.biz", "home_address": { "street_1": "524 Roob Divide", "street_2": "Suite 565", "city": "San Francisco", "state": "CA", "zip": "94107", "country": "USA" } }, "primary_payroll_admin": { "first_name": "Ian", "last_name": "Labadie", "phone": "1-565-710-7559", "email": "louie.hessel7757869450111547@zemlak.biz" } }, "headers": {} } } ``` *** ### Get Employee[​](#getemployee "Direct link to Get Employee") Get an employee by ID | **key: getEmployee** | Input | Notes | Example | | ----------- | ------------------------------- | ------------------------------------ | | Connection | | | | Employee ID | A UUID representing a employee. | 00000000-0000-0000-0000-000000000000 | ### Example Payload for Get Employee ```json { "data": { "data": { "uuid": "9779767c-6044-48e0-bf68-aeb370b9a2e7", "first_name": "Nicole", "middle_initial": "M", "last_name": "Boehm", "email": "kory7757869450111548@barton-hermiston.io", "company_uuid": "c44d66dc-c41b-4a60-9e25-5e93ff8583f2", "manager_uuid": "5e53e257-c8d6-45aa-aa8a-ec99283a3acd", "version": "414dedaca594b77135e0b8d2f398516d", "department": "Stage Hand", "department_uuid": "1802465d-4f68-4865-920c-1307ab095f12", "terminated": false, "two_percent_shareholder": false, "onboarded": true, "jobs": [ { "uuid": "5d5e3ce5-ea8f-4885-90e5-7ebaed03f7c5", "version": "91179081a7309c9fbd31bb3cf7b9893e", "employee_uuid": "a987bce1-6d06-43f8-9978-9db886f479fb", "current_compensation_uuid": "798a962f-0fcf-491e-9b71-cfa6a1db114f", "payment_unit": "Hour", "primary": true, "title": "Client Support Manager", "compensations": [ { "uuid": "94f17a77-cfe5-436a-af94-422bbf8248ff", "version": "233f0096a8015e62d9795fadf1fd300d", "payment_unit": "Hour", "flsa_status": "Nonexempt", "job_uuid": "64711ac0-83ff-4aaf-bec1-db72f5a44e56", "effective_date": "2021-01-20", "rate": "22.00", "adjust_for_minimum_wage": false, "minimum_wages": [] } ], "rate": "22.00", "hire_date": "2020-01-20", "location": { "uuid": "a82843df-3e90-4f4c-93bc-808122f88a46", "street_1": "412 Kiera Stravenue", "street_2": "Suite 391", "city": "San Francisco", "state": "CA", "zip": "94107", "country": "USA", "inactive": false } } ], "eligible_paid_time_off": [ { "name": "Sick Hours", "accrual_unit": "Hour", "accrual_rate": "208.0", "accrual_method": "per_hour_worked", "accrual_period": "Year", "accrual_balance": "71.0", "maximum_accrual_balance": "240.0", "paid_at_termination": false }, { "name": "Vacation Hours", "accrual_unit": "Hour", "accrual_rate": "208.0", "accrual_period": "Year", "accrual_balance": "34.0", "maximum_accrual_balance": "240.0", "paid_at_termination": true } ], "terminations": [], "home_address": { "version": "7776defce07496b82f3f1ed469e48ae5", "employee_uuid": "628d203c-357b-4dd4-9ea1-8468b15dd58b", "street_1": "3772 Reynolds Centers", "street_2": "Suite 461", "city": "San Francisco", "state": "CA", "zip": "94107", "country": "USA", "active": true }, "garnishments": [], "date_of_birth": "1996-05-08", "has_ssn": true, "ssn": "", "phone": "1234567890", "preferred_first_name": "Vanessa", "work_email": "vanessa.boehm@example.com" }, "headers": {} } } ``` *** ### Get Pay Schedule by ID[​](#getpayschedule "Direct link to Get Pay Schedule by ID") Get a pay schedules for a company by pay schedule ID | **key: getPaySchedule** | Input | Notes | Example | | --------------- | ----------------------------------- | ------------------------------------ | | Company ID | A UUID representing a company. | 00000000-0000-0000-0000-000000000000 | | Connection | | | | Pay Schedule ID | A UUID representing a pay schedule. | 00000000-0000-0000-0000-000000000000 | ### Example Payload for Get Pay Schedule by ID ```json { "data": { "data": [ { "uuid": "2097fe08-407a-46d7-b35c-a32402a2355e", "frequency": "Twice per month", "anchor_pay_date": "2020-05-15", "anchor_end_of_pay_period": "2020-05-08", "day_1": 15, "day_2": 31, "name": "Engineering", "auto_pilot": false } ], "headers": {} } } ``` *** ### Get Webhook Events[​](#getwebhookevents "Direct link to Get Webhook Events") Get webhook events based on the partner application's scopes for Gusto. | **key: getWebhookEvents** | Input | Notes | Example | | -------------------------- | ------------------------------------------------------------------------------------------------- | ------- | | Connection | | | | Event Type | A string containing the exact event name or use a wildcard match to filter for a group of events. | | | Page | The page that is requested. When unspecified, will load the first page. | | | Number of Objects per Page | Number of objects per page. When unspecified, will default to 25. | | | Starting After UUID | Serves as a cursor, returns all events occurring after specified UUID (exclusive). | | *** ### Get Webhook Subscription[​](#getwebhooksubscription "Direct link to Get Webhook Subscription") Returns the Webhook Subscription associated with the provided UUID for Gusto. | **key: getWebhookSubscription** | Input | Notes | Example | | ------------------------- | ------------------------------ | ------------------------------------ | | Connection | | | | Webhook Subscription UUID | The webhook subscription UUID. | 00000000-0000-0000-0000-000000000000 | *** ### List Companies[​](#listcompanies "Direct link to List Companies") List all companies that the currently authenticated user is a part of | **key: listCompanies** | Input | Notes | Example | | --------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | ------- | | Connection | | | | Pagination Page | Which page of results to fetch. See [Gusto API documentation](https://docs.gusto.com/app-integrations/docs/pagination) for more information. | | ### Example Payload for List Companies ```json { "data": { "data": [ { "ein": "00-0000001", "entity_type": "C-Corporation", "tier": "core", "is_suspended": false, "company_status": "Approved", "uuid": "c7a07c73-a703-4462-9343-1b181182b6e0", "name": "Shoppe Studios LLC", "trade_name": "Record Shoppe", "is_partner_managed": false, "locations": [ { "street_1": "412 Kiera Stravenue", "street_2": "Suite 391", "city": "San Francisco", "state": "CA", "zip": "94107", "country": "USA", "active": true }, { "street_1": "644 Fay Vista", "street_2": "Suite 842", "city": "Richmond", "state": "VA", "zip": "23218", "country": "USA", "active": true } ], "compensations": { "hourly": [ { "name": "Overtime", "multiple": 1.5 }, { "name": "Double overtime", "multiple": 2 }, { "name": "Regular", "multiple": 1 }, { "name": "Outstanding vacation", "multiple": 1 }, { "name": "Holiday", "multiple": 1 }, { "name": "Emergency sick - self care", "multiple": 1 }, { "name": "Emergency sick - caring for others", "multiple": 1 }, { "name": "FMLA Public Health Emergency Leave", "multiple": 1 }, { "name": "Regular Hours", "multiple": 1 } ], "fixed": [ { "name": "Bonus" }, { "name": "Commission" }, { "name": "Paycheck Tips" }, { "name": "Cash Tips" }, { "name": "Correction Payment" }, { "name": "Severance" }, { "name": "Minimum Wage Adjustment" }, { "name": "Reimbursement" } ], "paid_time_off": [ { "name": "Vacation Hours" }, { "name": "Sick Hours" }, { "name": "Holiday Hours" } ] }, "primary_signatory": { "first_name": "Alda", "middle_initial": "", "last_name": "Carter", "phone": "1-565-710-7558", "email": "louie.hessel7757869450111547@zemlak.biz", "home_address": { "street_1": "524 Roob Divide", "street_2": "Suite 565", "city": "San Francisco", "state": "CA", "zip": "94107", "country": "USA" } }, "primary_payroll_admin": { "first_name": "Ian", "last_name": "Labadie", "phone": "1-565-710-7559", "email": "louie.hessel7757869450111547@zemlak.biz" } } ], "headers": {} } } ``` *** ### List Company Admins[​](#listcompanyadmins "Direct link to List Company Admins") List all admin users at a company | **key: listCompanyAdmins** | Input | Notes | Example | | --------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------ | | Company ID | A UUID representing a company. | 00000000-0000-0000-0000-000000000000 | | Connection | | | | Pagination Page | Which page of results to fetch. See [Gusto API documentation](https://docs.gusto.com/app-integrations/docs/pagination) for more information. | | ### Example Payload for List Company Admins ```json { "data": { "data": [ { "first_name": "Katherine", "last_name": "Johnson", "email": "Katherine@acmecorp.com", "uuid": "987058cc-23ee-46e9-81ef-5cee086cceca" }, { "first_name": "Anita", "last_name": "Borg", "email": "Anita@acmecorp.com", "uuid": "5de11791-98fd-4587-9ed0-d5d804b8e647" } ], "headers": {} } } ``` *** ### List Employees[​](#listemployees "Direct link to List Employees") List employees of a company | **key: listEmployees** | Input | Notes | Example | | --------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------ | | Company ID | A UUID representing a company. | 00000000-0000-0000-0000-000000000000 | | Connection | | | | Pagination Page | Which page of results to fetch. See [Gusto API documentation](https://docs.gusto.com/app-integrations/docs/pagination) for more information. | | ### Example Payload for List Employees ```json { "data": { "data": [ { "uuid": "9779767c-6044-48e0-bf68-aeb370b9a2e7", "first_name": "Nicole", "middle_initial": "M", "last_name": "Boehm", "email": "kory7757869450111548@barton-hermiston.io", "company_uuid": "c44d66dc-c41b-4a60-9e25-5e93ff8583f2", "manager_uuid": "5e53e257-c8d6-45aa-aa8a-ec99283a3acd", "version": "414dedaca594b77135e0b8d2f398516d", "department": "Stage Hand", "department_uuid": "1802465d-4f68-4865-920c-1307ab095f12", "terminated": false, "two_percent_shareholder": false, "onboarded": true, "jobs": [ { "uuid": "5d5e3ce5-ea8f-4885-90e5-7ebaed03f7c5", "version": "91179081a7309c9fbd31bb3cf7b9893e", "employee_uuid": "a987bce1-6d06-43f8-9978-9db886f479fb", "current_compensation_uuid": "798a962f-0fcf-491e-9b71-cfa6a1db114f", "payment_unit": "Hour", "primary": true, "title": "Client Support Manager", "compensations": [ { "uuid": "94f17a77-cfe5-436a-af94-422bbf8248ff", "version": "233f0096a8015e62d9795fadf1fd300d", "payment_unit": "Hour", "flsa_status": "Nonexempt", "job_uuid": "64711ac0-83ff-4aaf-bec1-db72f5a44e56", "effective_date": "2021-01-20", "rate": "22.00", "adjust_for_minimum_wage": false, "minimum_wages": [] } ], "rate": "22.00", "hire_date": "2020-01-20", "location": { "uuid": "a82843df-3e90-4f4c-93bc-808122f88a46", "street_1": "412 Kiera Stravenue", "street_2": "Suite 391", "city": "San Francisco", "state": "CA", "zip": "94107", "country": "USA", "inactive": false } } ], "eligible_paid_time_off": [ { "name": "Sick Hours", "accrual_unit": "Hour", "accrual_rate": "208.0", "accrual_method": "per_hour_worked", "accrual_period": "Year", "accrual_balance": "71.0", "maximum_accrual_balance": "240.0", "paid_at_termination": false }, { "name": "Vacation Hours", "accrual_unit": "Hour", "accrual_rate": "208.0", "accrual_period": "Year", "accrual_balance": "34.0", "maximum_accrual_balance": "240.0", "paid_at_termination": true } ], "terminations": [], "home_address": { "version": "7776defce07496b82f3f1ed469e48ae5", "employee_uuid": "628d203c-357b-4dd4-9ea1-8468b15dd58b", "street_1": "3772 Reynolds Centers", "street_2": "Suite 461", "city": "San Francisco", "state": "CA", "zip": "94107", "country": "USA", "active": true }, "garnishments": [], "date_of_birth": "1996-05-08", "has_ssn": true, "ssn": "", "phone": "1234567890", "preferred_first_name": "Vanessa", "work_email": "vanessa.boehm@example.com" } ], "headers": {} } } ``` *** ### List Pay Schedules[​](#listpayschedules "Direct link to List Pay Schedules") List pay schedules for a company | **key: listPaySchedules** | Input | Notes | Example | | --------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------ | | Company ID | A UUID representing a company. | 00000000-0000-0000-0000-000000000000 | | Connection | | | | Pagination Page | Which page of results to fetch. See [Gusto API documentation](https://docs.gusto.com/app-integrations/docs/pagination) for more information. | | ### Example Payload for List Pay Schedules ```json { "data": { "data": [ { "uuid": "2097fe08-407a-46d7-b35c-a32402a2355e", "frequency": "Twice per month", "anchor_pay_date": "2020-05-15", "anchor_end_of_pay_period": "2020-05-08", "day_1": 15, "day_2": 31, "name": "Engineering", "auto_pilot": false } ], "headers": {} } } ``` *** ### List Webhook Subscriptions[​](#listwebhooksubscriptions "Direct link to List Webhook Subscriptions") Returns all webhook subscriptions associated with the provided Partner API token for Gusto. | **key: listWebhookSubscriptions** | Input | Notes | Example | | ---------- | ----- | ------- | | Connection | | | *** ### Raw Request[​](#rawrequest "Direct link to Raw Request") Send raw HTTP request to Gusto | **key: rawRequest** | Input | Notes | Example | | ----------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------- | | API Version | The API version to use. | 2025-06-15 | | Connection | | | | Data | The HTTP body payload to send to the URL. | {"exampleKey": "Example Data"} | | File Data | File Data to be sent as a multipart form upload. | \[{key: "example.txt", value: "My File Contents"}] | | File Data File Names | File names to apply to the file data inputs. Keys must match the file data keys above. | | | Form Data | The Form Data to be sent as a multipart form upload. | \[{"key": "Example Key", "value": new Buffer("Hello World")}] | | Header | A list of headers to send with the request. | User-Agent: curl/7.64.1 | | Max Retry Count | The maximum number of retries to attempt. Specify 0 for no retries. | 0 | | Method | The HTTP method to use. | | | Query Parameter | A list of query parameters to send with the request. This is the portion at the end of the URL similar to ?key1=value1\&key2=value2. | | | Response Type | The type of data you expect in the response. You can request json, text, or binary data. | json | | Retry On All Errors | If true, retries on all erroneous responses regardless of type. This is helpful when retrying after HTTP 429 or other 3xx or 4xx errors. Otherwise, only retries on HTTP 5xx and network errors. | false | | Retry Delay (ms) | The delay in milliseconds between retries. This is used when 'Use Exponential Backoff' is disabled. | 0 | | Timeout | The maximum time that a client will await a response to its request | 2000 | | URL | Input the path only (/provision), The base URL is already included (https\://api.gusto.com/v1). For example, to connect to https\://api.gusto.com/v1/provision, only /provision is entered in this field. | /provision | | Use Exponential Backoff | Specifies whether to use a pre-defined exponential backoff strategy for retries. When enabled, 'Retry Delay (ms)' is ignored. | false | *** ### Terminate Employee[​](#terminateemployee "Direct link to Terminate Employee") End an employee's employment | **key: terminateEmployee** | Input | Notes | Example | | ------------------------ | ------------------------------------------------------ | ------------------------------------ | | Connection | | | | Employee ID | A UUID representing a employee. | 00000000-0000-0000-0000-000000000000 | | Run Termination Payroll? | Whether to run a termination payroll for the employee. | false | | Termination Date | The date the employee was terminated. | 2020-12-30 | *** ### Update Webhook Subscription[​](#updatewebhooksubscription "Direct link to Update Webhook Subscription") Updates the Webhook Subscription associated with the provided UUID for Gusto. | **key: updateWebhookSubscription** | Input | Notes | Example | | ------------------------- | ---------------------------------------------------------------------------------------- | ------------------------------------ | | Connection | | | | Subscription Types | Types of notifications to receive when entities change. Enter as comma-separated values. | type1,type2 | | Webhook Subscription UUID | The webhook subscription UUID. | 00000000-0000-0000-0000-000000000000 | *** ## Changelog[​](#changelog "Direct link to Changelog") ### 2026-04-07[​](#2026-04-07 "Direct link to 2026-04-07") Added trigger documentation ### 2026-03-31[​](#2026-03-31 "Direct link to 2026-03-31") Various modernizations and documentation updates ### 2026-03-16[​](#2026-03-16 "Direct link to 2026-03-16") Improved input field documentation with formatted URL links for better readability ### 2026-02-26[​](#2026-02-26 "Direct link to 2026-02-26") Added inline data sources for employees and pay schedules to enable dynamic dropdown selection ### 2025-07-16[​](#2025-07-16 "Direct link to 2025-07-16") Removed deprecated API token connection in favor of OAuth 2.0 ### 2025-07-14[​](#2025-07-14 "Direct link to 2025-07-14") Added API version support for compatibility with latest Gusto API