Warp HR
App · 25 actions
Manage draft contractors and read workforce, payroll, benefits and time-off data in Warp HR.
Actions
| Action | What it does |
|---|---|
| Create contractor | Create contractor. |
| Delete worker | Delete worker. |
| Get company | Get company. |
| Get health plan | Get health plan. |
| Get pay rate | Get pay rate. |
| Get paycheck | Get paycheck. |
| Get payroll | Get payroll. |
| Get retirement plan | Get retirement plan. |
| Get time off policy | Get time off policy. |
| Get worker | Get worker. |
| List departments | List departments. |
| List health plans | List health plans. |
| List job levels | List job levels. |
| List offers | List offers. |
| List pay rates | List pay rates. |
| List paychecks | List paychecks. |
| List payrolls | List payrolls. |
| List retirement plans | List retirement plans. |
| List time off assignments | List time off assignments. |
| List time off balances | List time off balances. |
| List time off policies | List time off policies. |
| List time off requests | List time off requests. |
| List workers | List workers. |
| List workplaces | List workplaces. |
| Update worker | Update worker. |
Create contractor
Create contractor. Create Contractor
Inputs
- Entity type
entity_typetextRequired - Whether the contractor is an individual person or a business entity.One of:
individual,business. - First name
first_nametextRequired - First name.
- Last name
last_nametextRequired - Last name.
- Position
positiontextRequired - The contractor's role or job title.
- Business name
business_nametext - Required when entityType is "business". The legal name of the contractor's business.
- Scope of work
scope_of_worktext - A description of the work the contractor will perform.
- Start date
start_datedateRequired - Start date.
- Email
emailtextRequired - Personal email address. The invite will be sent here.
- Work email
work_emailtext - Company-issued email address, if applicable.
- Department
department_idtextRequired - The department to assign this contractor to.
- Level
level_idtext - The job level to assign this contractor to, or null to leave unassigned. Omit this field when job levels are not enabled.
- Manager
manager_idtextRequired - The worker id of this contractor's direct manager.
- Work country
work_countrytextRequired - Work country.One of:
AD(Andorra),AE(United Arab Emirates),AF(Afghanistan),AG(Antigua & Barbuda),AI(Anguilla),AL(Albania),AM(Armenia),AO(Angola),AQ(Antarctica),AR(Argentina), and 240 more. - Pay schedule
pay_scheduletext - The contractor's pay schedule. Must be a pay schedule that the company has configured.One of:
weekly,biweekly,monthly,semimonthly,quarterly,annually. - Compensation currency
compensation_currencytext - Compensation currency. Provide currency, amount and pay period together, or leave all three empty.One of:
USD,AUD,BGN,BRL,CAD,CHF,CZK,DKK,EUR,GBP, and 51 more. - Compensation amount
compensation_amountnumber - Compensation amount. Provide currency, amount and pay period together, or leave all three empty.
- Compensation pay period
compensation_pertext - Compensation pay period. Provide currency, amount and pay period together, or leave all three empty.One of:
year,month,week,hour.
Outputs
dataobject- A worker profile, including lifecycle, workplace, profile, and compensation fields.
Example output
{
"data": {
"address": {
"city": "example",
"country": "AD",
"line1": "example",
"line2": "example",
"postalCode": "example",
"state": "example"
},
"benefitEligible": false,
"biologicalSex": "male",
"businessName": "example",
"compensation": {
"amount": 1,
"currency": "USD",
"display": "example",
"payRateId": "example",
"per": "year"
},
"customFields": [],
"dateOfBirth": "example",
"department": {
"id": "example",
"name": "example"
},
"displayName": "example",
"email": "example",
"endDate": "example",
"firstName": "example",
"id": "example",
"isBusiness": false,
"lastName": "example",
"latestRehireDate": "example",
"level": {
"code": "example",
"id": "example",
"name": "example",
"track": "ic"
},
"manager": {
"displayName": "example",
"firstName": "example",
"id": "example",
"lastName": "example"
},
"maritalStatus": "married",
"phone": "example",
"position": "example",
"preferredName": "example",
"primaryWorkplace": {
"id": "example",
"name": "example",
"type": "remote"
},
"startDate": "example",
"status": "draft",
"tShirtSize": "XS",
"terminationReason": "example",
"timeZone": "example",
"type": "employee",
"updatedAt": "example",
"workEmail": "example"
}
}Delete worker
Delete worker. Delete Worker
Inputs
- Worker
idtextRequired - The id of the worker.
Outputs
dataobject- Response.
Example output
{
"data": {}
}Get company
Get company. Get company
Inputs
None.
Outputs
dataobject- Basic identity, contact, address, and incorporation information for your company.
Example output
{
"data": {
"businessAddress": {
"city": "example",
"country": "US",
"line1": "example",
"line2": "example",
"postalCode": "example",
"state": "AL"
},
"businessType": "c_corporation",
"contactEmail": "example",
"description": "example",
"displayName": "example",
"ein": "example",
"id": "example",
"incorporationDate": "example",
"incorporationState": "AL",
"legalName": "example",
"mailingAddress": {
"city": "example",
"country": "US",
"line1": "example",
"line2": "example",
"postalCode": "example",
"state": "AL"
},
"phone": "example",
"website": "example"
}
}Get health plan
Get health plan. Get Health Plan
Inputs
- Health plan ID
idtextRequired - The tag of a company health plan.
Outputs
dataobject- A company health plan available through Warp.
Example output
{
"data": {
"carrier": {
"id": "example",
"name": "example"
},
"createdAt": "example",
"effectiveEndDate": "example",
"effectiveStartDate": "example",
"groupNumber": "example",
"id": "example",
"name": "example",
"networkType": "hmo",
"status": "active",
"type": "medical",
"updatedAt": "example"
}
}Get pay rate
Get pay rate. Get Pay Rate
Inputs
- Pay rate ID
idtextRequired - The tag of the pay rate.
Outputs
dataobject- A regular or additional pay rate assigned to a worker.
Example output
{
"data": {
"amount": 1,
"currency": "USD",
"description": "example",
"display": "example",
"effectiveEndDate": "example",
"effectiveStartDate": "example",
"id": "example",
"per": "year",
"type": "regular",
"worker": {
"firstName": "example",
"id": "example",
"lastName": "example"
}
}
}Get paycheck
Get paycheck. Get Paycheck
Inputs
- Paycheck ID
idtextRequired - The paycheck ID.
Outputs
dataobject- A paycheck with currency-specific calculation lines, totals grouped by currency, and authoritative parent-payroll funding-currency totals. Source currencies for expenses, benefits, or other inputs are outside this payroll-calculation resource.
Example output
{
"data": {
"benefits": [],
"deductions": [],
"description": "example",
"earnings": [],
"exchangeRates": [],
"id": "example",
"payday": "example",
"paymentMethod": "direct_deposit",
"payroll": {
"fundingCurrency": "USD",
"id": "example",
"payFrequency": "weekly",
"payPeriod": {
"endDate": "example",
"startDate": "example"
},
"status": "draft",
"subtype": "regular",
"type": "us"
},
"reimbursements": [],
"reportedHours": 1.0,
"status": "draft",
"taxes": [],
"totals": {
"byCurrency": [],
"inFundingCurrency": {
"currency": "USD",
"employerBenefitContributions": {
"amount": 1,
"display": "example"
},
"employerTaxes": {
"amount": 1,
"display": "example"
},
"grossPay": {
"amount": 1,
"display": "example"
},
"netPay": {
"amount": 1,
"display": "example"
},
"postTaxDeductions": {
"amount": 1,
"display": "example"
},
"preTaxDeductions": {
"amount": 1,
"display": "example"
},
"reimbursements": {
"amount": 1,
"display": "example"
},
"workerBenefitContributions": {
"amount": 1,
"display": "example"
},
"workerTaxes": {
"amount": 1,
"display": "example"
}
}
},
"worker": {
"displayName": "example",
"firstName": "example",
"id": "example",
"lastName": "example",
"workerType": "us_w2"
},
"yearToDate": {
"asOfDate": "example",
"benefits": [],
"deductions": [],
"earnings": [],
"reimbursements": [],
"taxes": [],
"totals": {
"grossPay": {
"amount": 1,
"currency": "USD",
"display": "example"
},
"netPay": {
"amount": 1,
"currency": "USD",
"display": "example"
},
"postTaxDeductions": {
"amount": 1,
"currency": "USD",
"display": "example"
},
"reimbursements": {
"amount": 1,
"currency": "USD",
"display": "example"
},
"workerBenefitContributions": {
"amount": 1,
"currency": "USD",
"display": "example"
},
"workerTaxes": {
"amount": 1,
"currency": "USD",
"display": "example"
}
}
}
}
}Get payroll
Get payroll. Get Payroll
Inputs
- Payroll ID
idtextRequired - The payroll ID.
Outputs
dataobject- A payroll run with funding and lifecycle details. Every amount in totals is expressed in fundingCurrency; line-derived categories are converted and rounded per paycheck before aggregation, while netPay remains provider-authoritative.
Example output
{
"data": {
"approvalDeadline": "example",
"description": "example",
"fundingCurrency": "USD",
"fundingMethod": "ach",
"id": "example",
"payFrequency": "weekly",
"payPeriod": {
"endDate": "example",
"startDate": "example"
},
"paycheckCount": 1,
"payday": "example",
"reopenDeadline": "example",
"status": "draft",
"subtype": "regular",
"timeline": {
"approvedAt": "example"
},
"totals": {
"cashRequirement": {
"amount": 1,
"display": "example"
},
"employerBenefitContributions": {
"amount": 1,
"display": "example"
},
"employerTaxes": {
"amount": 1,
"display": "example"
},
"grossPay": {
"amount": 1,
"display": "example"
},
"netPay": {
"amount": 1,
"display": "example"
},
"postTaxDeductions": {
"amount": 1,
"display": "example"
},
"preTaxDeductions": {
"amount": 1,
"display": "example"
},
"reimbursements": {
"amount": 1,
"display": "example"
},
"totalCost": {
"amount": 1,
"display": "example"
},
"transactionFees": {
"amount": 1,
"display": "example"
},
"workerBenefitContributions": {
"amount": 1,
"display": "example"
},
"workerTaxes": {
"amount": 1,
"display": "example"
}
},
"type": "us"
}
}Get retirement plan
Get retirement plan. Get Retirement Plan
Inputs
- Retirement plan ID
idtextRequired - The tag of a company retirement plan.
Outputs
dataobject- A company retirement plan available through Warp.
Example output
{
"data": {
"createdAt": "example",
"effectiveEndDate": "example",
"effectiveStartDate": "example",
"id": "example",
"name": "example",
"provider": "manual",
"status": "active",
"type": "401k",
"updatedAt": "example"
}
}Get time off policy
Get time off policy. Get Time Off Policy
Inputs
- Time off policy
idtextRequired - Id.
Outputs
dataobject- Response.
Example output
{
"data": {
"description": "example",
"hoursWorkedPerChunk": 1.0,
"id": "example",
"isUnlimited": false,
"minutesPerChunk": 1.0,
"minutesPerPeriod": 1.0,
"name": "example",
"paid": false,
"schedule": "per_hour_worked",
"timeOffTypeId": "example",
"timeOffTypeName": "example",
"unit": "hour"
}
}Get worker
Get worker. Get Worker
Inputs
- Worker
idtextRequired - The id of the worker.
Outputs
dataobject- A worker profile, including lifecycle, workplace, profile, and compensation fields.
Example output
{
"data": {
"address": {
"city": "example",
"country": "AD",
"line1": "example",
"line2": "example",
"postalCode": "example",
"state": "example"
},
"benefitEligible": false,
"biologicalSex": "male",
"businessName": "example",
"compensation": {
"amount": 1,
"currency": "USD",
"display": "example",
"payRateId": "example",
"per": "year"
},
"customFields": [],
"dateOfBirth": "example",
"department": {
"id": "example",
"name": "example"
},
"displayName": "example",
"email": "example",
"endDate": "example",
"firstName": "example",
"id": "example",
"isBusiness": false,
"lastName": "example",
"latestRehireDate": "example",
"level": {
"code": "example",
"id": "example",
"name": "example",
"track": "ic"
},
"manager": {
"displayName": "example",
"firstName": "example",
"id": "example",
"lastName": "example"
},
"maritalStatus": "married",
"phone": "example",
"position": "example",
"preferredName": "example",
"primaryWorkplace": {
"id": "example",
"name": "example",
"type": "remote"
},
"startDate": "example",
"status": "draft",
"tShirtSize": "XS",
"terminationReason": "example",
"timeZone": "example",
"type": "employee",
"updatedAt": "example",
"workEmail": "example"
}
}List departments
List departments. List Departments
Inputs
- Limit
limitnumber - Limit.From 1 to 100. Default:
100. - After ID
after_idtext - The unique public id of the department
- Before ID
before_idtext - The unique public id of the department
Outputs
dataobject- Response.
Example output
{
"data": {
"count": 1,
"data": [],
"hasMore": false
}
}List health plans
List health plans. List Health Plans
Inputs
- Limit
limitnumber - Limit.From 1 to 100. Default:
100. - After ID
after_idtext - The tag of a company health plan.
- Before ID
before_idtext - The tag of a company health plan.
- Types
typeslist - Types.One or more of:
medical,dental,vision,life,short_term_disability(Short term disability),long_term_disability(Long term disability),accident,critical_illness(Critical illness),hospital. - Statuses
statuseslist - Statuses.One or more of:
active,terminated. Default:["active"]. - Carrier IDs
carrier_idslist - Carrier ids.
Outputs
dataobject- Response.
Example output
{
"data": {
"count": 1,
"data": [],
"hasMore": false
}
}List job levels
List job levels. List Job Levels
Inputs
None.
Outputs
datalist- Response.
Example output
{
"data": []
}List offers
List offers. List Offers
Inputs
- Limit
limitnumber - Limit.From 1 to 100. Default:
100. - After ID
after_idtext - The tag of the offer.
- Before ID
before_idtext - The tag of the offer.
- Statuses
statuseslist - Statuses.One or more of:
draft,sent,accepted,void,expired. - Worker types
worker_typeslist - Worker types.One or more of:
employee,us_contractor(Us contractor),global_contractor(Global contractor). - Candidate email
candidate_emailtext - An email with a reasonably valid regex (based on RFC 5321 atext characters)
Outputs
dataobject- Response.
Example output
{
"data": {
"count": 1,
"data": [],
"hasMore": false
}
}List pay rates
List pay rates. List Pay Rates
Inputs
- Limit
limitnumber - Limit.From 1 to 100. Default:
100. - After ID
after_idtext - The tag of the pay rate.
- Before ID
before_idtext - The tag of the pay rate.
- Worker
worker_idtext - Only return pay rates assigned to this worker.
- Effective on or after
effective_on_or_afterdate - Only return pay rates whose effective start date is on or after this date.
- Effective before
effective_beforedate - Only return pay rates whose effective start date is before this date.
- Type
typetext - Only return regular or additional pay rates of this type.One of:
regular,additional.
Outputs
dataobject- Response.
Example output
{
"data": {
"count": 1,
"data": [],
"hasMore": false
}
}List paychecks
List paychecks. List Paychecks
Inputs
- Limit
limitnumber - The maximum number of paychecks to return, from 1 to 50.From 1 to 100. Default:
100. - After ID
after_idtext - Return paychecks after this paycheck ID in the stable cursor order. Cannot be used with beforeId.
- Before ID
before_idtext - Return paychecks before this paycheck ID in the stable cursor order. Cannot be used with afterId.
- Payroll IDs
payroll_idslist - Payrolls whose paychecks should be included.
- Worker IDs
worker_idslist - Workers whose paychecks should be included.
- Worker types
worker_typeslist - Worker classifications in effect for the paycheck to include. Omit to include every worker type visible to the API key.One or more of:
us_w2(Us w2),us_1099(Us 1099),global_contractor(Global contractor),global_employee(Global employee). - Payroll types
payroll_typeslist - Payroll calculation types to include, subject to the API key permissions.One or more of:
us,global. - Statuses
statuseslist - Lifecycle statuses to include. Omit to include every status.One or more of:
draft,pending,processing,debited,credited,partially_paid(Partially paid),processed,failed,voided. - Payment methods
payment_methodslist - Payment methods to include.One or more of:
direct_deposit(Direct deposit),manual. - Compensation currencies
compensation_currencieslist - Paycheck compensation currencies to include.One or more of:
USD,AUD,BGN,BRL,CAD,CHF,CZK,DKK,EUR,GBP, and 52 more. - Pay frequencies
pay_frequencieslist - Pay cadences to include.One or more of:
weekly,biweekly,monthly,semimonthly,quarterly,annually. - Payday on or after
payday_on_or_afterdate - Payday on or after.
- Payday before
payday_beforedate - Payday before.
Outputs
dataobject- A cursor-paginated page of paycheck summaries.
Example output
{
"data": {
"count": 1,
"data": [],
"hasMore": false
}
}List payrolls
List payrolls. List Payrolls
Inputs
- Limit
limitnumber - The maximum number of payrolls to return, from 1 to 50.From 1 to 100. Default:
100. - After ID
after_idtext - Return payrolls after this payroll ID in the stable cursor order. Cannot be used with beforeId.
- Before ID
before_idtext - Return payrolls before this payroll ID in the stable cursor order. Cannot be used with afterId.
- Types
typeslist - Payroll calculation types to include.One or more of:
us,global. - Subtypes
subtypeslist - Payroll subtypes to include.One or more of:
regular,off_cycle(Off cycle),bonus,invoice,contractor,dismissal,reimbursement,manual. - Statuses
statuseslist - Lifecycle statuses to include. Omit to include every status.One or more of:
draft,pending,processing,partially_paid(Partially paid),processed,failed,voided. - Pay frequencies
pay_frequencieslist - Pay cadences to include.One or more of:
weekly,biweekly,monthly,semimonthly,quarterly,annually. - Payday on or after
payday_on_or_afterdate - Payday on or after.
- Payday before
payday_beforedate - Payday before.
- Pay period end on or after
pay_period_end_on_or_afterdate - Pay period end on or after.
- Pay period end before
pay_period_end_beforedate - Pay period end before.
Outputs
dataobject- A cursor-paginated page of payroll summaries.
Example output
{
"data": {
"count": 1,
"data": [],
"hasMore": false
}
}List retirement plans
List retirement plans. List Retirement Plans
Inputs
- Limit
limitnumber - Limit.From 1 to 100. Default:
100. - After ID
after_idtext - The tag of a company retirement plan.
- Before ID
before_idtext - The tag of a company retirement plan.
- Types
typeslist - Types.One or more of:
401k,roth_401k(Roth 401k),403b,roth_403b(Roth 403b),457,roth_457(Roth 457),simple_ira(Simple ira),roth_simple_ira(Roth simple ira). - Statuses
statuseslist - Statuses.One or more of:
active,terminated. Default:["active"].
Outputs
dataobject- Response.
Example output
{
"data": {
"count": 1,
"data": [],
"hasMore": false
}
}List time off assignments
List time off assignments. List Time Off Assignments
Inputs
- Limit
limitnumber - Limit.From 1 to 100. Default:
100. - After ID
after_idtext - The external-facing id of the worker assignment.
- Before ID
before_idtext - The external-facing id of the worker assignment.
- Policy IDs
policy_idslist - Policy ids.
- Worker IDs
worker_idslist - Worker ids.
Outputs
dataobject- Response.
Example output
{
"data": {
"count": 1,
"data": [],
"hasMore": false
}
}List time off balances
List time off balances. List Time Off Balances
Inputs
- Limit
limitnumber - Limit.From 1 to 100. Default:
100. - After ID
after_idtext - The external-facing id of the worker assignment.
- Before ID
before_idtext - The external-facing id of the worker assignment.
- Policy IDs
policy_idslist - Policy ids.
- Worker IDs
worker_idslist - Worker ids.
- Start date
start_datetext - Start date.
- End date
end_datetext - End date.
Outputs
dataobject- Response.
Example output
{
"data": {
"count": 1,
"data": [],
"hasMore": false
}
}List time off policies
List time off policies. List Time Off Policies
Inputs
- Limit
limitnumber - Limit.From 1 to 100. Default:
100. - After ID
after_idtext - After id.
- Before ID
before_idtext - Before id.
Outputs
dataobject- Response.
Example output
{
"data": {
"count": 1,
"data": [],
"hasMore": false
}
}List time off requests
List time off requests. List Time Off Requests
Inputs
- Limit
limitnumber - Limit.From 1 to 100. Default:
100. - After ID
after_idtext - After id.
- Before ID
before_idtext - Before id.
- Statuses
statuseslist - Statuses.One or more of:
pending,approved,denied. - Policy IDs
policy_idslist - Policy ids.
- Worker IDs
worker_idslist - Worker ids.
- Starts on or after
starts_on_or_aftertext - Starts on or after.
- Starts before
starts_beforetext - Starts before.
- Ends on or after
ends_on_or_aftertext - Ends on or after.
- Ends before
ends_beforetext - Ends before.
Outputs
dataobject- Response.
Example output
{
"data": {
"count": 1,
"data": [],
"hasMore": false
}
}List workers
List workers. List Workers
Inputs
- Limit
limitnumber - Limit.From 1 to 100. Default:
100. - After ID
after_idtext - The id of the worker.
- Before ID
before_idtext - The id of the worker.
- Statuses
statuseslist - Statuses.One or more of:
draft,invited,onboarding,active,offboarding,inactive. - Types
typeslist - Types.One or more of:
employee,contractor. - Work email
work_emailtext - Work email.
Outputs
dataobject- Response.
Example output
{
"data": {
"count": 1,
"data": [],
"hasMore": false
}
}List workplaces
List workplaces. List Workplaces
Inputs
- Limit
limitnumber - Limit.From 1 to 100. Default:
100. - After ID
after_idtext - Public workplace identifier
- Before ID
before_idtext - Public workplace identifier
Outputs
dataobject- Response.
Example output
{
"data": {
"count": 1,
"data": [],
"hasMore": false
}
}Update worker
Update worker. Update Worker
Inputs
- Worker
idtextRequired - The id of the worker.
- First name
first_nametext - First name.
- Last name
last_nametext - Last name.
- Preferred name
preferred_nametext - Preferred name.
- T shirt size
t_shirt_sizetext - The worker's T-shirt size. Null clears it; omission leaves it unchanged.One of:
XS,S,M,L,XL,XXL,XXXL. - Work email
work_emailtext - An email with a reasonably valid regex (based on RFC 5321 atext characters)
- Position
positiontext - Position.
- Department
department_idtext - The unique public id of the department
- Manager
manager_idtext - The id of the worker.
- Level
level_idtext - The unique public id of the job level
Outputs
dataobject- A worker profile, including lifecycle, workplace, profile, and compensation fields.
Example output
{
"data": {
"address": {
"city": "example",
"country": "AD",
"line1": "example",
"line2": "example",
"postalCode": "example",
"state": "example"
},
"benefitEligible": false,
"biologicalSex": "male",
"businessName": "example",
"compensation": {
"amount": 1,
"currency": "USD",
"display": "example",
"payRateId": "example",
"per": "year"
},
"customFields": [],
"dateOfBirth": "example",
"department": {
"id": "example",
"name": "example"
},
"displayName": "example",
"email": "example",
"endDate": "example",
"firstName": "example",
"id": "example",
"isBusiness": false,
"lastName": "example",
"latestRehireDate": "example",
"level": {
"code": "example",
"id": "example",
"name": "example",
"track": "ic"
},
"manager": {
"displayName": "example",
"firstName": "example",
"id": "example",
"lastName": "example"
},
"maritalStatus": "married",
"phone": "example",
"position": "example",
"preferredName": "example",
"primaryWorkplace": {
"id": "example",
"name": "example",
"type": "remote"
},
"startDate": "example",
"status": "draft",
"tShirtSize": "XS",
"terminationReason": "example",
"timeZone": "example",
"type": "employee",
"updatedAt": "example",
"workEmail": "example"
}
}