{"openapi":"3.1.0","info":{"title":"Warp API","version":"0.0.1","summary":"Warp Public API - API for accessing your organization's data on Warp."},"paths":{"/v1/benefits/health_plans":{"get":{"tags":["Benefits"],"operationId":"Benefits.listHealthPlans","parameters":[{"name":"limit","in":"query","schema":{"anyOf":[{"type":"string"},{"type":"null"}]},"required":true},{"name":"afterId","in":"query","schema":{"anyOf":[{"type":"string","pattern":"^chpl_","description":"The tag of a company health plan.","examples":["chpl_1234"]},{"type":"null"}]},"required":false},{"name":"beforeId","in":"query","schema":{"anyOf":[{"type":"string","pattern":"^chpl_","description":"The tag of a company health plan.","examples":["chpl_1234"]},{"type":"null"}]},"required":false},{"name":"types","in":"query","schema":{"anyOf":[{"type":"array","items":{"type":"string","enum":["medical","dental","vision","life","short_term_disability","long_term_disability","accident","critical_illness","hospital"]}},{"type":"null"}]},"required":false},{"name":"statuses","in":"query","schema":{"anyOf":[{"type":"array","items":{"$ref":"#/components/schemas/PublicHealthPlanStatus"}},{"type":"null"}]},"required":true},{"name":"carrierIds","in":"query","schema":{"anyOf":[{"type":"array","items":{"type":"string","pattern":"^car_","description":"The tag of a carrier.","examples":["car_1234"]}},{"type":"null"}]},"required":false}],"security":[{"apiKey":[]}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"hasMore":{"type":"boolean"},"count":{"type":"integer"},"data":{"type":"array","items":{"$ref":"#/components/schemas/PublicHealthPlan"}}},"required":["hasMore","count","data"],"additionalProperties":false}}}},"401":{"description":"ApiKeyUnauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKeyUnauthorizedEncoded"}}}},"403":{"description":"MissingRequiredCompanyPermissions | ApiNotEnabled","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/MissingRequiredCompanyPermissionsEncoded"},{"$ref":"#/components/schemas/ApiNotEnabledEncoded"}]}}}},"429":{"description":"RateLimitExceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitExceededEncoded"}}}},"500":{"description":"InternalServerError","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/effect_HttpApiError_InternalServerErrorEncoded"},{"$ref":"#/components/schemas/effect_HttpApiError_InternalServerErrorEncoded"}]}}}}},"description":"List company health plans. Defaults to active plans. A plan whose effectiveEndDate has elapsed is reported and filtered as terminated.","summary":"List Health Plans"}},"/v1/benefits/health_plans/{id}":{"get":{"tags":["Benefits"],"operationId":"Benefits.getHealthPlan","parameters":[{"name":"id","in":"path","schema":{"type":"string","pattern":"^chpl_","description":"The tag of a company health plan.","examples":["chpl_1234"]},"required":true}],"security":[{"apiKey":[]}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicHealthPlan"}}}},"401":{"description":"ApiKeyUnauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKeyUnauthorizedEncoded"}}}},"403":{"description":"MissingRequiredCompanyPermissions | ApiNotEnabled","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/MissingRequiredCompanyPermissionsEncoded"},{"$ref":"#/components/schemas/ApiNotEnabledEncoded"}]}}}},"404":{"description":"The specified health plan could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HealthPlanNotFoundErrorEncoded"}}}},"429":{"description":"RateLimitExceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitExceededEncoded"}}}},"500":{"description":"InternalServerError","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/effect_HttpApiError_InternalServerErrorEncoded"},{"$ref":"#/components/schemas/effect_HttpApiError_InternalServerErrorEncoded"}]}}}}},"description":"Get a publicly visible company health plan by id.","summary":"Get Health Plan"}},"/v1/benefits/retirement_plans":{"get":{"tags":["Benefits"],"operationId":"Benefits.listRetirementPlans","parameters":[{"name":"limit","in":"query","schema":{"anyOf":[{"type":"string"},{"type":"null"}]},"required":true},{"name":"afterId","in":"query","schema":{"anyOf":[{"type":"string","pattern":"^crpl_","description":"The tag of a company retirement plan.","examples":["crpl_1234"]},{"type":"null"}]},"required":false},{"name":"beforeId","in":"query","schema":{"anyOf":[{"type":"string","pattern":"^crpl_","description":"The tag of a company retirement plan.","examples":["crpl_1234"]},{"type":"null"}]},"required":false},{"name":"types","in":"query","schema":{"anyOf":[{"type":"array","items":{"type":"string","enum":["401k","roth_401k","403b","roth_403b","457","roth_457","simple_ira","roth_simple_ira"]}},{"type":"null"}]},"required":false},{"name":"statuses","in":"query","schema":{"anyOf":[{"type":"array","items":{"$ref":"#/components/schemas/PublicRetirementPlanStatus"}},{"type":"null"}]},"required":true}],"security":[{"apiKey":[]}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"hasMore":{"type":"boolean"},"count":{"type":"integer"},"data":{"type":"array","items":{"$ref":"#/components/schemas/PublicRetirementPlan"}}},"required":["hasMore","count","data"],"additionalProperties":false}}}},"401":{"description":"ApiKeyUnauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKeyUnauthorizedEncoded"}}}},"403":{"description":"MissingRequiredCompanyPermissions | ApiNotEnabled","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/MissingRequiredCompanyPermissionsEncoded"},{"$ref":"#/components/schemas/ApiNotEnabledEncoded"}]}}}},"429":{"description":"RateLimitExceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitExceededEncoded"}}}},"500":{"description":"InternalServerError","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/effect_HttpApiError_InternalServerErrorEncoded"},{"$ref":"#/components/schemas/effect_HttpApiError_InternalServerErrorEncoded"}]}}}}},"description":"List company retirement plans. Defaults to active plans. A plan whose effectiveEndDate has elapsed is reported and filtered as terminated.","summary":"List Retirement Plans"},"post":{"tags":["Benefits"],"operationId":"Benefits.createRetirementPlan","parameters":[],"security":[{"apiKey":[]}],"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicRetirementPlan_1"}}}},"400":{"description":"The supplied benefit values are invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidBenefitInputErrorEncoded"}}}},"401":{"description":"ApiKeyUnauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKeyUnauthorizedEncoded"}}}},"403":{"description":"The company benefits configuration does not allow this change. The message explains the restriction. | MissingRequiredCompanyPermissions | ApiNotEnabled","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/BenefitWriteNotAllowedErrorEncoded"},{"$ref":"#/components/schemas/MissingRequiredCompanyPermissionsEncoded"},{"$ref":"#/components/schemas/ApiNotEnabledEncoded"}]}}}},"409":{"description":"The change conflicts with an existing plan or deduction.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BenefitConflictErrorEncoded"}}}},"429":{"description":"RateLimitExceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitExceededEncoded"}}}},"500":{"description":"InternalServerError","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/effect_HttpApiError_InternalServerErrorEncoded"},{"$ref":"#/components/schemas/effect_HttpApiError_InternalServerErrorEncoded"}]}}}}},"description":"Create a retirement plan for a company on the manual retirement channel.","summary":"Create Retirement Plan","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateRetirementPlan"}}},"required":true}}},"/v1/benefits/retirement_plans/{id}":{"get":{"tags":["Benefits"],"operationId":"Benefits.getRetirementPlan","parameters":[{"name":"id","in":"path","schema":{"type":"string","pattern":"^crpl_","description":"The tag of a company retirement plan.","examples":["crpl_1234"]},"required":true}],"security":[{"apiKey":[]}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicRetirementPlan"}}}},"401":{"description":"ApiKeyUnauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKeyUnauthorizedEncoded"}}}},"403":{"description":"MissingRequiredCompanyPermissions | ApiNotEnabled","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/MissingRequiredCompanyPermissionsEncoded"},{"$ref":"#/components/schemas/ApiNotEnabledEncoded"}]}}}},"404":{"description":"The specified retirement plan could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetirementPlanNotFoundErrorEncoded"}}}},"429":{"description":"RateLimitExceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitExceededEncoded"}}}},"500":{"description":"InternalServerError","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/effect_HttpApiError_InternalServerErrorEncoded"},{"$ref":"#/components/schemas/effect_HttpApiError_InternalServerErrorEncoded"}]}}}}},"description":"Get a company retirement plan by id, regardless of status.","summary":"Get Retirement Plan"},"patch":{"tags":["Benefits"],"operationId":"Benefits.updateRetirementPlan","parameters":[{"name":"id","in":"path","schema":{"type":"string","pattern":"^crpl_","description":"The tag of a company retirement plan.","examples":["crpl_1234"]},"required":true}],"security":[{"apiKey":[]}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicRetirementPlan"}}}},"400":{"description":"The supplied benefit values are invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidBenefitInputErrorEncoded"}}}},"401":{"description":"ApiKeyUnauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKeyUnauthorizedEncoded"}}}},"403":{"description":"The company benefits configuration does not allow this change. The message explains the restriction. | MissingRequiredCompanyPermissions | ApiNotEnabled","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/BenefitWriteNotAllowedErrorEncoded"},{"$ref":"#/components/schemas/MissingRequiredCompanyPermissionsEncoded"},{"$ref":"#/components/schemas/ApiNotEnabledEncoded"}]}}}},"404":{"description":"The specified retirement plan could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetirementPlanNotFoundErrorEncoded"}}}},"409":{"description":"The change conflicts with an existing plan or deduction.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BenefitConflictErrorEncoded"}}}},"429":{"description":"RateLimitExceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitExceededEncoded"}}}},"500":{"description":"InternalServerError","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/effect_HttpApiError_InternalServerErrorEncoded"},{"$ref":"#/components/schemas/effect_HttpApiError_InternalServerErrorEncoded"}]}}}}},"description":"Update a retirement plan for a company on the manual retirement channel.","summary":"Update Retirement Plan","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateRetirementPlan"}}},"required":true}}},"/v1/benefits/deductions":{"get":{"tags":["Benefits"],"operationId":"Benefits.listDeductions","parameters":[{"name":"limit","in":"query","schema":{"anyOf":[{"type":"string"},{"type":"null"}]},"required":true},{"name":"afterId","in":"query","schema":{"anyOf":[{"type":"string","pattern":"^pbdg_","description":"The version-group tag of a payroll benefit deduction. Stable across edits.","examples":["pbdg_1234"]},{"type":"null"}]},"required":false},{"name":"beforeId","in":"query","schema":{"anyOf":[{"type":"string","pattern":"^pbdg_","description":"The version-group tag of a payroll benefit deduction. Stable across edits.","examples":["pbdg_1234"]},{"type":"null"}]},"required":false},{"name":"workerIds","in":"query","schema":{"anyOf":[{"type":"array","items":{"type":"string","pattern":"^wrk_","description":"The id of the worker.","examples":["wrk_1234"]}},{"type":"null"}]},"required":false},{"name":"categories","in":"query","schema":{"anyOf":[{"type":"array","items":{"$ref":"#/components/schemas/PublicBenefitDeductionCategory"}},{"type":"null"}]},"required":false},{"name":"types","in":"query","schema":{"anyOf":[{"type":"array","items":{"type":"string","enum":["medical","dental","vision","life","short_term_disability","long_term_disability","401k","roth_401k","403b","roth_403b","457","roth_457","hsa","fsa_medical","fsa_dependent_care","transit","parking","accident","cancer","critical_illness","hospital","medical_other","simple_ira","roth_simple_ira","nqdc","nontaxable_fringe","pucc","voluntary","post_tax","other"]}},{"type":"null"}]},"required":false},{"name":"statuses","in":"query","schema":{"anyOf":[{"type":"array","items":{"$ref":"#/components/schemas/PublicBenefitDeductionStatus"}},{"type":"null"}]},"required":true},{"name":"healthPlanIds","in":"query","schema":{"anyOf":[{"type":"array","items":{"type":"string","pattern":"^chpl_","description":"The tag of a company health plan.","examples":["chpl_1234"]}},{"type":"null"}]},"required":false},{"name":"retirementPlanIds","in":"query","schema":{"anyOf":[{"type":"array","items":{"type":"string","pattern":"^crpl_","description":"The tag of a company retirement plan.","examples":["crpl_1234"]}},{"type":"null"}]},"required":false}],"security":[{"apiKey":[]}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"hasMore":{"type":"boolean"},"count":{"type":"integer"},"data":{"type":"array","items":{"$ref":"#/components/schemas/PublicBenefitDeduction"}}},"required":["hasMore","count","data"],"additionalProperties":false}}}},"401":{"description":"ApiKeyUnauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKeyUnauthorizedEncoded"}}}},"403":{"description":"MissingRequiredCompanyPermissions | ApiNotEnabled","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/MissingRequiredCompanyPermissionsEncoded"},{"$ref":"#/components/schemas/ApiNotEnabledEncoded"}]}}}},"429":{"description":"RateLimitExceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitExceededEncoded"}}}},"500":{"description":"InternalServerError","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/effect_HttpApiError_InternalServerErrorEncoded"},{"$ref":"#/components/schemas/effect_HttpApiError_InternalServerErrorEncoded"}]}}}}},"description":"List current payroll benefit deductions. Defaults to active deductions. A deduction whose effectiveEndDate has elapsed is reported and filtered as terminated.","summary":"List Benefit Deductions"},"post":{"tags":["Benefits"],"operationId":"Benefits.createDeduction","parameters":[],"security":[{"apiKey":[]}],"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicBenefitDeduction_1"}}}},"400":{"description":"The supplied benefit values are invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidBenefitInputErrorEncoded"}}}},"401":{"description":"ApiKeyUnauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKeyUnauthorizedEncoded"}}}},"403":{"description":"The company benefits configuration does not allow this change. The message explains the restriction. | MissingRequiredCompanyPermissions | ApiNotEnabled","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/BenefitWriteNotAllowedErrorEncoded"},{"$ref":"#/components/schemas/MissingRequiredCompanyPermissionsEncoded"},{"$ref":"#/components/schemas/ApiNotEnabledEncoded"}]}}}},"404":{"description":"The specified benefit deduction could not be found. | The specified worker could not be found. | The specified health plan could not be found. | The specified retirement plan could not be found.","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/BenefitDeductionNotFoundErrorEncoded"},{"$ref":"#/components/schemas/WorkerNotFoundErrorEncoded"},{"$ref":"#/components/schemas/HealthPlanNotFoundErrorEncoded"},{"$ref":"#/components/schemas/RetirementPlanNotFoundErrorEncoded"}]}}}},"409":{"description":"The change conflicts with an existing plan or deduction.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BenefitConflictErrorEncoded"}}}},"429":{"description":"RateLimitExceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitExceededEncoded"}}}},"500":{"description":"InternalServerError","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/effect_HttpApiError_InternalServerErrorEncoded"},{"$ref":"#/components/schemas/effect_HttpApiError_InternalServerErrorEncoded"}]}}}}},"description":"Create a benefit deduction for a worker.","summary":"Create Benefit Deduction","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateBenefitDeduction"}}},"required":true}}},"/v1/benefits/deductions/{id}":{"get":{"tags":["Benefits"],"operationId":"Benefits.getDeduction","parameters":[{"name":"id","in":"path","schema":{"type":"string","pattern":"^pbdg_","description":"The version-group tag of a payroll benefit deduction. Stable across edits.","examples":["pbdg_1234"]},"required":true}],"security":[{"apiKey":[]}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicBenefitDeduction"}}}},"401":{"description":"ApiKeyUnauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKeyUnauthorizedEncoded"}}}},"403":{"description":"MissingRequiredCompanyPermissions | ApiNotEnabled","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/MissingRequiredCompanyPermissionsEncoded"},{"$ref":"#/components/schemas/ApiNotEnabledEncoded"}]}}}},"404":{"description":"The specified benefit deduction could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BenefitDeductionNotFoundErrorEncoded"}}}},"429":{"description":"RateLimitExceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitExceededEncoded"}}}},"500":{"description":"InternalServerError","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/effect_HttpApiError_InternalServerErrorEncoded"},{"$ref":"#/components/schemas/effect_HttpApiError_InternalServerErrorEncoded"}]}}}}},"description":"Get the current version of a company benefit deduction by id.","summary":"Get Benefit Deduction"},"patch":{"tags":["Benefits"],"operationId":"Benefits.updateDeduction","parameters":[{"name":"id","in":"path","schema":{"type":"string","pattern":"^pbdg_","description":"The version-group tag of a payroll benefit deduction. Stable across edits.","examples":["pbdg_1234"]},"required":true}],"security":[{"apiKey":[]}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicBenefitDeduction"}}}},"400":{"description":"The supplied benefit values are invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidBenefitInputErrorEncoded"}}}},"401":{"description":"ApiKeyUnauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKeyUnauthorizedEncoded"}}}},"403":{"description":"The company benefits configuration does not allow this change. The message explains the restriction. | MissingRequiredCompanyPermissions | ApiNotEnabled","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/BenefitWriteNotAllowedErrorEncoded"},{"$ref":"#/components/schemas/MissingRequiredCompanyPermissionsEncoded"},{"$ref":"#/components/schemas/ApiNotEnabledEncoded"}]}}}},"404":{"description":"The specified benefit deduction could not be found. | The specified worker could not be found. | The specified health plan could not be found. | The specified retirement plan could not be found.","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/BenefitDeductionNotFoundErrorEncoded"},{"$ref":"#/components/schemas/WorkerNotFoundErrorEncoded"},{"$ref":"#/components/schemas/HealthPlanNotFoundErrorEncoded"},{"$ref":"#/components/schemas/RetirementPlanNotFoundErrorEncoded"}]}}}},"409":{"description":"The change conflicts with an existing plan or deduction.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BenefitConflictErrorEncoded"}}}},"429":{"description":"RateLimitExceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitExceededEncoded"}}}},"500":{"description":"InternalServerError","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/effect_HttpApiError_InternalServerErrorEncoded"},{"$ref":"#/components/schemas/effect_HttpApiError_InternalServerErrorEncoded"}]}}}}},"description":"Update a benefit deduction. The calculation type cannot change.","summary":"Update Benefit Deduction","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateBenefitDeduction"}}},"required":true}}},"/v1/company":{"get":{"tags":["Company"],"operationId":"Company.get","parameters":[],"security":[{"apiKey":[]}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicCompany"}}}},"401":{"description":"ApiKeyUnauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKeyUnauthorizedEncoded"}}}},"403":{"description":"MissingRequiredCompanyPermissions | ApiNotEnabled","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/MissingRequiredCompanyPermissionsEncoded"},{"$ref":"#/components/schemas/ApiNotEnabledEncoded"}]}}}},"404":{"description":"The company associated with the API key could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanyNotFoundErrorEncoded"}}}},"429":{"description":"RateLimitExceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitExceededEncoded"}}}},"500":{"description":"InternalServerError","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/effect_HttpApiError_InternalServerErrorEncoded"},{"$ref":"#/components/schemas/effect_HttpApiError_InternalServerErrorEncoded"}]}}}}},"description":"Get the company associated with your API key, including its unmasked EIN. Requires settings read permission or higher. No parameters are required. The response is the company object directly, and unavailable incorporation dates are null.","summary":"Get company"}},"/v1/custom_fields":{"get":{"tags":["Custom Fields"],"operationId":"Custom Fields.list","parameters":[],"security":[{"apiKey":[]}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","pattern":"^cf_","description":"The tag of a company custom worker field.","examples":["cf_1234"]},"name":{"type":"string"},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"type":{"type":"string","enum":["text","number","date","boolean","currency","percentage","select","multi_select"]},"config":{"type":"object"},"status":{"type":"string","enum":["active","archived"]},"category":{"type":"string","enum":["info","pii","compensation","banking","it","compliance"]},"accessLevel":{"type":"string","enum":["admins","manager","worker"]},"inputBy":{"type":"string","enum":["admin","worker"]},"required":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"canWrite":{"type":"boolean"},"createdAt":{"type":"string"}},"required":["id","name","description","type","config","status","category","accessLevel","inputBy","canWrite","createdAt"],"additionalProperties":false}}}}},"401":{"description":"ApiKeyUnauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKeyUnauthorizedEncoded"}}}},"403":{"description":"MissingRequiredCompanyPermissions | ApiNotEnabled","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/MissingRequiredCompanyPermissionsEncoded"},{"$ref":"#/components/schemas/ApiNotEnabledEncoded"}]}}}},"429":{"description":"RateLimitExceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitExceededEncoded"}}}},"500":{"description":"InternalServerError","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/effect_HttpApiError_InternalServerErrorEncoded"},{"$ref":"#/components/schemas/effect_HttpApiError_InternalServerErrorEncoded"}]}}}}},"description":"List the custom worker field definitions your API key can read. Each field belongs to a worker-data category; fields whose category your key cannot read are omitted unless the key holds workers:custom_fields.","summary":"List Fields"},"post":{"tags":["Custom Fields"],"operationId":"Custom Fields.create","parameters":[],"security":[{"apiKey":[]}],"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","pattern":"^cf_","description":"The tag of a company custom worker field.","examples":["cf_1234"]},"name":{"type":"string"},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"type":{"type":"string","enum":["text","number","date","boolean","currency","percentage","select","multi_select"]},"config":{"type":"object"},"status":{"type":"string","enum":["active","archived"]},"category":{"type":"string","enum":["info","pii","compensation","banking","it","compliance"]},"accessLevel":{"type":"string","enum":["admins","manager","worker"]},"inputBy":{"type":"string","enum":["admin","worker"]},"required":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"canWrite":{"type":"boolean"},"createdAt":{"type":"string"}},"required":["id","name","description","type","config","status","category","accessLevel","inputBy","canWrite","createdAt"],"additionalProperties":false}}}},"400":{"description":"InvalidCustomFieldOperationError","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidCustomFieldOperationErrorEncoded"}}}},"401":{"description":"ApiKeyUnauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKeyUnauthorizedEncoded"}}}},"403":{"description":"MissingRequiredCompanyPermissions | ApiNotEnabled","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/MissingRequiredCompanyPermissionsEncoded"},{"$ref":"#/components/schemas/ApiNotEnabledEncoded"}]}}}},"409":{"description":"CustomFieldAlreadyExistsError | CustomFieldOptionAlreadyExistsError","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/CustomFieldAlreadyExistsErrorEncoded"},{"$ref":"#/components/schemas/CustomFieldOptionAlreadyExistsErrorEncoded"}]}}}},"429":{"description":"RateLimitExceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitExceededEncoded"}}}},"500":{"description":"InternalServerError","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/effect_HttpApiError_InternalServerErrorEncoded"},{"$ref":"#/components/schemas/effect_HttpApiError_InternalServerErrorEncoded"}]}}}}},"description":"Create a custom worker field definition. The field type is immutable after creation. Select and multi_select fields can include their initial options. Access to values derives from the field category; requires the workers:custom_fields permission.","summary":"Create Field","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","pattern":"^\\S[\\s\\S]*\\S$|^\\S$|^$","minLength":1},"description":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"null"}]},{"type":"null"}]},"type":{"type":"string","enum":["text","number","date","boolean","currency","percentage","select","multi_select"]},"config":{"anyOf":[{"type":"object"},{"type":"null"}]},"category":{"type":"string","enum":["info","pii","compensation","banking","it","compliance"]},"accessLevel":{"anyOf":[{"type":"string","enum":["admins","manager","worker"]},{"type":"null"}]},"inputBy":{"anyOf":[{"type":"string","enum":["admin","worker"]},{"type":"null"}]},"required":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"options":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"label":{"type":"string","pattern":"^\\S[\\s\\S]*\\S$|^\\S$|^$","minLength":1},"value":{"type":"string","pattern":"^\\S[\\s\\S]*\\S$|^\\S$|^$","minLength":1},"sortOrder":{"anyOf":[{"anyOf":[{"type":"number"},{"type":"string","enum":["Infinity","-Infinity","NaN"]}]},{"type":"null"}]}},"required":["label","value"],"additionalProperties":false}},{"type":"null"}]}},"required":["name","type","category"],"additionalProperties":false}}},"required":true}}},"/v1/custom_fields/{id}":{"get":{"tags":["Custom Fields"],"operationId":"Custom Fields.get","parameters":[{"name":"id","in":"path","schema":{"type":"string","pattern":"^cf_","description":"The tag of a company custom worker field.","examples":["cf_1234"]},"required":true}],"security":[{"apiKey":[]}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","pattern":"^cf_","description":"The tag of a company custom worker field.","examples":["cf_1234"]},"name":{"type":"string"},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"type":{"type":"string","enum":["text","number","date","boolean","currency","percentage","select","multi_select"]},"config":{"type":"object"},"status":{"type":"string","enum":["active","archived"]},"category":{"type":"string","enum":["info","pii","compensation","banking","it","compliance"]},"accessLevel":{"type":"string","enum":["admins","manager","worker"]},"inputBy":{"type":"string","enum":["admin","worker"]},"required":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"canWrite":{"type":"boolean"},"createdAt":{"type":"string"},"options":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","pattern":"^cfo_","description":"The tag of a company custom worker field option.","examples":["cfo_1234"]},"label":{"type":"string"},"value":{"type":"string"},"sortOrder":{"anyOf":[{"type":"number"},{"type":"string","enum":["Infinity","-Infinity","NaN"]}]},"status":{"type":"string","enum":["active","archived"]},"createdAt":{"type":"string"}},"required":["id","label","value","sortOrder","status","createdAt"],"additionalProperties":false}}},"required":["id","name","description","type","config","status","category","accessLevel","inputBy","canWrite","createdAt","options"],"additionalProperties":false}}}},"401":{"description":"ApiKeyUnauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKeyUnauthorizedEncoded"}}}},"403":{"description":"MissingRequiredCompanyPermissions | ApiNotEnabled","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/MissingRequiredCompanyPermissionsEncoded"},{"$ref":"#/components/schemas/ApiNotEnabledEncoded"}]}}}},"404":{"description":"CustomFieldNotFoundError","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomFieldNotFoundErrorEncoded"}}}},"429":{"description":"RateLimitExceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitExceededEncoded"}}}},"500":{"description":"InternalServerError","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/effect_HttpApiError_InternalServerErrorEncoded"},{"$ref":"#/components/schemas/effect_HttpApiError_InternalServerErrorEncoded"}]}}}}},"description":"Get a custom worker field definition, including its select options. Archived options may appear on existing worker values but cannot be newly selected.","summary":"Get Field"},"patch":{"tags":["Custom Fields"],"operationId":"Custom Fields.update","parameters":[{"name":"id","in":"path","schema":{"type":"string","pattern":"^cf_","description":"The tag of a company custom worker field.","examples":["cf_1234"]},"required":true}],"security":[{"apiKey":[]}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","pattern":"^cf_","description":"The tag of a company custom worker field.","examples":["cf_1234"]},"name":{"type":"string"},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"type":{"type":"string","enum":["text","number","date","boolean","currency","percentage","select","multi_select"]},"config":{"type":"object"},"status":{"type":"string","enum":["active","archived"]},"category":{"type":"string","enum":["info","pii","compensation","banking","it","compliance"]},"accessLevel":{"type":"string","enum":["admins","manager","worker"]},"inputBy":{"type":"string","enum":["admin","worker"]},"required":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"canWrite":{"type":"boolean"},"createdAt":{"type":"string"}},"required":["id","name","description","type","config","status","category","accessLevel","inputBy","canWrite","createdAt"],"additionalProperties":false}}}},"400":{"description":"InvalidCustomFieldOperationError","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidCustomFieldOperationErrorEncoded"}}}},"401":{"description":"ApiKeyUnauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKeyUnauthorizedEncoded"}}}},"403":{"description":"MissingRequiredCompanyPermissions | ApiNotEnabled","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/MissingRequiredCompanyPermissionsEncoded"},{"$ref":"#/components/schemas/ApiNotEnabledEncoded"}]}}}},"404":{"description":"CustomFieldNotFoundError","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomFieldNotFoundErrorEncoded"}}}},"409":{"description":"CustomFieldAlreadyExistsError","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomFieldAlreadyExistsErrorEncoded"}}}},"429":{"description":"RateLimitExceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitExceededEncoded"}}}},"500":{"description":"InternalServerError","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/effect_HttpApiError_InternalServerErrorEncoded"},{"$ref":"#/components/schemas/effect_HttpApiError_InternalServerErrorEncoded"}]}}}}},"description":"Update a custom worker field definition. The field type cannot be changed; create a new field instead. Requires the workers:custom_fields permission; changing the category, access level, or input source requires the manage level.","summary":"Update Field","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"anyOf":[{"type":"string","pattern":"^\\S[\\s\\S]*\\S$|^\\S$|^$","minLength":1},{"type":"null"}]},"description":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"null"}]},{"type":"null"}]},"config":{"anyOf":[{"type":"object"},{"type":"null"}]},"category":{"anyOf":[{"type":"string","enum":["info","pii","compensation","banking","it","compliance"]},{"type":"null"}]},"accessLevel":{"anyOf":[{"type":"string","enum":["admins","manager","worker"]},{"type":"null"}]},"inputBy":{"anyOf":[{"type":"string","enum":["admin","worker"]},{"type":"null"}]},"required":{"anyOf":[{"type":"boolean"},{"type":"null"}]}},"additionalProperties":false}}},"required":true}}},"/v1/custom_fields/{id}/archive":{"post":{"tags":["Custom Fields"],"operationId":"Custom Fields.archive","parameters":[{"name":"id","in":"path","schema":{"type":"string","pattern":"^cf_","description":"The tag of a company custom worker field.","examples":["cf_1234"]},"required":true}],"security":[{"apiKey":[]}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","pattern":"^cf_","description":"The tag of a company custom worker field.","examples":["cf_1234"]},"name":{"type":"string"},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"type":{"type":"string","enum":["text","number","date","boolean","currency","percentage","select","multi_select"]},"config":{"type":"object"},"status":{"type":"string","enum":["active","archived"]},"category":{"type":"string","enum":["info","pii","compensation","banking","it","compliance"]},"accessLevel":{"type":"string","enum":["admins","manager","worker"]},"inputBy":{"type":"string","enum":["admin","worker"]},"required":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"canWrite":{"type":"boolean"},"createdAt":{"type":"string"}},"required":["id","name","description","type","config","status","category","accessLevel","inputBy","canWrite","createdAt"],"additionalProperties":false}}}},"401":{"description":"ApiKeyUnauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKeyUnauthorizedEncoded"}}}},"403":{"description":"MissingRequiredCompanyPermissions | ApiNotEnabled","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/MissingRequiredCompanyPermissionsEncoded"},{"$ref":"#/components/schemas/ApiNotEnabledEncoded"}]}}}},"404":{"description":"CustomFieldNotFoundError","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomFieldNotFoundErrorEncoded"}}}},"429":{"description":"RateLimitExceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitExceededEncoded"}}}},"500":{"description":"InternalServerError","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/effect_HttpApiError_InternalServerErrorEncoded"},{"$ref":"#/components/schemas/effect_HttpApiError_InternalServerErrorEncoded"}]}}}}},"description":"Archive a custom worker field. Archived fields keep their existing worker values but cannot receive new ones. Requires the workers:custom_fields permission at the manage level.","summary":"Archive Field"}},"/v1/custom_fields/{id}/options":{"post":{"tags":["Custom Fields"],"operationId":"Custom Fields.createOption","parameters":[{"name":"id","in":"path","schema":{"type":"string","pattern":"^cf_","description":"The tag of a company custom worker field.","examples":["cf_1234"]},"required":true}],"security":[{"apiKey":[]}],"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","pattern":"^cfo_","description":"The tag of a company custom worker field option.","examples":["cfo_1234"]},"label":{"type":"string"},"value":{"type":"string"},"sortOrder":{"anyOf":[{"type":"number"},{"type":"string","enum":["Infinity","-Infinity","NaN"]}]},"status":{"type":"string","enum":["active","archived"]},"createdAt":{"type":"string"}},"required":["id","label","value","sortOrder","status","createdAt"],"additionalProperties":false}}}},"400":{"description":"InvalidCustomFieldOperationError","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidCustomFieldOperationErrorEncoded"}}}},"401":{"description":"ApiKeyUnauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKeyUnauthorizedEncoded"}}}},"403":{"description":"MissingRequiredCompanyPermissions | ApiNotEnabled","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/MissingRequiredCompanyPermissionsEncoded"},{"$ref":"#/components/schemas/ApiNotEnabledEncoded"}]}}}},"404":{"description":"CustomFieldNotFoundError","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomFieldNotFoundErrorEncoded"}}}},"409":{"description":"CustomFieldOptionAlreadyExistsError","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomFieldOptionAlreadyExistsErrorEncoded"}}}},"429":{"description":"RateLimitExceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitExceededEncoded"}}}},"500":{"description":"InternalServerError","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/effect_HttpApiError_InternalServerErrorEncoded"},{"$ref":"#/components/schemas/effect_HttpApiError_InternalServerErrorEncoded"}]}}}}},"description":"Add an option to a select or multi_select custom worker field. The option value should be treated as stable; the label can change. Requires the workers:custom_fields permission.","summary":"Create Field Option","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"label":{"type":"string","pattern":"^\\S[\\s\\S]*\\S$|^\\S$|^$","minLength":1},"value":{"type":"string","pattern":"^\\S[\\s\\S]*\\S$|^\\S$|^$","minLength":1},"sortOrder":{"anyOf":[{"anyOf":[{"type":"number"},{"type":"string","enum":["Infinity","-Infinity","NaN"]}]},{"type":"null"}]}},"required":["label","value"],"additionalProperties":false}}},"required":true}}},"/v1/custom_field_options/{id}":{"patch":{"tags":["Custom Fields"],"operationId":"Custom Fields.updateOption","parameters":[{"name":"id","in":"path","schema":{"type":"string","pattern":"^cfo_","description":"The tag of a company custom worker field option.","examples":["cfo_1234"]},"required":true}],"security":[{"apiKey":[]}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","pattern":"^cfo_","description":"The tag of a company custom worker field option.","examples":["cfo_1234"]},"label":{"type":"string"},"value":{"type":"string"},"sortOrder":{"anyOf":[{"type":"number"},{"type":"string","enum":["Infinity","-Infinity","NaN"]}]},"status":{"type":"string","enum":["active","archived"]},"createdAt":{"type":"string"}},"required":["id","label","value","sortOrder","status","createdAt"],"additionalProperties":false}}}},"400":{"description":"InvalidCustomFieldOperationError","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidCustomFieldOperationErrorEncoded"}}}},"401":{"description":"ApiKeyUnauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKeyUnauthorizedEncoded"}}}},"403":{"description":"MissingRequiredCompanyPermissions | ApiNotEnabled","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/MissingRequiredCompanyPermissionsEncoded"},{"$ref":"#/components/schemas/ApiNotEnabledEncoded"}]}}}},"404":{"description":"CustomFieldOptionNotFoundError","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomFieldOptionNotFoundErrorEncoded"}}}},"409":{"description":"CustomFieldOptionAlreadyExistsError","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomFieldOptionAlreadyExistsErrorEncoded"}}}},"429":{"description":"RateLimitExceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitExceededEncoded"}}}},"500":{"description":"InternalServerError","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/effect_HttpApiError_InternalServerErrorEncoded"},{"$ref":"#/components/schemas/effect_HttpApiError_InternalServerErrorEncoded"}]}}}}},"description":"Update the label or sort order of a custom worker field option. Options of archived fields cannot be edited. Requires the workers:custom_fields permission.","summary":"Update Field Option","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"label":{"anyOf":[{"type":"string","pattern":"^\\S[\\s\\S]*\\S$|^\\S$|^$","minLength":1},{"type":"null"}]},"sortOrder":{"anyOf":[{"anyOf":[{"type":"number"},{"type":"string","enum":["Infinity","-Infinity","NaN"]}]},{"type":"null"}]}},"additionalProperties":false}}},"required":true}},"delete":{"tags":["Custom Fields"],"operationId":"Custom Fields.deleteOption","parameters":[{"name":"id","in":"path","schema":{"type":"string","pattern":"^cfo_","description":"The tag of a company custom worker field option.","examples":["cfo_1234"]},"required":true}],"security":[{"apiKey":[]}],"responses":{"204":{"description":"<No Content>"},"401":{"description":"ApiKeyUnauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKeyUnauthorizedEncoded"}}}},"403":{"description":"MissingRequiredCompanyPermissions | ApiNotEnabled","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/MissingRequiredCompanyPermissionsEncoded"},{"$ref":"#/components/schemas/ApiNotEnabledEncoded"}]}}}},"404":{"description":"CustomFieldOptionNotFoundError","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomFieldOptionNotFoundErrorEncoded"}}}},"409":{"description":"CustomFieldOptionInUseError","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomFieldOptionInUseErrorEncoded"}}}},"429":{"description":"RateLimitExceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitExceededEncoded"}}}},"500":{"description":"InternalServerError","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/effect_HttpApiError_InternalServerErrorEncoded"},{"$ref":"#/components/schemas/effect_HttpApiError_InternalServerErrorEncoded"}]}}}}},"description":"Delete a custom worker field option that is not applied to any worker. Options in use must be archived instead. Requires the workers:custom_fields permission at the manage level.","summary":"Delete Unused Field Option"}},"/v1/custom_field_options/{id}/archive":{"post":{"tags":["Custom Fields"],"operationId":"Custom Fields.archiveOption","parameters":[{"name":"id","in":"path","schema":{"type":"string","pattern":"^cfo_","description":"The tag of a company custom worker field option.","examples":["cfo_1234"]},"required":true}],"security":[{"apiKey":[]}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","pattern":"^cfo_","description":"The tag of a company custom worker field option.","examples":["cfo_1234"]},"label":{"type":"string"},"value":{"type":"string"},"sortOrder":{"anyOf":[{"type":"number"},{"type":"string","enum":["Infinity","-Infinity","NaN"]}]},"status":{"type":"string","enum":["active","archived"]},"createdAt":{"type":"string"}},"required":["id","label","value","sortOrder","status","createdAt"],"additionalProperties":false}}}},"401":{"description":"ApiKeyUnauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKeyUnauthorizedEncoded"}}}},"403":{"description":"MissingRequiredCompanyPermissions | ApiNotEnabled","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/MissingRequiredCompanyPermissionsEncoded"},{"$ref":"#/components/schemas/ApiNotEnabledEncoded"}]}}}},"404":{"description":"CustomFieldOptionNotFoundError","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomFieldOptionNotFoundErrorEncoded"}}}},"429":{"description":"RateLimitExceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitExceededEncoded"}}}},"500":{"description":"InternalServerError","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/effect_HttpApiError_InternalServerErrorEncoded"},{"$ref":"#/components/schemas/effect_HttpApiError_InternalServerErrorEncoded"}]}}}}},"description":"Archive a custom worker field option. Archived options remain on existing worker values but cannot be newly selected. Requires the workers:custom_fields permission at the manage level.","summary":"Archive Field Option"}},"/v1/custom_field_values":{"get":{"tags":["Custom Fields"],"operationId":"Custom Fields.listValues","parameters":[{"name":"workerIds","in":"query","schema":{"anyOf":[{"type":"array","items":{"type":"string","pattern":"^wrk_","description":"The id of the worker.","examples":["wrk_1234"]}},{"type":"null"}]},"required":false},{"name":"fieldIds","in":"query","schema":{"anyOf":[{"type":"array","items":{"type":"string","pattern":"^cf_","description":"The tag of a company custom worker field.","examples":["cf_1234"]}},{"type":"null"}]},"required":false}],"security":[{"apiKey":[]}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","pattern":"^cfv_","description":"The tag of a company custom worker field value.","examples":["cfv_1234"]},"workerId":{"type":"string","pattern":"^wrk_","description":"The id of the worker.","examples":["wrk_1234"]},"fieldId":{"type":"string","pattern":"^cf_","description":"The tag of a company custom worker field.","examples":["cf_1234"]},"value":{"$ref":"#/components/schemas/PublicCustomFieldValueOutput"},"updatedAt":{"type":"string"}},"required":["id","workerId","fieldId","value","updatedAt"],"additionalProperties":false}}}}},"401":{"description":"ApiKeyUnauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKeyUnauthorizedEncoded"}}}},"403":{"description":"MissingRequiredCompanyPermissions | ApiNotEnabled","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/MissingRequiredCompanyPermissionsEncoded"},{"$ref":"#/components/schemas/ApiNotEnabledEncoded"}]}}}},"429":{"description":"RateLimitExceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitExceededEncoded"}}}},"500":{"description":"InternalServerError","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/effect_HttpApiError_InternalServerErrorEncoded"},{"$ref":"#/components/schemas/effect_HttpApiError_InternalServerErrorEncoded"}]}}}}},"description":"List custom field values for workers, optionally filtered by worker or field. Values are returned only for fields whose category your API key can read.","summary":"List Field Values"},"put":{"tags":["Custom Fields"],"operationId":"Custom Fields.upsertValue","parameters":[],"security":[{"apiKey":[]}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","pattern":"^cfv_","description":"The tag of a company custom worker field value.","examples":["cfv_1234"]},"workerId":{"type":"string","pattern":"^wrk_","description":"The id of the worker.","examples":["wrk_1234"]},"fieldId":{"type":"string","pattern":"^cf_","description":"The tag of a company custom worker field.","examples":["cf_1234"]},"value":{"$ref":"#/components/schemas/PublicCustomFieldValueOutput"},"updatedAt":{"type":"string"}},"required":["id","workerId","fieldId","value","updatedAt"],"additionalProperties":false}}}},"400":{"description":"InvalidCustomFieldValueError | InvalidCustomFieldOperationError","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/InvalidCustomFieldValueErrorEncoded"},{"$ref":"#/components/schemas/InvalidCustomFieldOperationErrorEncoded"}]}}}},"401":{"description":"ApiKeyUnauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKeyUnauthorizedEncoded"}}}},"403":{"description":"MissingRequiredCompanyPermissions | ApiNotEnabled","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/MissingRequiredCompanyPermissionsEncoded"},{"$ref":"#/components/schemas/ApiNotEnabledEncoded"}]}}}},"404":{"description":"CustomFieldNotFoundError | CustomFieldWorkerNotFoundError","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/CustomFieldNotFoundErrorEncoded"},{"$ref":"#/components/schemas/CustomFieldWorkerNotFoundErrorEncoded"}]}}}},"429":{"description":"RateLimitExceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitExceededEncoded"}}}},"500":{"description":"InternalServerError","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/effect_HttpApiError_InternalServerErrorEncoded"},{"$ref":"#/components/schemas/effect_HttpApiError_InternalServerErrorEncoded"}]}}}}},"description":"Create or replace a worker's value for a custom field. The value shape must match the field type, and your API key must hold write on the field's category.","summary":"Set Field Value","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"workerId":{"type":"string","pattern":"^wrk_","description":"The id of the worker.","examples":["wrk_1234"]},"fieldId":{"type":"string","pattern":"^cf_","description":"The tag of a company custom worker field.","examples":["cf_1234"]},"value":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["text"]},"value":{"type":"string"}},"required":["type","value"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["number"]},"value":{"anyOf":[{"type":"number"},{"type":"string","enum":["Infinity","-Infinity","NaN"]}]}},"required":["type","value"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["date"]},"value":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"}},"required":["type","value"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["boolean"]},"value":{"type":"boolean"}},"required":["type","value"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["currency"]},"amount":{"type":"integer","description":"Integer base units of currencyCode (e.g. cents)."},"currencyCode":{"type":"string","enum":["USD","AUD","BGN","BRL","CAD","CHF","CZK","DKK","EUR","GBP","HKD","HUF","IDR","INR","JPY","MYR","NOK","NZD","CNY","PLN","RON","TRY","SEK","SGD","AED","ARS","BDT","BWP","CLP","COP","CRC","EGP","FJD","GEL","GHS","ILS","KES","KRW","LKR","MAD","MXN","NPR","PHP","PKR","THB","UAH","UGX","UYU","VND","ZAR","ZMW","TND","NGN","RSD","TWD","GTQ","HNL","DOP","SAR","XAF","PEN"]}},"required":["type","amount","currencyCode"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["percentage"]},"value":{"anyOf":[{"type":"number"},{"type":"string","enum":["Infinity","-Infinity","NaN"]}]}},"required":["type","value"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["select"]},"optionId":{"type":"string","pattern":"^cfo_","description":"The tag of a company custom worker field option.","examples":["cfo_1234"]}},"required":["type","optionId"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["multi_select"]},"optionIds":{"type":"array","items":{"type":"string","pattern":"^cfo_","description":"The tag of a company custom worker field option.","examples":["cfo_1234"]}}},"required":["type","optionIds"],"additionalProperties":false}]}},"required":["workerId","fieldId","value"],"additionalProperties":false}}},"required":true}},"delete":{"tags":["Custom Fields"],"operationId":"Custom Fields.clearValue","parameters":[{"name":"workerId","in":"query","schema":{"type":"string","pattern":"^wrk_","description":"The id of the worker.","examples":["wrk_1234"]},"required":true},{"name":"fieldId","in":"query","schema":{"type":"string","pattern":"^cf_","description":"The tag of a company custom worker field.","examples":["cf_1234"]},"required":true}],"security":[{"apiKey":[]}],"responses":{"204":{"description":"<No Content>"},"401":{"description":"ApiKeyUnauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKeyUnauthorizedEncoded"}}}},"403":{"description":"MissingRequiredCompanyPermissions | ApiNotEnabled","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/MissingRequiredCompanyPermissionsEncoded"},{"$ref":"#/components/schemas/ApiNotEnabledEncoded"}]}}}},"404":{"description":"CustomFieldNotFoundError | CustomFieldWorkerNotFoundError","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/CustomFieldNotFoundErrorEncoded"},{"$ref":"#/components/schemas/CustomFieldWorkerNotFoundErrorEncoded"}]}}}},"429":{"description":"RateLimitExceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitExceededEncoded"}}}},"500":{"description":"InternalServerError","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/effect_HttpApiError_InternalServerErrorEncoded"},{"$ref":"#/components/schemas/effect_HttpApiError_InternalServerErrorEncoded"}]}}}}},"description":"Remove a worker's value for a custom field. Your API key must hold write on the field's category.","summary":"Clear Field Value"}},"/v1/departments":{"get":{"tags":["Departments"],"operationId":"Departments.list","parameters":[{"name":"limit","in":"query","schema":{"anyOf":[{"type":"string"},{"type":"null"}]},"required":true},{"name":"afterId","in":"query","schema":{"anyOf":[{"type":"string","pattern":"^dpt_","description":"The unique public id of the department","examples":["dpt_1234"]},{"type":"null"}]},"required":false},{"name":"beforeId","in":"query","schema":{"anyOf":[{"type":"string","pattern":"^dpt_","description":"The unique public id of the department","examples":["dpt_1234"]},{"type":"null"}]},"required":false}],"security":[{"apiKey":[]}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"hasMore":{"type":"boolean"},"count":{"type":"integer"},"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","pattern":"^dpt_","description":"The unique public id of the department","examples":["dpt_1234"]},"name":{"type":"string","examples":["Engineering","Marketing","Sales"]},"createdAt":{"type":"string"}},"required":["id","name","createdAt"],"additionalProperties":false}}},"required":["hasMore","count","data"],"additionalProperties":false}}}},"401":{"description":"ApiKeyUnauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKeyUnauthorizedEncoded"}}}},"403":{"description":"MissingRequiredCompanyPermissions | ApiNotEnabled","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/MissingRequiredCompanyPermissionsEncoded"},{"$ref":"#/components/schemas/ApiNotEnabledEncoded"}]}}}},"429":{"description":"RateLimitExceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitExceededEncoded"}}}},"500":{"description":"InternalServerError","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/effect_HttpApiError_InternalServerErrorEncoded"},{"$ref":"#/components/schemas/effect_HttpApiError_InternalServerErrorEncoded"}]}}}}},"description":"List all departments for your company.","summary":"List Departments"},"post":{"tags":["Departments"],"operationId":"Departments.create","parameters":[],"security":[{"apiKey":[]}],"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","pattern":"^dpt_","description":"The unique public id of the department","examples":["dpt_1234"]},"name":{"type":"string","examples":["Engineering","Marketing","Sales"]},"createdAt":{"type":"string"}},"required":["id","name","createdAt"],"additionalProperties":false}}}},"401":{"description":"ApiKeyUnauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKeyUnauthorizedEncoded"}}}},"403":{"description":"MissingRequiredCompanyPermissions | ApiNotEnabled","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/MissingRequiredCompanyPermissionsEncoded"},{"$ref":"#/components/schemas/ApiNotEnabledEncoded"}]}}}},"409":{"description":"DepartmentAlreadyExists","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DepartmentAlreadyExistsEncoded"}}}},"429":{"description":"RateLimitExceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitExceededEncoded"}}}},"500":{"description":"InternalServerError","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/effect_HttpApiError_InternalServerErrorEncoded"},{"$ref":"#/components/schemas/effect_HttpApiError_InternalServerErrorEncoded"}]}}}}},"description":"Create a new department.","summary":"Create Department","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","pattern":"^\\S[\\s\\S]*\\S$|^\\S$|^$","minLength":1}},"required":["name"],"additionalProperties":false}}},"required":true}}},"/v1/departments/{id}":{"patch":{"tags":["Departments"],"operationId":"Departments.update","parameters":[{"name":"id","in":"path","schema":{"type":"string","pattern":"^dpt_","description":"The unique public id of the department","examples":["dpt_1234"]},"required":true}],"security":[{"apiKey":[]}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","pattern":"^dpt_","description":"The unique public id of the department","examples":["dpt_1234"]},"name":{"type":"string","examples":["Engineering","Marketing","Sales"]},"createdAt":{"type":"string"}},"required":["id","name","createdAt"],"additionalProperties":false}}}},"401":{"description":"ApiKeyUnauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKeyUnauthorizedEncoded"}}}},"403":{"description":"MissingRequiredCompanyPermissions | ApiNotEnabled","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/MissingRequiredCompanyPermissionsEncoded"},{"$ref":"#/components/schemas/ApiNotEnabledEncoded"}]}}}},"404":{"description":"DepartmentNotFound","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DepartmentNotFoundEncoded"}}}},"409":{"description":"DepartmentAlreadyExists","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DepartmentAlreadyExistsEncoded"}}}},"429":{"description":"RateLimitExceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitExceededEncoded"}}}},"500":{"description":"InternalServerError","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/effect_HttpApiError_InternalServerErrorEncoded"},{"$ref":"#/components/schemas/effect_HttpApiError_InternalServerErrorEncoded"}]}}}}},"description":"Update an existing department.","summary":"Update Department","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}]}},"additionalProperties":false}}},"required":true}}},"/v1/i9_verifications":{"get":{"tags":["I-9 Verifications"],"operationId":"I-9 Verifications.list","parameters":[{"name":"limit","in":"query","schema":{"anyOf":[{"type":"string"},{"type":"null"}]},"required":true},{"name":"afterId","in":"query","schema":{"anyOf":[{"type":"string","pattern":"^i9v_","description":"The tag of the i9 verification.","examples":["i9v_1234"]},{"type":"null"}]},"required":false},{"name":"beforeId","in":"query","schema":{"anyOf":[{"type":"string","pattern":"^i9v_","description":"The tag of the i9 verification.","examples":["i9v_1234"]},{"type":"null"}]},"required":false},{"name":"workerIds","in":"query","schema":{"anyOf":[{"type":"array","items":{"type":"string","pattern":"^wrk_","description":"The id of the worker.","examples":["wrk_1234"]},"minItems":1},{"type":"null"}],"description":"Worker IDs to include, supplied as repeated parameters. Omit for all workers. Unknown or foreign IDs contribute no matches."},"required":false},{"name":"statuses","in":"query","schema":{"anyOf":[{"type":"array","items":{"type":"string","enum":["not_started","awaiting_worker","awaiting_admin","verified"]},"minItems":1},{"type":"null"}],"description":"Statuses to include, supplied as repeated parameters. Omit for all workflow states."},"required":false}],"security":[{"apiKey":[]}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"hasMore":{"type":"boolean"},"count":{"type":"integer"},"data":{"type":"array","items":{"$ref":"#/components/schemas/PublicI9Verification"}}},"required":["hasMore","count","data"],"additionalProperties":false}}}},"400":{"description":"The I-9 verification query contains an invalid cursor or cursor combination.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidI9VerificationQueryEncoded"}}}},"401":{"description":"ApiKeyUnauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKeyUnauthorizedEncoded"}}}},"403":{"description":"MissingRequiredCompanyPermissions | ApiNotEnabled","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/MissingRequiredCompanyPermissionsEncoded"},{"$ref":"#/components/schemas/ApiNotEnabledEncoded"}]}}}},"429":{"description":"RateLimitExceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitExceededEncoded"}}}},"500":{"description":"InternalServerError","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/effect_HttpApiError_InternalServerErrorEncoded"},{"$ref":"#/components/schemas/effect_HttpApiError_InternalServerErrorEncoded"}]}}}}},"description":"List current and retained company I-9 verifications in all workflow states, newest first. The API key must have workers profile and compliance read scope.","summary":"List I-9 verifications"}},"/v1/i9_verifications/{id}":{"get":{"tags":["I-9 Verifications"],"operationId":"I-9 Verifications.get","parameters":[{"name":"id","in":"path","schema":{"type":"string","pattern":"^i9v_","description":"The tag of the i9 verification.","examples":["i9v_1234"]},"required":true}],"security":[{"apiKey":[]}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicI9Verification"}}}},"401":{"description":"ApiKeyUnauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKeyUnauthorizedEncoded"}}}},"403":{"description":"MissingRequiredCompanyPermissions | ApiNotEnabled","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/MissingRequiredCompanyPermissionsEncoded"},{"$ref":"#/components/schemas/ApiNotEnabledEncoded"}]}}}},"404":{"description":"The specified I-9 verification could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/I9VerificationNotFoundEncoded"}}}},"429":{"description":"RateLimitExceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitExceededEncoded"}}}},"500":{"description":"InternalServerError","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/effect_HttpApiError_InternalServerErrorEncoded"},{"$ref":"#/components/schemas/effect_HttpApiError_InternalServerErrorEncoded"}]}}}}},"description":"Get a specific I-9 verification by its id. The API key must have workers profile and compliance read scope.","summary":"Get I-9 verification"}},"/v1/bank_accounts":{"get":{"tags":["Bank Accounts"],"operationId":"Bank Accounts.list","parameters":[{"name":"limit","in":"query","schema":{"anyOf":[{"type":"string"},{"type":"null"}]},"required":true},{"name":"afterId","in":"query","schema":{"anyOf":[{"type":"string","pattern":"^bank_","description":"The tag of the bank account.","examples":["bank_1234"]},{"type":"null"}]},"required":false},{"name":"beforeId","in":"query","schema":{"anyOf":[{"type":"string","pattern":"^bank_","description":"The tag of the bank account.","examples":["bank_1234"]},{"type":"null"}]},"required":false},{"name":"workerIds","in":"query","schema":{"anyOf":[{"type":"array","items":{"type":"string","pattern":"^wrk_","description":"The id of the worker.","examples":["wrk_1234"]},"minItems":1},{"type":"null"}],"description":"Worker IDs to include as repeated parameters. Omit for all workers. Unknown or foreign IDs contribute no matches."},"required":false},{"name":"statuses","in":"query","schema":{"anyOf":[{"type":"array","items":{"type":"string","enum":["verified","pending_verification","needs_address","unverified","blocked"]},"minItems":1},{"type":"null"}],"description":"Verification states to include as repeated parameters. Omit for all states."},"required":false}],"security":[{"apiKey":[]}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"hasMore":{"type":"boolean"},"count":{"type":"integer"},"data":{"type":"array","items":{"$ref":"#/components/schemas/PublicBankAccount"}}},"required":["hasMore","count","data"],"additionalProperties":false}}}},"400":{"description":"The bank account query contains an invalid cursor or cursor combination.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidBankAccountQueryEncoded"}}}},"401":{"description":"ApiKeyUnauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKeyUnauthorizedEncoded"}}}},"403":{"description":"MissingRequiredCompanyPermissions | ApiNotEnabled","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/MissingRequiredCompanyPermissionsEncoded"},{"$ref":"#/components/schemas/ApiNotEnabledEncoded"}]}}}},"429":{"description":"RateLimitExceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitExceededEncoded"}}}},"500":{"description":"InternalServerError","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/effect_HttpApiError_InternalServerErrorEncoded"},{"$ref":"#/components/schemas/effect_HttpApiError_InternalServerErrorEncoded"}]}}}}},"description":"List stored worker bank accounts, newest first. Requires workers banking and profile read scopes.","summary":"List bank accounts"}},"/v1/bank_accounts/{id}":{"get":{"tags":["Bank Accounts"],"operationId":"Bank Accounts.get","parameters":[{"name":"id","in":"path","schema":{"type":"string","pattern":"^bank_","description":"The tag of the bank account.","examples":["bank_1234"]},"required":true}],"security":[{"apiKey":[]}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicBankAccount"}}}},"401":{"description":"ApiKeyUnauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKeyUnauthorizedEncoded"}}}},"403":{"description":"MissingRequiredCompanyPermissions | ApiNotEnabled","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/MissingRequiredCompanyPermissionsEncoded"},{"$ref":"#/components/schemas/ApiNotEnabledEncoded"}]}}}},"404":{"description":"The bank account could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BankAccountNotFoundEncoded"}}}},"429":{"description":"RateLimitExceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitExceededEncoded"}}}},"500":{"description":"InternalServerError","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/effect_HttpApiError_InternalServerErrorEncoded"},{"$ref":"#/components/schemas/effect_HttpApiError_InternalServerErrorEncoded"}]}}}}},"description":"Get a stored worker bank account. Requires workers banking and profile read scopes.","summary":"Get bank account"}},"/v1/levels":{"get":{"tags":["Levels"],"operationId":"Levels.list","parameters":[],"security":[{"apiKey":[]}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","pattern":"^jlvl_","description":"The unique public id of the job level","examples":["jlvl_1234"]},"code":{"type":"string"},"name":{"type":"string"},"track":{"type":"string","enum":["ic","manager","executive"]}},"required":["id","code","name","track"],"additionalProperties":false}}}}},"401":{"description":"ApiKeyUnauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKeyUnauthorizedEncoded"}}}},"403":{"description":"Job levels are not enabled for this company. | MissingRequiredCompanyPermissions | ApiNotEnabled","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/JobLevelsNotEnabledEncoded"},{"$ref":"#/components/schemas/MissingRequiredCompanyPermissionsEncoded"},{"$ref":"#/components/schemas/ApiNotEnabledEncoded"}]}}}},"429":{"description":"RateLimitExceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitExceededEncoded"}}}},"500":{"description":"InternalServerError","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/effect_HttpApiError_InternalServerErrorEncoded"},{"$ref":"#/components/schemas/effect_HttpApiError_InternalServerErrorEncoded"}]}}}}},"description":"List the active standard job levels available to your company.","summary":"List Job Levels"}},"/v1/offers":{"get":{"tags":["Offers"],"operationId":"Offers.list","parameters":[{"name":"limit","in":"query","schema":{"anyOf":[{"type":"string"},{"type":"null"}]},"required":true},{"name":"afterId","in":"query","schema":{"anyOf":[{"type":"string","pattern":"^offr_","description":"The tag of the offer.","examples":["offr_1234"]},{"type":"null"}]},"required":false},{"name":"beforeId","in":"query","schema":{"anyOf":[{"type":"string","pattern":"^offr_","description":"The tag of the offer.","examples":["offr_1234"]},{"type":"null"}]},"required":false},{"name":"statuses","in":"query","schema":{"anyOf":[{"type":"array","items":{"type":"string","enum":["draft","sent","accepted","void","expired"]}},{"type":"null"}]},"required":false},{"name":"workerTypes","in":"query","schema":{"anyOf":[{"type":"array","items":{"type":"string","enum":["employee","us_contractor","global_contractor"]}},{"type":"null"}]},"required":false},{"name":"candidateEmail","in":"query","schema":{"anyOf":[{"type":"string","format":"email","title":"Email","description":"An email with a reasonably valid regex (based on RFC 5321 atext characters)","examples":["john@joinwarp.com"]},{"type":"null"}]},"required":false}],"security":[{"apiKey":[]}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"hasMore":{"type":"boolean"},"count":{"type":"integer"},"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","pattern":"^offr_","description":"The tag of the offer.","examples":["offr_1234"]},"status":{"type":"string","enum":["draft","sent","accepted","void","expired"]},"voidReason":{"anyOf":[{"anyOf":[{"type":"string","enum":["replaced","candidate_declined","other"]},{"type":"null"}]},{"type":"null"}],"description":"The reason the offer was voided. Null for offers that have not been voided."},"voidNotes":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"null"}]},{"type":"null"}],"description":"Additional notes explaining why the offer was voided."},"workerType":{"type":"string","enum":["employee","us_contractor","global_contractor"]},"candidate":{"type":"object","properties":{"firstName":{"type":"string","examples":["Jonathan"]},"lastName":{"type":"string","examples":["Galt"]},"email":{"type":"string","format":"email","title":"Email","description":"An email with a reasonably valid regex (based on RFC 5321 atext characters)","examples":["john@joinwarp.com"]},"contractorDetails":{"anyOf":[{"type":"object","properties":{"isBusiness":{"type":"boolean"},"legalBusinessName":{"anyOf":[{"type":"string"},{"type":"null"}],"examples":[null,"Galt Enterprises, LLC"]}},"required":["isBusiness","legalBusinessName"],"additionalProperties":false},{"type":"null"}]}},"required":["firstName","lastName","email","contractorDetails"],"additionalProperties":false},"position":{"type":"object","properties":{"title":{"type":"string","examples":["Research Engineer"]},"startDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"country":{"type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"scopeOfWork":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["title","startDate","country","scopeOfWork"],"additionalProperties":false},"department":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","pattern":"^dpt_","description":"The unique public id of the department","examples":["dpt_1234"]},"name":{"type":"string","examples":["Engineering"]}},"required":["id","name"],"additionalProperties":false},{"type":"null"}]},"workplace":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","pattern":"^wkp_","description":"Public workplace identifier","examples":["wkp_1234"]},"name":{"type":"string","examples":["New York Office"]}},"required":["id","name"],"additionalProperties":false},{"type":"null"}]},"manager":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","pattern":"^wrk_","description":"The id of the worker.","examples":["wrk_1234"]},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"examples":[null,"Dagny Taggart"]}},"required":["id","name"],"additionalProperties":false},{"type":"null"}]},"level":{"anyOf":[{"anyOf":[{"type":"object","properties":{"id":{"type":"string","pattern":"^jlvl_","description":"The unique public id of the job level","examples":["jlvl_1234"]},"code":{"type":"string"},"name":{"type":"string"},"track":{"type":"string","enum":["ic","manager","executive"]}},"required":["id","code","name","track"],"additionalProperties":false},{"type":"null"}]},{"type":"null"}],"description":"The offer's job level, or null if unassigned. Omitted when job levels are not enabled."},"sentBy":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Display name of the person or company that sent the offer. Null for offers not yet sent.","examples":[null,"Dagny Taggart","Galt Enterprises, LLC"]},"compensation":{"type":"object","properties":{"basePay":{"type":"object","properties":{"amount":{"$ref":"#/components/schemas/PublicMoneyAmount"},"basis":{"type":"string","enum":["year","month","week","hour","variable"]},"type":{"anyOf":[{"type":"string","enum":["fixed","pay_as_you_go"]},{"type":"null"}]},"variableRate":{"anyOf":[{"$ref":"#/components/schemas/PublicMoneyAmount"},{"type":"null"}]}},"required":["amount","basis","type","variableRate"],"additionalProperties":false},"signOnBonus":{"anyOf":[{"$ref":"#/components/schemas/PublicMoneyAmount"},{"type":"null"}]},"relocationBonus":{"anyOf":[{"$ref":"#/components/schemas/PublicMoneyAmount"},{"type":"null"}]},"stock":{"anyOf":[{"type":"object","properties":{"options":{"type":"integer","minimum":0},"vestingScheduleMonths":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}]},"cliffMonths":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}]}},"required":["options","vestingScheduleMonths","cliffMonths"],"additionalProperties":false},{"type":"null"}]}},"required":["basePay","signOnBonus","relocationBonus","stock"],"additionalProperties":false},"offerUrl":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The candidate-facing offer portal URL. Null for offers that have not been sent."},"expirationTime":{"anyOf":[{"type":"string"},{"type":"null"}]},"lastViewedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"createdAt":{"type":"string"}},"required":["id","status","workerType","candidate","position","department","workplace","manager","sentBy","compensation","offerUrl","expirationTime","lastViewedAt","createdAt"],"additionalProperties":false}}},"required":["hasMore","count","data"],"additionalProperties":false}}}},"401":{"description":"ApiKeyUnauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKeyUnauthorizedEncoded"}}}},"403":{"description":"MissingRequiredCompanyPermissions | ApiNotEnabled","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/MissingRequiredCompanyPermissionsEncoded"},{"$ref":"#/components/schemas/ApiNotEnabledEncoded"}]}}}},"429":{"description":"RateLimitExceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitExceededEncoded"}}}},"500":{"description":"InternalServerError","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/effect_HttpApiError_InternalServerErrorEncoded"},{"$ref":"#/components/schemas/effect_HttpApiError_InternalServerErrorEncoded"}]}}}}},"description":"List the candidate offers for your company.","summary":"List Offers"},"post":{"tags":["Offers"],"operationId":"Offers.create","parameters":[],"security":[{"apiKey":[]}],"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","pattern":"^offr_","description":"The tag of the offer.","examples":["offr_1234"]},"status":{"type":"string","enum":["draft","sent","accepted","void","expired"]},"voidReason":{"anyOf":[{"anyOf":[{"type":"string","enum":["replaced","candidate_declined","other"]},{"type":"null"}]},{"type":"null"}],"description":"The reason the offer was voided. Null for offers that have not been voided."},"voidNotes":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"null"}]},{"type":"null"}],"description":"Additional notes explaining why the offer was voided."},"workerType":{"type":"string","enum":["employee","us_contractor","global_contractor"]},"candidate":{"type":"object","properties":{"firstName":{"type":"string","examples":["Jonathan"]},"lastName":{"type":"string","examples":["Galt"]},"email":{"type":"string","format":"email","title":"Email","description":"An email with a reasonably valid regex (based on RFC 5321 atext characters)","examples":["john@joinwarp.com"]},"contractorDetails":{"anyOf":[{"type":"object","properties":{"isBusiness":{"type":"boolean"},"legalBusinessName":{"anyOf":[{"type":"string"},{"type":"null"}],"examples":[null,"Galt Enterprises, LLC"]}},"required":["isBusiness","legalBusinessName"],"additionalProperties":false},{"type":"null"}]}},"required":["firstName","lastName","email","contractorDetails"],"additionalProperties":false},"position":{"type":"object","properties":{"title":{"type":"string","examples":["Research Engineer"]},"startDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"country":{"type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"scopeOfWork":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["title","startDate","country","scopeOfWork"],"additionalProperties":false},"department":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","pattern":"^dpt_","description":"The unique public id of the department","examples":["dpt_1234"]},"name":{"type":"string","examples":["Engineering"]}},"required":["id","name"],"additionalProperties":false},{"type":"null"}]},"workplace":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","pattern":"^wkp_","description":"Public workplace identifier","examples":["wkp_1234"]},"name":{"type":"string","examples":["New York Office"]}},"required":["id","name"],"additionalProperties":false},{"type":"null"}]},"manager":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","pattern":"^wrk_","description":"The id of the worker.","examples":["wrk_1234"]},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"examples":[null,"Dagny Taggart"]}},"required":["id","name"],"additionalProperties":false},{"type":"null"}]},"level":{"anyOf":[{"anyOf":[{"type":"object","properties":{"id":{"type":"string","pattern":"^jlvl_","description":"The unique public id of the job level","examples":["jlvl_1234"]},"code":{"type":"string"},"name":{"type":"string"},"track":{"type":"string","enum":["ic","manager","executive"]}},"required":["id","code","name","track"],"additionalProperties":false},{"type":"null"}]},{"type":"null"}],"description":"The offer's job level, or null if unassigned. Omitted when job levels are not enabled."},"sentBy":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Display name of the person or company that sent the offer. Null for offers not yet sent.","examples":[null,"Dagny Taggart","Galt Enterprises, LLC"]},"compensation":{"type":"object","properties":{"basePay":{"type":"object","properties":{"amount":{"$ref":"#/components/schemas/PublicMoneyAmount"},"basis":{"type":"string","enum":["year","month","week","hour","variable"]},"type":{"anyOf":[{"type":"string","enum":["fixed","pay_as_you_go"]},{"type":"null"}]},"variableRate":{"anyOf":[{"$ref":"#/components/schemas/PublicMoneyAmount"},{"type":"null"}]}},"required":["amount","basis","type","variableRate"],"additionalProperties":false},"signOnBonus":{"anyOf":[{"$ref":"#/components/schemas/PublicMoneyAmount"},{"type":"null"}]},"relocationBonus":{"anyOf":[{"$ref":"#/components/schemas/PublicMoneyAmount"},{"type":"null"}]},"stock":{"anyOf":[{"type":"object","properties":{"options":{"type":"integer","minimum":0},"vestingScheduleMonths":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}]},"cliffMonths":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}]}},"required":["options","vestingScheduleMonths","cliffMonths"],"additionalProperties":false},{"type":"null"}]}},"required":["basePay","signOnBonus","relocationBonus","stock"],"additionalProperties":false},"offerUrl":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The candidate-facing offer portal URL. Null for offers that have not been sent."},"expirationTime":{"anyOf":[{"type":"string"},{"type":"null"}]},"lastViewedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"createdAt":{"type":"string"}},"required":["id","status","workerType","candidate","position","department","workplace","manager","sentBy","compensation","offerUrl","expirationTime","lastViewedAt","createdAt"],"additionalProperties":false}}}},"401":{"description":"ApiKeyUnauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKeyUnauthorizedEncoded"}}}},"403":{"description":"Job levels are not enabled for this company. | MissingRequiredCompanyPermissions | ApiNotEnabled","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/JobLevelsNotEnabledEncoded"},{"$ref":"#/components/schemas/MissingRequiredCompanyPermissionsEncoded"},{"$ref":"#/components/schemas/ApiNotEnabledEncoded"}]}}}},"404":{"description":"DepartmentNotFound | WorkplaceNotFound | The specified manager could not be found. The managerId must reference an existing worker. | The job level could not be found.","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/DepartmentNotFoundEncoded"},{"$ref":"#/components/schemas/WorkplaceNotFoundEncoded"},{"$ref":"#/components/schemas/ManagerNotFoundErrorEncoded"},{"$ref":"#/components/schemas/LevelNotFoundEncoded"}]}}}},"422":{"description":"InvalidExpirationTimeError | OfferBackgroundCheckWorkLocationRequired","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/InvalidExpirationTimeErrorEncoded"},{"$ref":"#/components/schemas/OfferBackgroundCheckWorkLocationRequiredEncoded"}]}}}},"429":{"description":"RateLimitExceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitExceededEncoded"}}}},"500":{"description":"InternalServerError","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/effect_HttpApiError_InternalServerErrorEncoded"},{"$ref":"#/components/schemas/effect_HttpApiError_InternalServerErrorEncoded"}]}}}}},"description":"Create and send a candidate offer. The candidate receives an email with a link to the offer portal.","summary":"Create Offer","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"candidate":{"type":"object","properties":{"firstName":{"type":"string","pattern":"^\\S[\\s\\S]*\\S$|^\\S$|^$","minLength":1},"lastName":{"type":"string","pattern":"^\\S[\\s\\S]*\\S$|^\\S$|^$","minLength":1},"email":{"type":"string","format":"email","title":"Email","description":"An email with a reasonably valid regex (based on RFC 5321 atext characters)","examples":["john@joinwarp.com"]},"contractorDetails":{"anyOf":[{"anyOf":[{"type":"object","properties":{"isBusiness":{"type":"boolean"},"legalBusinessName":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["isBusiness","legalBusinessName"],"additionalProperties":false},{"type":"null"}]},{"type":"null"}]}},"required":["firstName","lastName","email"],"additionalProperties":false},"position":{"type":"object","properties":{"title":{"type":"string","pattern":"^\\S[\\s\\S]*\\S$|^\\S$|^$","minLength":1},"startDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"country":{"anyOf":[{"anyOf":[{"type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},{"type":"null"}],"description":"Required when workerType is global_contractor. Ignored for employee and us_contractor offers."},{"type":"null"}]},"scopeOfWork":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"null"}]},{"type":"null"}]}},"required":["title","startDate"],"additionalProperties":false},"departmentId":{"anyOf":[{"anyOf":[{"type":"string","pattern":"^dpt_","description":"The unique public id of the department","examples":["dpt_1234"]},{"type":"null"}]},{"type":"null"}]},"workplaceId":{"anyOf":[{"anyOf":[{"type":"string","pattern":"^wkp_","description":"Public workplace identifier","examples":["wkp_1234"]},{"type":"null"}]},{"type":"null"}]},"managerId":{"anyOf":[{"anyOf":[{"type":"string","pattern":"^wrk_","description":"The id of the worker.","examples":["wrk_1234"]},{"type":"null"}]},{"type":"null"}]},"levelId":{"anyOf":[{"anyOf":[{"type":"string","pattern":"^jlvl_","description":"The unique public id of the job level","examples":["jlvl_1234"]},{"type":"null"}]},{"type":"null"}]},"workerType":{"type":"string","enum":["employee","us_contractor","global_contractor"]},"compensation":{"type":"object","properties":{"payBasis":{"type":"string","enum":["year","month","week","hour","variable"]},"payCurrency":{"type":"string","enum":["USD","AUD","BGN","BRL","CAD","CHF","CZK","DKK","EUR","GBP","HKD","HUF","IDR","INR","JPY","MYR","NOK","NZD","CNY","PLN","RON","TRY","SEK","SGD","AED","ARS","BDT","BWP","CLP","COP","CRC","EGP","FJD","GEL","GHS","ILS","KES","KRW","LKR","MAD","MXN","NPR","PHP","PKR","THB","UAH","UGX","UYU","VND","ZAR","ZMW","TND","NGN","RSD","TWD","GTQ","HNL","DOP","SAR","XAF","PEN"]},"payRate":{"type":"number","exclusiveMinimum":0,"description":"major units (dollars), e.g. 23.45"},"payType":{"anyOf":[{"anyOf":[{"type":"string","enum":["fixed","pay_as_you_go"]},{"type":"null"}]},{"type":"null"}]},"payVariableRate":{"anyOf":[{"anyOf":[{"type":"number","exclusiveMinimum":0,"description":"major units (dollars), e.g. 23.45"},{"type":"null"}]},{"type":"null"}]},"signOnBonus":{"anyOf":[{"anyOf":[{"type":"number","exclusiveMinimum":0,"description":"major units (dollars), e.g. 23.45"},{"type":"null"}]},{"type":"null"}]},"relocationBonus":{"anyOf":[{"anyOf":[{"type":"number","exclusiveMinimum":0,"description":"major units (dollars), e.g. 23.45"},{"type":"null"}]},{"type":"null"}]},"stockOptions":{"anyOf":[{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}]},{"type":"null"}]},"vestingScheduleMonths":{"anyOf":[{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}]},{"type":"null"}]},"cliffMonths":{"anyOf":[{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}]},{"type":"null"}]}},"required":["payBasis","payCurrency","payRate"],"additionalProperties":false},"expirationTime":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"null"}]},{"type":"null"}]},"backgroundCheckWorkLocation":{"anyOf":[{"anyOf":[{"type":"object","properties":{"country":{"type":"string"},"state":{"type":"string"},"city":{"type":"string"}},"required":["country","state","city"],"additionalProperties":false},{"type":"null"}]},{"type":"null"}]}},"required":["candidate","position","workerType","compensation"],"additionalProperties":false}}},"required":true}}},"/v1/offers/{id}/void":{"post":{"tags":["Offers"],"operationId":"Offers.void","parameters":[{"name":"id","in":"path","schema":{"type":"string","pattern":"^offr_","description":"The tag of the offer.","examples":["offr_1234"]},"required":true}],"security":[{"apiKey":[]}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","pattern":"^offr_","description":"The tag of the offer.","examples":["offr_1234"]},"status":{"type":"string","enum":["draft","sent","accepted","void","expired"]},"voidReason":{"anyOf":[{"anyOf":[{"type":"string","enum":["replaced","candidate_declined","other"]},{"type":"null"}]},{"type":"null"}],"description":"The reason the offer was voided. Null for offers that have not been voided."},"voidNotes":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"null"}]},{"type":"null"}],"description":"Additional notes explaining why the offer was voided."},"workerType":{"type":"string","enum":["employee","us_contractor","global_contractor"]},"candidate":{"type":"object","properties":{"firstName":{"type":"string","examples":["Jonathan"]},"lastName":{"type":"string","examples":["Galt"]},"email":{"type":"string","format":"email","title":"Email","description":"An email with a reasonably valid regex (based on RFC 5321 atext characters)","examples":["john@joinwarp.com"]},"contractorDetails":{"anyOf":[{"type":"object","properties":{"isBusiness":{"type":"boolean"},"legalBusinessName":{"anyOf":[{"type":"string"},{"type":"null"}],"examples":[null,"Galt Enterprises, LLC"]}},"required":["isBusiness","legalBusinessName"],"additionalProperties":false},{"type":"null"}]}},"required":["firstName","lastName","email","contractorDetails"],"additionalProperties":false},"position":{"type":"object","properties":{"title":{"type":"string","examples":["Research Engineer"]},"startDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"country":{"type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"scopeOfWork":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["title","startDate","country","scopeOfWork"],"additionalProperties":false},"department":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","pattern":"^dpt_","description":"The unique public id of the department","examples":["dpt_1234"]},"name":{"type":"string","examples":["Engineering"]}},"required":["id","name"],"additionalProperties":false},{"type":"null"}]},"workplace":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","pattern":"^wkp_","description":"Public workplace identifier","examples":["wkp_1234"]},"name":{"type":"string","examples":["New York Office"]}},"required":["id","name"],"additionalProperties":false},{"type":"null"}]},"manager":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","pattern":"^wrk_","description":"The id of the worker.","examples":["wrk_1234"]},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"examples":[null,"Dagny Taggart"]}},"required":["id","name"],"additionalProperties":false},{"type":"null"}]},"level":{"anyOf":[{"anyOf":[{"type":"object","properties":{"id":{"type":"string","pattern":"^jlvl_","description":"The unique public id of the job level","examples":["jlvl_1234"]},"code":{"type":"string"},"name":{"type":"string"},"track":{"type":"string","enum":["ic","manager","executive"]}},"required":["id","code","name","track"],"additionalProperties":false},{"type":"null"}]},{"type":"null"}],"description":"The offer's job level, or null if unassigned. Omitted when job levels are not enabled."},"sentBy":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Display name of the person or company that sent the offer. Null for offers not yet sent.","examples":[null,"Dagny Taggart","Galt Enterprises, LLC"]},"compensation":{"type":"object","properties":{"basePay":{"type":"object","properties":{"amount":{"$ref":"#/components/schemas/PublicMoneyAmount"},"basis":{"type":"string","enum":["year","month","week","hour","variable"]},"type":{"anyOf":[{"type":"string","enum":["fixed","pay_as_you_go"]},{"type":"null"}]},"variableRate":{"anyOf":[{"$ref":"#/components/schemas/PublicMoneyAmount"},{"type":"null"}]}},"required":["amount","basis","type","variableRate"],"additionalProperties":false},"signOnBonus":{"anyOf":[{"$ref":"#/components/schemas/PublicMoneyAmount"},{"type":"null"}]},"relocationBonus":{"anyOf":[{"$ref":"#/components/schemas/PublicMoneyAmount"},{"type":"null"}]},"stock":{"anyOf":[{"type":"object","properties":{"options":{"type":"integer","minimum":0},"vestingScheduleMonths":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}]},"cliffMonths":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}]}},"required":["options","vestingScheduleMonths","cliffMonths"],"additionalProperties":false},{"type":"null"}]}},"required":["basePay","signOnBonus","relocationBonus","stock"],"additionalProperties":false},"offerUrl":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The candidate-facing offer portal URL. Null for offers that have not been sent."},"expirationTime":{"anyOf":[{"type":"string"},{"type":"null"}]},"lastViewedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"createdAt":{"type":"string"}},"required":["id","status","workerType","candidate","position","department","workplace","manager","sentBy","compensation","offerUrl","expirationTime","lastViewedAt","createdAt"],"additionalProperties":false}}}},"401":{"description":"ApiKeyUnauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKeyUnauthorizedEncoded"}}}},"403":{"description":"MissingRequiredCompanyPermissions | ApiNotEnabled","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/MissingRequiredCompanyPermissionsEncoded"},{"$ref":"#/components/schemas/ApiNotEnabledEncoded"}]}}}},"404":{"description":"OfferNotFoundError","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OfferNotFoundErrorEncoded"}}}},"409":{"description":"InvalidOfferStatusError","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidOfferStatusErrorEncoded"}}}},"429":{"description":"RateLimitExceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitExceededEncoded"}}}},"500":{"description":"InternalServerError","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/effect_HttpApiError_InternalServerErrorEncoded"},{"$ref":"#/components/schemas/effect_HttpApiError_InternalServerErrorEncoded"}]}}}}},"description":"Void a previously sent offer. Only sent offers can be voided.","summary":"Void Offer","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"voidReason":{"type":"string","enum":["candidate_declined","other"]},"voidNotes":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"null"}]},{"type":"null"}]}},"required":["voidReason"],"additionalProperties":false}}},"required":true}}},"/v1/offers/{id}/extend-deadline":{"post":{"tags":["Offers"],"operationId":"Offers.extendDeadline","parameters":[{"name":"id","in":"path","schema":{"type":"string","pattern":"^offr_","description":"The tag of the offer.","examples":["offr_1234"]},"required":true}],"security":[{"apiKey":[]}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","pattern":"^offr_","description":"The tag of the offer.","examples":["offr_1234"]},"status":{"type":"string","enum":["draft","sent","accepted","void","expired"]},"voidReason":{"anyOf":[{"anyOf":[{"type":"string","enum":["replaced","candidate_declined","other"]},{"type":"null"}]},{"type":"null"}],"description":"The reason the offer was voided. Null for offers that have not been voided."},"voidNotes":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"null"}]},{"type":"null"}],"description":"Additional notes explaining why the offer was voided."},"workerType":{"type":"string","enum":["employee","us_contractor","global_contractor"]},"candidate":{"type":"object","properties":{"firstName":{"type":"string","examples":["Jonathan"]},"lastName":{"type":"string","examples":["Galt"]},"email":{"type":"string","format":"email","title":"Email","description":"An email with a reasonably valid regex (based on RFC 5321 atext characters)","examples":["john@joinwarp.com"]},"contractorDetails":{"anyOf":[{"type":"object","properties":{"isBusiness":{"type":"boolean"},"legalBusinessName":{"anyOf":[{"type":"string"},{"type":"null"}],"examples":[null,"Galt Enterprises, LLC"]}},"required":["isBusiness","legalBusinessName"],"additionalProperties":false},{"type":"null"}]}},"required":["firstName","lastName","email","contractorDetails"],"additionalProperties":false},"position":{"type":"object","properties":{"title":{"type":"string","examples":["Research Engineer"]},"startDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"country":{"type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"scopeOfWork":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["title","startDate","country","scopeOfWork"],"additionalProperties":false},"department":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","pattern":"^dpt_","description":"The unique public id of the department","examples":["dpt_1234"]},"name":{"type":"string","examples":["Engineering"]}},"required":["id","name"],"additionalProperties":false},{"type":"null"}]},"workplace":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","pattern":"^wkp_","description":"Public workplace identifier","examples":["wkp_1234"]},"name":{"type":"string","examples":["New York Office"]}},"required":["id","name"],"additionalProperties":false},{"type":"null"}]},"manager":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","pattern":"^wrk_","description":"The id of the worker.","examples":["wrk_1234"]},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"examples":[null,"Dagny Taggart"]}},"required":["id","name"],"additionalProperties":false},{"type":"null"}]},"level":{"anyOf":[{"anyOf":[{"type":"object","properties":{"id":{"type":"string","pattern":"^jlvl_","description":"The unique public id of the job level","examples":["jlvl_1234"]},"code":{"type":"string"},"name":{"type":"string"},"track":{"type":"string","enum":["ic","manager","executive"]}},"required":["id","code","name","track"],"additionalProperties":false},{"type":"null"}]},{"type":"null"}],"description":"The offer's job level, or null if unassigned. Omitted when job levels are not enabled."},"sentBy":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Display name of the person or company that sent the offer. Null for offers not yet sent.","examples":[null,"Dagny Taggart","Galt Enterprises, LLC"]},"compensation":{"type":"object","properties":{"basePay":{"type":"object","properties":{"amount":{"$ref":"#/components/schemas/PublicMoneyAmount"},"basis":{"type":"string","enum":["year","month","week","hour","variable"]},"type":{"anyOf":[{"type":"string","enum":["fixed","pay_as_you_go"]},{"type":"null"}]},"variableRate":{"anyOf":[{"$ref":"#/components/schemas/PublicMoneyAmount"},{"type":"null"}]}},"required":["amount","basis","type","variableRate"],"additionalProperties":false},"signOnBonus":{"anyOf":[{"$ref":"#/components/schemas/PublicMoneyAmount"},{"type":"null"}]},"relocationBonus":{"anyOf":[{"$ref":"#/components/schemas/PublicMoneyAmount"},{"type":"null"}]},"stock":{"anyOf":[{"type":"object","properties":{"options":{"type":"integer","minimum":0},"vestingScheduleMonths":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}]},"cliffMonths":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}]}},"required":["options","vestingScheduleMonths","cliffMonths"],"additionalProperties":false},{"type":"null"}]}},"required":["basePay","signOnBonus","relocationBonus","stock"],"additionalProperties":false},"offerUrl":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The candidate-facing offer portal URL. Null for offers that have not been sent."},"expirationTime":{"anyOf":[{"type":"string"},{"type":"null"}]},"lastViewedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"createdAt":{"type":"string"}},"required":["id","status","workerType","candidate","position","department","workplace","manager","sentBy","compensation","offerUrl","expirationTime","lastViewedAt","createdAt"],"additionalProperties":false}}}},"401":{"description":"ApiKeyUnauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKeyUnauthorizedEncoded"}}}},"403":{"description":"MissingRequiredCompanyPermissions | ApiNotEnabled","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/MissingRequiredCompanyPermissionsEncoded"},{"$ref":"#/components/schemas/ApiNotEnabledEncoded"}]}}}},"404":{"description":"OfferNotFoundError","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OfferNotFoundErrorEncoded"}}}},"409":{"description":"InvalidOfferStatusError","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidOfferStatusErrorEncoded"}}}},"422":{"description":"InvalidExpirationTimeError","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidExpirationTimeErrorEncoded"}}}},"429":{"description":"RateLimitExceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitExceededEncoded"}}}},"500":{"description":"InternalServerError","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/effect_HttpApiError_InternalServerErrorEncoded"},{"$ref":"#/components/schemas/effect_HttpApiError_InternalServerErrorEncoded"}]}}}}},"description":"Extend the expiration deadline of a sent offer.","summary":"Extend Offer Deadline","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"expirationTime":{"type":"string"}},"required":["expirationTime"],"additionalProperties":false}}},"required":true}}},"/v1/offers/{id}/resend":{"post":{"tags":["Offers"],"operationId":"Offers.resend","parameters":[{"name":"id","in":"path","schema":{"type":"string","pattern":"^offr_","description":"The tag of the offer.","examples":["offr_1234"]},"required":true}],"security":[{"apiKey":[]}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","pattern":"^offr_","description":"The tag of the offer.","examples":["offr_1234"]},"status":{"type":"string","enum":["draft","sent","accepted","void","expired"]},"voidReason":{"anyOf":[{"anyOf":[{"type":"string","enum":["replaced","candidate_declined","other"]},{"type":"null"}]},{"type":"null"}],"description":"The reason the offer was voided. Null for offers that have not been voided."},"voidNotes":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"null"}]},{"type":"null"}],"description":"Additional notes explaining why the offer was voided."},"workerType":{"type":"string","enum":["employee","us_contractor","global_contractor"]},"candidate":{"type":"object","properties":{"firstName":{"type":"string","examples":["Jonathan"]},"lastName":{"type":"string","examples":["Galt"]},"email":{"type":"string","format":"email","title":"Email","description":"An email with a reasonably valid regex (based on RFC 5321 atext characters)","examples":["john@joinwarp.com"]},"contractorDetails":{"anyOf":[{"type":"object","properties":{"isBusiness":{"type":"boolean"},"legalBusinessName":{"anyOf":[{"type":"string"},{"type":"null"}],"examples":[null,"Galt Enterprises, LLC"]}},"required":["isBusiness","legalBusinessName"],"additionalProperties":false},{"type":"null"}]}},"required":["firstName","lastName","email","contractorDetails"],"additionalProperties":false},"position":{"type":"object","properties":{"title":{"type":"string","examples":["Research Engineer"]},"startDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"country":{"type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"scopeOfWork":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["title","startDate","country","scopeOfWork"],"additionalProperties":false},"department":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","pattern":"^dpt_","description":"The unique public id of the department","examples":["dpt_1234"]},"name":{"type":"string","examples":["Engineering"]}},"required":["id","name"],"additionalProperties":false},{"type":"null"}]},"workplace":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","pattern":"^wkp_","description":"Public workplace identifier","examples":["wkp_1234"]},"name":{"type":"string","examples":["New York Office"]}},"required":["id","name"],"additionalProperties":false},{"type":"null"}]},"manager":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","pattern":"^wrk_","description":"The id of the worker.","examples":["wrk_1234"]},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"examples":[null,"Dagny Taggart"]}},"required":["id","name"],"additionalProperties":false},{"type":"null"}]},"level":{"anyOf":[{"anyOf":[{"type":"object","properties":{"id":{"type":"string","pattern":"^jlvl_","description":"The unique public id of the job level","examples":["jlvl_1234"]},"code":{"type":"string"},"name":{"type":"string"},"track":{"type":"string","enum":["ic","manager","executive"]}},"required":["id","code","name","track"],"additionalProperties":false},{"type":"null"}]},{"type":"null"}],"description":"The offer's job level, or null if unassigned. Omitted when job levels are not enabled."},"sentBy":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Display name of the person or company that sent the offer. Null for offers not yet sent.","examples":[null,"Dagny Taggart","Galt Enterprises, LLC"]},"compensation":{"type":"object","properties":{"basePay":{"type":"object","properties":{"amount":{"$ref":"#/components/schemas/PublicMoneyAmount"},"basis":{"type":"string","enum":["year","month","week","hour","variable"]},"type":{"anyOf":[{"type":"string","enum":["fixed","pay_as_you_go"]},{"type":"null"}]},"variableRate":{"anyOf":[{"$ref":"#/components/schemas/PublicMoneyAmount"},{"type":"null"}]}},"required":["amount","basis","type","variableRate"],"additionalProperties":false},"signOnBonus":{"anyOf":[{"$ref":"#/components/schemas/PublicMoneyAmount"},{"type":"null"}]},"relocationBonus":{"anyOf":[{"$ref":"#/components/schemas/PublicMoneyAmount"},{"type":"null"}]},"stock":{"anyOf":[{"type":"object","properties":{"options":{"type":"integer","minimum":0},"vestingScheduleMonths":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}]},"cliffMonths":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}]}},"required":["options","vestingScheduleMonths","cliffMonths"],"additionalProperties":false},{"type":"null"}]}},"required":["basePay","signOnBonus","relocationBonus","stock"],"additionalProperties":false},"offerUrl":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The candidate-facing offer portal URL. Null for offers that have not been sent."},"expirationTime":{"anyOf":[{"type":"string"},{"type":"null"}]},"lastViewedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"createdAt":{"type":"string"}},"required":["id","status","workerType","candidate","position","department","workplace","manager","sentBy","compensation","offerUrl","expirationTime","lastViewedAt","createdAt"],"additionalProperties":false}}}},"401":{"description":"ApiKeyUnauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKeyUnauthorizedEncoded"}}}},"403":{"description":"MissingRequiredCompanyPermissions | ApiNotEnabled","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/MissingRequiredCompanyPermissionsEncoded"},{"$ref":"#/components/schemas/ApiNotEnabledEncoded"}]}}}},"404":{"description":"OfferNotFoundError","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OfferNotFoundErrorEncoded"}}}},"409":{"description":"InvalidOfferStatusError","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidOfferStatusErrorEncoded"}}}},"429":{"description":"RateLimitExceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitExceededEncoded"}}}},"500":{"description":"InternalServerError","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/effect_HttpApiError_InternalServerErrorEncoded"},{"$ref":"#/components/schemas/effect_HttpApiError_InternalServerErrorEncoded"}]}}}}},"description":"Resend the offer email to the candidate for a sent offer.","summary":"Resend Offer"}},"/v1/pay_rates":{"get":{"tags":["Pay Rates"],"operationId":"Pay Rates.list","parameters":[{"name":"limit","in":"query","schema":{"anyOf":[{"type":"string"},{"type":"null"}]},"required":true},{"name":"afterId","in":"query","schema":{"anyOf":[{"type":"string","pattern":"^pyr_","description":"The tag of the pay rate.","examples":["pyr_1234"]},{"type":"null"}]},"required":false},{"name":"beforeId","in":"query","schema":{"anyOf":[{"type":"string","pattern":"^pyr_","description":"The tag of the pay rate.","examples":["pyr_1234"]},{"type":"null"}]},"required":false},{"name":"workerId","in":"query","schema":{"anyOf":[{"type":"string","pattern":"^wrk_","description":"The id of the worker.","examples":["wrk_1234"]},{"type":"null"}],"description":"Only return pay rates assigned to this worker."},"required":false},{"name":"effectiveOnOrAfter","in":"query","schema":{"anyOf":[{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},{"type":"null"}],"description":"Only return pay rates whose effective start date is on or after this date."},"required":false},{"name":"effectiveBefore","in":"query","schema":{"anyOf":[{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},{"type":"null"}],"description":"Only return pay rates whose effective start date is before this date."},"required":false},{"name":"type","in":"query","schema":{"anyOf":[{"$ref":"#/components/schemas/PublicPayRateType"},{"type":"null"}],"description":"Only return regular or additional pay rates of this type."},"required":false}],"security":[{"apiKey":[]}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"hasMore":{"type":"boolean"},"count":{"type":"integer"},"data":{"type":"array","items":{"$ref":"#/components/schemas/PublicPayRate"}}},"required":["hasMore","count","data"],"additionalProperties":false}}}},"401":{"description":"ApiKeyUnauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKeyUnauthorizedEncoded"}}}},"403":{"description":"MissingRequiredCompanyPermissions | ApiNotEnabled","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/MissingRequiredCompanyPermissionsEncoded"},{"$ref":"#/components/schemas/ApiNotEnabledEncoded"}]}}}},"429":{"description":"RateLimitExceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitExceededEncoded"}}}},"500":{"description":"InternalServerError","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/effect_HttpApiError_InternalServerErrorEncoded"},{"$ref":"#/components/schemas/effect_HttpApiError_InternalServerErrorEncoded"}]}}}}},"description":"List pay rates visible to the API key. Results may be filtered by worker, effective start date, or regular/additional type. US and global worker rates require their corresponding compensation read scopes.","summary":"List Pay Rates"}},"/v1/pay_rates/{id}":{"get":{"tags":["Pay Rates"],"operationId":"Pay Rates.get","parameters":[{"name":"id","in":"path","schema":{"type":"string","pattern":"^pyr_","description":"The tag of the pay rate.","examples":["pyr_1234"]},"required":true}],"security":[{"apiKey":[]}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicPayRate"}}}},"401":{"description":"ApiKeyUnauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKeyUnauthorizedEncoded"}}}},"403":{"description":"MissingRequiredCompanyPermissions | ApiNotEnabled","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/MissingRequiredCompanyPermissionsEncoded"},{"$ref":"#/components/schemas/ApiNotEnabledEncoded"}]}}}},"404":{"description":"The specified pay rate could not be found or is not visible to this API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayRateNotFoundErrorEncoded"}}}},"429":{"description":"RateLimitExceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitExceededEncoded"}}}},"500":{"description":"InternalServerError","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/effect_HttpApiError_InternalServerErrorEncoded"},{"$ref":"#/components/schemas/effect_HttpApiError_InternalServerErrorEncoded"}]}}}}},"description":"Get a specific pay rate by id. The API key must have the compensation read scope corresponding to the worker.","summary":"Get Pay Rate"}},"/v1/pay_rates/regular":{"post":{"tags":["Pay Rates"],"operationId":"Pay Rates.createRegular","parameters":[],"security":[{"apiKey":[]}],"responses":{"201":{"description":"PublicCreateRegularPayRateResponse","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicCreateRegularPayRateResponse"}}}},"400":{"description":"The worker already has a future regular pay rate. | An inactive worker pay rate must begin on the worker start date. | The pay rate effective date cannot precede the worker start date. | An hourly pay rate must specify whether hours submission is required. | A fixed regular pay rate requires an amount. | A currency change must begin on the current pay period or an allowed worker start date.","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/PayRateFutureRateAlreadyExistsEncoded"},{"$ref":"#/components/schemas/PayRateInactiveEffectiveDateMismatchEncoded"},{"$ref":"#/components/schemas/PayRateEffectiveDateBeforeStartEncoded"},{"$ref":"#/components/schemas/PayRateHoursSubmissionRequiredEncoded"},{"$ref":"#/components/schemas/PayRateAmountRequiredEncoded"},{"$ref":"#/components/schemas/PayRateCurrencyChangeEffectiveDateInvalidEncoded"}]}}}},"401":{"description":"ApiKeyUnauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKeyUnauthorizedEncoded"}}}},"403":{"description":"MissingRequiredCompanyPermissions | ApiNotEnabled","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/MissingRequiredCompanyPermissionsEncoded"},{"$ref":"#/components/schemas/ApiNotEnabledEncoded"}]}}}},"404":{"description":"The specified worker could not be found in the API key company.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicPayRateWorkerNotFoundErrorEncoded"}}}},"429":{"description":"RateLimitExceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitExceededEncoded"}}}},"500":{"description":"InternalServerError","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/effect_HttpApiError_InternalServerErrorEncoded"},{"$ref":"#/components/schemas/effect_HttpApiError_InternalServerErrorEncoded"}]}}}}},"description":"Create an effective-dated regular pay rate for a worker. The API key must have the compensation write scope corresponding to the worker classification. Fixed rates require a nonnegative integer amount in minor currency units, and writes accept only currencies with exactly two ISO 4217 minor-unit digits. Amount is required except for variable pay, and requireHoursSubmission is required for hourly pay. An inactive worker’s rate must start on the worker start date; an active worker’s rate must start on or after that date. An existing future rate blocks creation except for a same-start-date replacement. Currency changes must begin at the current pay-period start, or at the worker start date when the worker is inactive, is a pay-as-you-go contractor, or has a future start date. Variable pay returns a null id and stores no fixed pay-rate row. Replacing a fixed row on the same date emits separate deleted and created webhooks; delivery order is not guaranteed. Creating a fixed rate over variable pay emits only the created webhook because no fixed row existed to delete. There is no pay-rate update event.","summary":"Create Regular Pay Rate","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicCreateRegularPayRate"}}},"required":true}},"delete":{"tags":["Pay Rates"],"operationId":"Pay Rates.deleteRegular","parameters":[],"security":[{"apiKey":[]}],"responses":{"204":{"description":"<No Content>"},"400":{"description":"Only a future regular pay rate can be deleted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayRateDeleteEffectiveDateNotFutureEncoded"}}}},"401":{"description":"ApiKeyUnauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKeyUnauthorizedEncoded"}}}},"403":{"description":"MissingRequiredCompanyPermissions | ApiNotEnabled","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/MissingRequiredCompanyPermissionsEncoded"},{"$ref":"#/components/schemas/ApiNotEnabledEncoded"}]}}}},"404":{"description":"The specified worker could not be found in the API key company. | No future regular pay rate exists for the specified worker and effective date.","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/PublicPayRateWorkerNotFoundErrorEncoded"},{"$ref":"#/components/schemas/PublicRegularPayRateNotFoundErrorEncoded"}]}}}},"429":{"description":"RateLimitExceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitExceededEncoded"}}}},"500":{"description":"InternalServerError","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/effect_HttpApiError_InternalServerErrorEncoded"},{"$ref":"#/components/schemas/effect_HttpApiError_InternalServerErrorEncoded"}]}}}}},"description":"Delete a regular pay rate or variable-pay boundary identified by worker and effective date. The effective date must be strictly after the current UTC date. The API key must have the compensation write scope corresponding to the worker classification. Deletion reopens the predecessor through the deleted range, including when deleting a variable-pay boundary. There is no public PATCH or PUT pay-rate update operation; replace a same-date rate by creating its replacement.","summary":"Delete Future Regular Pay Rate","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicDeleteRegularPayRate"}}},"required":true}}},"/v1/pay_splits":{"get":{"tags":["Pay Splits"],"operationId":"Pay Splits.list","parameters":[{"name":"limit","in":"query","schema":{"anyOf":[{"type":"string"},{"type":"null"}]},"required":true},{"name":"afterId","in":"query","schema":{"anyOf":[{"type":"string","pattern":"^nps_","description":"The tag of the bank account pay split.","examples":["nps_1234"]},{"type":"null"}]},"required":false},{"name":"beforeId","in":"query","schema":{"anyOf":[{"type":"string","pattern":"^nps_","description":"The tag of the bank account pay split.","examples":["nps_1234"]},{"type":"null"}]},"required":false},{"name":"workerIds","in":"query","schema":{"anyOf":[{"type":"array","items":{"type":"string","pattern":"^wrk_","description":"The id of the worker.","examples":["wrk_1234"]},"minItems":1},{"type":"null"}],"description":"Worker IDs as repeated parameters. Omit for all workers. Unknown or foreign IDs contribute no matches."},"required":false},{"name":"types","in":"query","schema":{"anyOf":[{"type":"array","items":{"$ref":"#/components/schemas/PublicPaySplitType"},"minItems":1},{"type":"null"}],"description":"Configuration types as repeated parameters. Omit for all types."},"required":false},{"name":"statuses","in":"query","schema":{"anyOf":[{"type":"array","items":{"$ref":"#/components/schemas/PublicPaySplitStatus"},"minItems":1},{"type":"null"}],"description":"Statuses as repeated parameters. Defaults to active; explicitly request inactive or both to include retained configurations.","default":["active"]},"required":true}],"security":[{"apiKey":[]}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"hasMore":{"type":"boolean"},"count":{"type":"integer"},"data":{"type":"array","items":{"$ref":"#/components/schemas/PublicPaySplit"}}},"required":["hasMore","count","data"],"additionalProperties":false}}}},"400":{"description":"The pay split query contains an invalid cursor or cursor combination.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidPaySplitQueryEncoded"}}}},"401":{"description":"ApiKeyUnauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKeyUnauthorizedEncoded"}}}},"403":{"description":"MissingRequiredCompanyPermissions | ApiNotEnabled","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/MissingRequiredCompanyPermissionsEncoded"},{"$ref":"#/components/schemas/ApiNotEnabledEncoded"}]}}}},"429":{"description":"RateLimitExceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitExceededEncoded"}}}},"500":{"description":"InternalServerError","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/effect_HttpApiError_InternalServerErrorEncoded"},{"$ref":"#/components/schemas/effect_HttpApiError_InternalServerErrorEncoded"}]}}}}},"description":"List stored pay-split configurations, newest first. Defaults to active. Requires workers banking and profile read scopes plus the applicable US or global compensation read scope.","summary":"List pay splits"}},"/v1/pay_splits/{id}":{"get":{"tags":["Pay Splits"],"operationId":"Pay Splits.get","parameters":[{"name":"id","in":"path","schema":{"type":"string","pattern":"^nps_","description":"The tag of the bank account pay split.","examples":["nps_1234"]},"required":true}],"security":[{"apiKey":[]}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicPaySplit"}}}},"401":{"description":"ApiKeyUnauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKeyUnauthorizedEncoded"}}}},"403":{"description":"MissingRequiredCompanyPermissions | ApiNotEnabled","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/MissingRequiredCompanyPermissionsEncoded"},{"$ref":"#/components/schemas/ApiNotEnabledEncoded"}]}}}},"404":{"description":"The pay split could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaySplitNotFoundEncoded"}}}},"429":{"description":"RateLimitExceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitExceededEncoded"}}}},"500":{"description":"InternalServerError","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/effect_HttpApiError_InternalServerErrorEncoded"},{"$ref":"#/components/schemas/effect_HttpApiError_InternalServerErrorEncoded"}]}}}}},"description":"Get a stored pay-split configuration, including retained inactive configurations. Requires workers banking and profile read scopes plus the applicable US or global compensation read scope.","summary":"Get pay split"}},"/v1/payrolls":{"get":{"tags":["Payroll"],"operationId":"Payroll.listPayrolls","parameters":[{"name":"limit","in":"query","schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The maximum number of payrolls to return, from 1 to 50.","examples":["25"]},"required":true,"description":"The maximum number of payrolls to return, from 1 to 50.","example":"25"},{"name":"afterId","in":"query","schema":{"anyOf":[{"type":"string","pattern":"^pay_","description":"Return payrolls after this payroll ID in the stable cursor order. Cannot be used with beforeId.","examples":["pay_1234"]},{"type":"null"}]},"required":false,"description":"Return payrolls after this payroll ID in the stable cursor order. Cannot be used with beforeId.","example":"pay_1234"},{"name":"beforeId","in":"query","schema":{"anyOf":[{"type":"string","pattern":"^pay_","description":"Return payrolls before this payroll ID in the stable cursor order. Cannot be used with afterId.","examples":["pay_1234"]},{"type":"null"}]},"required":false,"description":"Return payrolls before this payroll ID in the stable cursor order. Cannot be used with afterId.","example":"pay_1234"},{"name":"types","in":"query","schema":{"anyOf":[{"type":"array","items":{"$ref":"#/components/schemas/PublicPayrollType"},"description":"Payroll calculation types to include.","examples":[["us"]]},{"type":"null"}]},"required":false,"description":"Payroll calculation types to include.","example":["us"]},{"name":"subtypes","in":"query","schema":{"anyOf":[{"type":"array","items":{"$ref":"#/components/schemas/PublicPayrollSubtype"},"description":"Payroll subtypes to include.","examples":[["regular"]]},{"type":"null"}]},"required":false,"description":"Payroll subtypes to include.","example":["regular"]},{"name":"statuses","in":"query","schema":{"anyOf":[{"type":"array","items":{"$ref":"#/components/schemas/PublicPayrollStatus"},"description":"Lifecycle statuses to include. Omit to include every status.","examples":[["processing"]]},{"type":"null"}]},"required":false,"description":"Lifecycle statuses to include. Omit to include every status.","example":["processing"]},{"name":"payFrequencies","in":"query","schema":{"anyOf":[{"type":"array","items":{"$ref":"#/components/schemas/PublicPayFrequency"},"description":"Pay cadences to include.","examples":[["semimonthly"]]},{"type":"null"}]},"required":false,"description":"Pay cadences to include.","example":["semimonthly"]},{"name":"paydayOnOrAfter","in":"query","schema":{"anyOf":[{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},{"type":"null"}]},"required":false,"description":"Inclusive start of the half-open payday range.","example":"2026-08-01"},{"name":"paydayBefore","in":"query","schema":{"anyOf":[{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},{"type":"null"}]},"required":false,"description":"Exclusive end of the half-open payday range.","example":"2026-09-01"},{"name":"payPeriodEndOnOrAfter","in":"query","schema":{"anyOf":[{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},{"type":"null"}]},"required":false,"description":"Inclusive start of the half-open pay-period-end range.","example":"2026-08-01"},{"name":"payPeriodEndBefore","in":"query","schema":{"anyOf":[{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},{"type":"null"}]},"required":false,"description":"Exclusive end of the half-open pay-period-end range.","example":"2026-09-01"}],"security":[{"apiKey":[]}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicPayrollListResponse"}}}},"400":{"description":"The payroll query contains an invalid range or cursor combination.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidPayrollQueryErrorEncoded"}}}},"401":{"description":"ApiKeyUnauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKeyUnauthorizedEncoded"}}}},"403":{"description":"MissingRequiredCompanyPermissions | ApiNotEnabled","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/MissingRequiredCompanyPermissionsEncoded"},{"$ref":"#/components/schemas/ApiNotEnabledEncoded"}]}}}},"429":{"description":"RateLimitExceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitExceededEncoded"}}}},"500":{"description":"InternalServerError","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/effect_HttpApiError_InternalServerErrorEncoded"},{"$ref":"#/components/schemas/effect_HttpApiError_InternalServerErrorEncoded"}]}}}}},"description":"List payroll summaries newest first with stable cursor ordering. Every amount in totals is expressed in fundingCurrency, the currency the employer uses to fund the payroll. Line-derived categories are converted and rounded per paycheck before aggregation, while netPay remains provider-authoritative. Payroll type visibility follows the API key permissions. All lifecycle statuses are included unless statuses are provided.","summary":"List Payrolls"}},"/v1/payrolls/{id}":{"get":{"tags":["Payroll"],"operationId":"Payroll.getPayroll","parameters":[{"name":"id","in":"path","schema":{"type":"string","pattern":"^pay_","description":"The payroll ID.","examples":["pay_1234"]},"required":true,"description":"The payroll ID.","example":"pay_1234"}],"security":[{"apiKey":[]}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicPayrollDetail"}}}},"401":{"description":"ApiKeyUnauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKeyUnauthorizedEncoded"}}}},"403":{"description":"MissingRequiredCompanyPermissions | ApiNotEnabled","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/MissingRequiredCompanyPermissionsEncoded"},{"$ref":"#/components/schemas/ApiNotEnabledEncoded"}]}}}},"404":{"description":"The specified payroll could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayrollNotFoundErrorEncoded"}}}},"429":{"description":"RateLimitExceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitExceededEncoded"}}}},"500":{"description":"InternalServerError","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/effect_HttpApiError_InternalServerErrorEncoded"},{"$ref":"#/components/schemas/effect_HttpApiError_InternalServerErrorEncoded"}]}}}}},"description":"Get a payroll by id. Every amount in totals is expressed in fundingCurrency, the currency the employer uses to fund the payroll. Line-derived categories are converted and rounded per paycheck before aggregation, while netPay remains provider-authoritative. Missing, foreign, unauthorized, or unavailable payrolls return 404.","summary":"Get Payroll"}},"/v1/paychecks":{"get":{"tags":["Payroll"],"operationId":"Payroll.listPaychecks","parameters":[{"name":"limit","in":"query","schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The maximum number of paychecks to return, from 1 to 50.","examples":["25"]},"required":true,"description":"The maximum number of paychecks to return, from 1 to 50.","example":"25"},{"name":"afterId","in":"query","schema":{"anyOf":[{"type":"string","pattern":"^pyc_","description":"Return paychecks after this paycheck ID in the stable cursor order. Cannot be used with beforeId.","examples":["pyc_1234"]},{"type":"null"}]},"required":false,"description":"Return paychecks after this paycheck ID in the stable cursor order. Cannot be used with beforeId.","example":"pyc_1234"},{"name":"beforeId","in":"query","schema":{"anyOf":[{"type":"string","pattern":"^pyc_","description":"Return paychecks before this paycheck ID in the stable cursor order. Cannot be used with afterId.","examples":["pyc_1234"]},{"type":"null"}]},"required":false,"description":"Return paychecks before this paycheck ID in the stable cursor order. Cannot be used with afterId.","example":"pyc_1234"},{"name":"payrollIds","in":"query","schema":{"anyOf":[{"type":"array","items":{"type":"string","pattern":"^pay_","description":"The tag of the payroll.","examples":["pay_1234"]},"description":"Payrolls whose paychecks should be included.","examples":[["pay_1234"]]},{"type":"null"}]},"required":false,"description":"Payrolls whose paychecks should be included.","example":["pay_1234"]},{"name":"workerIds","in":"query","schema":{"anyOf":[{"type":"array","items":{"type":"string","pattern":"^wrk_","description":"The worker id.","examples":["wrk_1234"]},"description":"Workers whose paychecks should be included.","examples":[["wrk_1234"]]},{"type":"null"}]},"required":false,"description":"Workers whose paychecks should be included.","example":["wrk_1234"]},{"name":"workerTypes","in":"query","schema":{"anyOf":[{"type":"array","items":{"type":"string","enum":["us_w2","us_1099","global_contractor","eor_employee"]},"description":"Worker classifications in effect for the paycheck to include. Omit to include every worker type visible to the API key.","examples":[["us_w2"]]},{"type":"null"}]},"required":false,"description":"Worker classifications in effect for the paycheck to include. Omit to include every worker type visible to the API key.","example":["us_w2"]},{"name":"payrollTypes","in":"query","schema":{"anyOf":[{"type":"array","items":{"$ref":"#/components/schemas/PublicPayrollType"},"description":"Payroll calculation types to include, subject to the API key permissions.","examples":[["us"]]},{"type":"null"}]},"required":false,"description":"Payroll calculation types to include, subject to the API key permissions.","example":["us"]},{"name":"statuses","in":"query","schema":{"anyOf":[{"type":"array","items":{"$ref":"#/components/schemas/PublicPaycheckStatus"},"description":"Lifecycle statuses to include. Omit to include every status.","examples":[["processing"]]},{"type":"null"}]},"required":false,"description":"Lifecycle statuses to include. Omit to include every status.","example":["processing"]},{"name":"paymentMethods","in":"query","schema":{"anyOf":[{"type":"array","items":{"$ref":"#/components/schemas/PublicPaycheckPaymentMethod"},"description":"Payment methods to include.","examples":[["direct_deposit"]]},{"type":"null"}]},"required":false,"description":"Payment methods to include.","example":["direct_deposit"]},{"name":"compensationCurrencies","in":"query","schema":{"anyOf":[{"type":"array","items":{"$ref":"#/components/schemas/PublicPayrollCurrency"},"description":"Paycheck compensation currencies to include.","examples":[["USD"]]},{"type":"null"}]},"required":false,"description":"Paycheck compensation currencies to include.","example":["USD"]},{"name":"payFrequencies","in":"query","schema":{"anyOf":[{"type":"array","items":{"$ref":"#/components/schemas/PublicPayFrequency"},"description":"Pay cadences to include.","examples":[["semimonthly"]]},{"type":"null"}]},"required":false,"description":"Pay cadences to include.","example":["semimonthly"]},{"name":"paydayOnOrAfter","in":"query","schema":{"anyOf":[{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},{"type":"null"}]},"required":false,"description":"Inclusive start of the half-open payday range.","example":"2026-08-01"},{"name":"paydayBefore","in":"query","schema":{"anyOf":[{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},{"type":"null"}]},"required":false,"description":"Exclusive end of the half-open payday range.","example":"2026-09-01"}],"security":[{"apiKey":[]}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicPaycheckListResponse"}}}},"400":{"description":"The payroll query contains an invalid range or cursor combination.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidPayrollQueryErrorEncoded"}}}},"401":{"description":"ApiKeyUnauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKeyUnauthorizedEncoded"}}}},"403":{"description":"MissingRequiredCompanyPermissions | ApiNotEnabled","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/MissingRequiredCompanyPermissionsEncoded"},{"$ref":"#/components/schemas/ApiNotEnabledEncoded"}]}}}},"429":{"description":"RateLimitExceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitExceededEncoded"}}}},"500":{"description":"InternalServerError","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/effect_HttpApiError_InternalServerErrorEncoded"},{"$ref":"#/components/schemas/effect_HttpApiError_InternalServerErrorEncoded"}]}}}}},"description":"List per-worker paycheck summaries newest first with stable cursor ordering. By default, the response includes every worker type visible to the API key, including US W-2 employees, US 1099 contractors, and global contractors; use workerTypes to narrow the results. Payroll type visibility follows the API key permissions. All lifecycle statuses are included unless statuses are provided.","summary":"List Paychecks"}},"/v1/paychecks/{id}":{"get":{"tags":["Payroll"],"operationId":"Payroll.getPaycheck","parameters":[{"name":"id","in":"path","schema":{"type":"string","pattern":"^pyc_","description":"The paycheck ID.","examples":["pyc_1234"]},"required":true,"description":"The paycheck ID.","example":"pyc_1234"}],"security":[{"apiKey":[]}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicPaycheckDetail"}}}},"401":{"description":"ApiKeyUnauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKeyUnauthorizedEncoded"}}}},"403":{"description":"MissingRequiredCompanyPermissions | ApiNotEnabled","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/MissingRequiredCompanyPermissionsEncoded"},{"$ref":"#/components/schemas/ApiNotEnabledEncoded"}]}}}},"404":{"description":"The specified paycheck could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaycheckNotFoundErrorEncoded"}}}},"429":{"description":"RateLimitExceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitExceededEncoded"}}}},"500":{"description":"InternalServerError","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/effect_HttpApiError_InternalServerErrorEncoded"},{"$ref":"#/components/schemas/effect_HttpApiError_InternalServerErrorEncoded"}]}}}}},"description":"Get a paycheck by id. All worker types use the same paycheck schema. Categories that do not apply to a worker are represented by zero-valued totals and empty line-item arrays. For example, a US 1099 contractor with no applicable payroll taxes returns zero `workerTaxes` and `employerTaxes` totals and an empty `taxes` array. Missing, foreign, unauthorized, or unavailable paychecks return 404.","summary":"Get Paycheck"}},"/v1/time_off/policies":{"get":{"tags":["Time Off"],"operationId":"Time Off.getPolicies","parameters":[{"name":"limit","in":"query","schema":{"anyOf":[{"type":"string"},{"type":"null"}]},"required":true},{"name":"afterId","in":"query","schema":{"anyOf":[{"type":"string","pattern":"^top_","examples":["top_1234"]},{"type":"null"}]},"required":false},{"name":"beforeId","in":"query","schema":{"anyOf":[{"type":"string","pattern":"^top_","examples":["top_1234"]},{"type":"null"}]},"required":false}],"security":[{"apiKey":[]}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"hasMore":{"type":"boolean"},"count":{"type":"integer"},"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","pattern":"^top_","examples":["top_1234"]},"timeOffTypeId":{"type":"string","pattern":"^tot_","examples":["tot_1234"]},"timeOffTypeName":{"type":"string","examples":["Vacation","Sick Leave","Work from home","Maternity Leave"]},"paid":{"type":"boolean"},"isUnlimited":{"type":"boolean"},"schedule":{"type":"string","enum":["per_hour_worked","monthly","yearly","unlimited"]},"unit":{"type":"string","enum":["hour","day"]},"name":{"type":"string","examples":["Company-Wide Vacation Policy","Contractor Sick Leave Policy"]},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"examples":["Vacation policy for the whole company","Contractor Sick Leave Policy"]},"hoursWorkedPerChunk":{"anyOf":[{"anyOf":[{"type":"number"},{"type":"string","enum":["Infinity","-Infinity","NaN"]}]},{"type":"null"}]},"minutesPerChunk":{"anyOf":[{"anyOf":[{"type":"number"},{"type":"string","enum":["Infinity","-Infinity","NaN"]}]},{"type":"null"}]},"minutesPerPeriod":{"anyOf":[{"anyOf":[{"type":"number"},{"type":"string","enum":["Infinity","-Infinity","NaN"]}]},{"type":"null"}]}},"required":["id","timeOffTypeId","timeOffTypeName","paid","isUnlimited","schedule","unit","name","description","hoursWorkedPerChunk","minutesPerChunk","minutesPerPeriod"],"additionalProperties":false}}},"required":["hasMore","count","data"],"additionalProperties":false}}}},"401":{"description":"ApiKeyUnauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKeyUnauthorizedEncoded"}}}},"403":{"description":"MissingRequiredCompanyPermissions | ApiNotEnabled","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/MissingRequiredCompanyPermissionsEncoded"},{"$ref":"#/components/schemas/ApiNotEnabledEncoded"}]}}}},"404":{"description":"TimeOffPolicyNotFound","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TimeOffPolicyNotFoundEncoded"}}}},"429":{"description":"RateLimitExceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitExceededEncoded"}}}},"500":{"description":"InternalServerError","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/effect_HttpApiError_InternalServerErrorEncoded"},{"$ref":"#/components/schemas/effect_HttpApiError_InternalServerErrorEncoded"}]}}}}},"description":"Get the time off policies for your company","summary":"List Time Off Policies"}},"/v1/time_off/policies/{id}":{"get":{"tags":["Time Off"],"operationId":"Time Off.getPolicy","parameters":[{"name":"id","in":"path","schema":{"type":"string","pattern":"^top_","examples":["top_1234"]},"required":true}],"security":[{"apiKey":[]}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","pattern":"^top_","examples":["top_1234"]},"timeOffTypeId":{"type":"string","pattern":"^tot_","examples":["tot_1234"]},"timeOffTypeName":{"type":"string","examples":["Vacation","Sick Leave","Work from home","Maternity Leave"]},"paid":{"type":"boolean"},"isUnlimited":{"type":"boolean"},"schedule":{"type":"string","enum":["per_hour_worked","monthly","yearly","unlimited"]},"unit":{"type":"string","enum":["hour","day"]},"name":{"type":"string","examples":["Company-Wide Vacation Policy","Contractor Sick Leave Policy"]},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"examples":["Vacation policy for the whole company","Contractor Sick Leave Policy"]},"hoursWorkedPerChunk":{"anyOf":[{"anyOf":[{"type":"number"},{"type":"string","enum":["Infinity","-Infinity","NaN"]}]},{"type":"null"}]},"minutesPerChunk":{"anyOf":[{"anyOf":[{"type":"number"},{"type":"string","enum":["Infinity","-Infinity","NaN"]}]},{"type":"null"}]},"minutesPerPeriod":{"anyOf":[{"anyOf":[{"type":"number"},{"type":"string","enum":["Infinity","-Infinity","NaN"]}]},{"type":"null"}]}},"required":["id","timeOffTypeId","timeOffTypeName","paid","isUnlimited","schedule","unit","name","description","hoursWorkedPerChunk","minutesPerChunk","minutesPerPeriod"],"additionalProperties":false}}}},"401":{"description":"ApiKeyUnauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKeyUnauthorizedEncoded"}}}},"403":{"description":"MissingRequiredCompanyPermissions | ApiNotEnabled","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/MissingRequiredCompanyPermissionsEncoded"},{"$ref":"#/components/schemas/ApiNotEnabledEncoded"}]}}}},"404":{"description":"TimeOffPolicyNotFound","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TimeOffPolicyNotFoundEncoded"}}}},"429":{"description":"RateLimitExceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitExceededEncoded"}}}},"500":{"description":"InternalServerError","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/effect_HttpApiError_InternalServerErrorEncoded"},{"$ref":"#/components/schemas/effect_HttpApiError_InternalServerErrorEncoded"}]}}}}},"description":"Get a specific time off policy by id","summary":"Get Time Off Policy"}},"/v1/time_off/assignments":{"get":{"tags":["Time Off"],"operationId":"Time Off.getAssignments","parameters":[{"name":"limit","in":"query","schema":{"anyOf":[{"type":"string"},{"type":"null"}]},"required":true},{"name":"afterId","in":"query","schema":{"anyOf":[{"type":"string","pattern":"^wrkasn_","description":"The external-facing id of the worker assignment.","examples":["wrkasn_1234"]},{"type":"null"}]},"required":false},{"name":"beforeId","in":"query","schema":{"anyOf":[{"type":"string","pattern":"^wrkasn_","description":"The external-facing id of the worker assignment.","examples":["wrkasn_1234"]},{"type":"null"}]},"required":false},{"name":"policyIds","in":"query","schema":{"anyOf":[{"type":"array","items":{"type":"string","pattern":"^top_","examples":["top_1234"]}},{"type":"null"}]},"required":false},{"name":"workerIds","in":"query","schema":{"anyOf":[{"type":"array","items":{"type":"string","pattern":"^wrk_","description":"The id of the worker.","examples":["wrk_1234"]}},{"type":"null"}]},"required":false}],"security":[{"apiKey":[]}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"hasMore":{"type":"boolean"},"count":{"type":"integer"},"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","pattern":"^wrkasn_","description":"The external-facing id of the worker assignment.","examples":["wrkasn_1234"]},"policyId":{"type":"string","pattern":"^top_","examples":["top_1234"]},"workerId":{"type":"string","pattern":"^wrk_","description":"The id of the worker.","examples":["wrk_1234"]},"assignedAt":{"type":"string"}},"required":["id","policyId","workerId","assignedAt"],"additionalProperties":false}}},"required":["hasMore","count","data"],"additionalProperties":false}}}},"401":{"description":"ApiKeyUnauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKeyUnauthorizedEncoded"}}}},"403":{"description":"MissingRequiredCompanyPermissions | ApiNotEnabled","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/MissingRequiredCompanyPermissionsEncoded"},{"$ref":"#/components/schemas/ApiNotEnabledEncoded"}]}}}},"429":{"description":"RateLimitExceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitExceededEncoded"}}}},"500":{"description":"InternalServerError","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/effect_HttpApiError_InternalServerErrorEncoded"},{"$ref":"#/components/schemas/effect_HttpApiError_InternalServerErrorEncoded"}]}}}}},"description":"Time off assignments are mappings between workers and time off policies. Useful for finding out which policies a worker is assigned to, or which workers are assigned to a given policy.","summary":"List Time Off Assignments"}},"/v1/time_off/balances":{"get":{"tags":["Time Off"],"operationId":"Time Off.getBalances","parameters":[{"name":"limit","in":"query","schema":{"anyOf":[{"type":"string"},{"type":"null"}]},"required":true},{"name":"afterId","in":"query","schema":{"anyOf":[{"type":"string","pattern":"^wrkasn_","description":"The external-facing id of the worker assignment.","examples":["wrkasn_1234"]},{"type":"null"}]},"required":false},{"name":"beforeId","in":"query","schema":{"anyOf":[{"type":"string","pattern":"^wrkasn_","description":"The external-facing id of the worker assignment.","examples":["wrkasn_1234"]},{"type":"null"}]},"required":false},{"name":"policyIds","in":"query","schema":{"anyOf":[{"type":"array","items":{"type":"string","pattern":"^top_","examples":["top_1234"]}},{"type":"null"}]},"required":false},{"name":"workerIds","in":"query","schema":{"anyOf":[{"type":"array","items":{"type":"string","pattern":"^wrk_","description":"The id of the worker.","examples":["wrk_1234"]}},{"type":"null"}]},"required":false},{"name":"startDate","in":"query","schema":{"anyOf":[{"type":"string"},{"type":"null"}]},"required":false},{"name":"endDate","in":"query","schema":{"anyOf":[{"type":"string"},{"type":"null"}]},"required":false}],"security":[{"apiKey":[]}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"hasMore":{"type":"boolean"},"count":{"type":"integer"},"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","pattern":"^wrkasn_","description":"The external-facing id of the worker assignment.","examples":["wrkasn_1234"]},"policyId":{"type":"string","pattern":"^top_","examples":["top_1234"]},"legacyWorkerId":{"type":"string"},"accruedUnlocked":{"anyOf":[{"type":"number"},{"type":"string","enum":["Infinity","-Infinity","NaN"]}]},"accruedLocked":{"anyOf":[{"type":"number"},{"type":"string","enum":["Infinity","-Infinity","NaN"]}]},"used":{"anyOf":[{"type":"number"},{"type":"string","enum":["Infinity","-Infinity","NaN"]}]},"holds":{"anyOf":[{"type":"number"},{"type":"string","enum":["Infinity","-Infinity","NaN"]}]},"available":{"anyOf":[{"type":"number"},{"type":"string","enum":["Infinity","-Infinity","NaN"]}]}},"required":["id","policyId","legacyWorkerId","accruedUnlocked","accruedLocked","used","holds","available"],"additionalProperties":false}}},"required":["hasMore","count","data"],"additionalProperties":false}}}},"401":{"description":"ApiKeyUnauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKeyUnauthorizedEncoded"}}}},"403":{"description":"MissingRequiredCompanyPermissions | ApiNotEnabled","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/MissingRequiredCompanyPermissionsEncoded"},{"$ref":"#/components/schemas/ApiNotEnabledEncoded"}]}}}},"404":{"description":"TimeOffPolicyNotFound","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TimeOffPolicyNotFoundEncoded"}}}},"429":{"description":"RateLimitExceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitExceededEncoded"}}}},"500":{"description":"InternalServerError","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/effect_HttpApiError_InternalServerErrorEncoded"},{"$ref":"#/components/schemas/effect_HttpApiError_InternalServerErrorEncoded"}]}}}}},"description":"Get worker remaining time-off balances.","summary":"List Time Off Balances"}},"/v1/time_off/requests":{"get":{"tags":["Time Off"],"operationId":"Time Off.getRequests","parameters":[{"name":"limit","in":"query","schema":{"anyOf":[{"type":"string"},{"type":"null"}]},"required":true},{"name":"afterId","in":"query","schema":{"anyOf":[{"type":"string"},{"type":"null"}]},"required":false},{"name":"beforeId","in":"query","schema":{"anyOf":[{"type":"string"},{"type":"null"}]},"required":false},{"name":"statuses","in":"query","schema":{"anyOf":[{"type":"array","items":{"type":"string","enum":["pending","approved","denied"]}},{"type":"null"}]},"required":false},{"name":"policyIds","in":"query","schema":{"anyOf":[{"type":"array","items":{"type":"string","pattern":"^top_","examples":["top_1234"]}},{"type":"null"}]},"required":false},{"name":"workerIds","in":"query","schema":{"anyOf":[{"type":"array","items":{"type":"string","pattern":"^wrk_","description":"The id of the worker.","examples":["wrk_1234"]}},{"type":"null"}]},"required":false},{"name":"startsOnOrAfter","in":"query","schema":{"anyOf":[{"type":"string"},{"type":"null"}]},"required":false},{"name":"startsBefore","in":"query","schema":{"anyOf":[{"type":"string"},{"type":"null"}]},"required":false},{"name":"endsOnOrAfter","in":"query","schema":{"anyOf":[{"type":"string"},{"type":"null"}]},"required":false},{"name":"endsBefore","in":"query","schema":{"anyOf":[{"type":"string"},{"type":"null"}]},"required":false}],"security":[{"apiKey":[]}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"hasMore":{"type":"boolean"},"count":{"type":"integer"},"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"timeOffPolicyId":{"type":"string","pattern":"^top_","examples":["top_1234"]},"workerId":{"type":"string","pattern":"^wrk_","description":"The id of the worker.","examples":["wrk_1234"]},"status":{"type":"string","enum":["pending","approved","denied"]},"startAt":{"type":"string"},"startRangeType":{"type":"string","enum":["date","datetime"]},"endAt":{"type":"string"},"endRangeType":{"type":"string","enum":["date","datetime"]},"reason":{"anyOf":[{"type":"string"},{"type":"null"}]},"createdAt":{"type":"string"},"requestedMinutes":{"anyOf":[{"type":"number"},{"type":"string","enum":["Infinity","-Infinity","NaN"]}]},"timeZone":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The time zone that the worker is requesting time off in.","examples":["America/New_York"]}},"required":["id","timeOffPolicyId","workerId","status","startAt","startRangeType","endAt","endRangeType","reason","createdAt","requestedMinutes","timeZone"],"additionalProperties":false}}},"required":["hasMore","count","data"],"additionalProperties":false}}}},"401":{"description":"ApiKeyUnauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKeyUnauthorizedEncoded"}}}},"403":{"description":"MissingRequiredCompanyPermissions | ApiNotEnabled","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/MissingRequiredCompanyPermissionsEncoded"},{"$ref":"#/components/schemas/ApiNotEnabledEncoded"}]}}}},"404":{"description":"TimeOffRequestNotFoundError","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TimeOffRequestNotFoundErrorEncoded"}}}},"429":{"description":"RateLimitExceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitExceededEncoded"}}}},"500":{"description":"InternalServerError","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/effect_HttpApiError_InternalServerErrorEncoded"},{"$ref":"#/components/schemas/effect_HttpApiError_InternalServerErrorEncoded"}]}}}}},"description":"Get the time off requests that workers in your company have made.","summary":"List Time Off Requests"}},"/v1/workers/{id}":{"patch":{"tags":["Workers"],"operationId":"Workers.update","parameters":[{"name":"id","in":"path","schema":{"type":"string","pattern":"^wrk_","description":"The id of the worker.","examples":["wrk_1234"]},"required":true}],"security":[{"apiKey":[]}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","pattern":"^wrk_","description":"The id of the worker.","examples":["wrk_1234"]},"position":{"type":"string","examples":["Research Engineer"]},"type":{"type":"string","enum":["employee","contractor"]},"status":{"type":"string","enum":["draft","invited","onboarding","active","offboarding","inactive"]},"benefitEligible":{"type":"boolean","allOf":[{"description":"The worker's stored benefits eligibility flag.","examples":[true,false]}]},"startDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","allOf":[{"description":"The worker's employment start date. Reactivation after an offboarding is reported separately in latestRehireDate.","examples":["2022-04-11"]}]},"endDate":{"anyOf":[{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},{"type":"null"}],"allOf":[{"description":"The worker's final day of employment, or null when employment is ongoing.","examples":["2026-08-15",null]}]},"isBusiness":{"anyOf":[{"type":"boolean"},{"type":"null"}],"examples":[false]},"businessName":{"anyOf":[{"type":"string"},{"type":"null"}],"examples":[null,"Galt Enterprises, LLC"]},"firstName":{"type":"string","examples":["Jonathan","Melissa"]},"lastName":{"type":"string","examples":["Galt","Jones"]},"email":{"type":"string","format":"email","title":"Email","description":"An email with a reasonably valid regex (based on RFC 5321 atext characters)","examples":["john@joinwarp.com"]},"workEmail":{"anyOf":[{"type":"string","format":"email","title":"Email","description":"An email with a reasonably valid regex (based on RFC 5321 atext characters)","examples":["john@joinwarp.com"]},{"type":"null"}]},"preferredName":{"anyOf":[{"type":"string","examples":["John"]},{"type":"null"}]},"biologicalSex":{"anyOf":[{"type":"string","enum":["male","female"]},{"type":"null"}],"description":"The worker's biological sex, or null when unavailable.","examples":["female"]},"maritalStatus":{"anyOf":[{"type":"string","enum":["married","not_married"]},{"type":"null"}],"description":"The worker's marital status, or null when unavailable.","examples":["married"]},"dateOfBirth":{"anyOf":[{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},{"type":"null"}],"description":"The worker's date of birth, or null when unavailable.","examples":["1990-06-15"]},"phone":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The worker's personal phone number, or null when unavailable.","examples":["+12025550143"]},"address":{"anyOf":[{"$ref":"#/components/schemas/PublicWorkerAddress"},{"type":"null"}],"description":"The worker's home address, or null when unavailable.","examples":[{"line1":"123 Example Street","line2":"Suite 400","city":"New York","state":"NY","postalCode":"10001","country":"US"}]},"displayName":{"type":"string","description":"The \"ui\" name of a worker. If it's a business contractor business name is used. Otherwise we default to preferred name, then first-last.","examples":["Jack Galt"]},"manager":{"anyOf":[{"$ref":"#/components/schemas/PublicWorkerManager"},{"type":"null"}],"description":"The worker's manager, or null if unassigned.","examples":[{"id":"wrk_3Fna7qP2mL8z","firstName":"Hank","lastName":"Rearden","displayName":"Hank Rearden"},null]},"timeZone":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The IANA timezone of the worker (e.g., America/New_York).","examples":["America/New_York"]},"tShirtSize":{"anyOf":[{"type":"string","enum":["XS","S","M","L","XL","XXL","XXXL"]},{"type":"null"}],"description":"The worker's stored T-shirt size, or null when unset or unavailable.","examples":["M",null]},"department":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","pattern":"^dpt_","description":"The unique public id of the department","examples":["dpt_1234"]},"name":{"type":"string"}},"required":["id","name"],"additionalProperties":false},{"type":"null"}],"description":"The department the worker belongs to, or null if unassigned.","examples":[{"id":"dpt_7Rqa2mP9xK4c","name":"Engineering"},null]},"primaryWorkplace":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","pattern":"^wkp_","description":"Public workplace identifier","examples":["wkp_1234"]},"name":{"type":"string"},"type":{"type":"string","enum":["remote","office"]}},"required":["id","name","type"],"additionalProperties":false},{"type":"null"}],"description":"The primary workplace the worker is assigned to, or null if unassigned.","examples":[{"id":"wkp_4Nva8qT2mL7z","name":"New York Office","type":"office"},null]},"latestRehireDate":{"anyOf":[{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},{"type":"null"}],"description":"The date the worker was most recently reactivated after an offboarding. This is distinct from startDate and is null if the worker has not been rehired.","examples":["2024-02-05",null]},"terminationReason":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The reason the worker was terminated, or null when no termination reason is recorded.","examples":["Position eliminated",null]},"updatedAt":{"type":"string","examples":["2026-08-20T14:30:00.000Z"]},"level":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","pattern":"^jlvl_","description":"The unique public id of the job level","examples":["jlvl_1234"]},"code":{"type":"string"},"name":{"type":"string"},"track":{"type":"string","enum":["ic","manager","executive"]}},"required":["id","code","name","track"],"additionalProperties":false},{"type":"null"}],"description":"The worker's assigned job level, or null if unassigned. Omitted when job levels are not enabled."},"compensation":{"anyOf":[{"$ref":"#/components/schemas/PublicWorkerCompensation"},{"type":"null"}],"description":"The worker's current regular compensation, or the rate effective on a future start date. Null when the worker has no applicable regular pay rate or the API key lacks the corresponding compensation read scope.","examples":[{"payRateId":"pyr_9Cka3pR8vM2x","per":"year","amount":15000000,"currency":"USD","display":"$150,000.00 / yr"},null]},"customFields":{"anyOf":[{"type":"array","items":{"$ref":"#/components/schemas/PublicWorkerCustomField"},"description":"The worker's custom field values. Every active company custom field appears; fields outside this API key's permission scopes are redacted (value null, redacted true) rather than omitted, so the list is identical across keys. Empty when the company has no custom fields.","examples":[[]]},{"type":"null"}]}},"required":["id","position","type","status","benefitEligible","startDate","endDate","isBusiness","businessName","firstName","lastName","email","workEmail","preferredName","biologicalSex","maritalStatus","dateOfBirth","phone","address","displayName","timeZone","department","primaryWorkplace","latestRehireDate","terminationReason","updatedAt","compensation"],"additionalProperties":false,"description":"A worker profile, including lifecycle, workplace, profile, and compensation fields.","examples":[{"id":"wrk_khac8380c2Lm","position":"Research Engineer","type":"employee","status":"active","benefitEligible":true,"startDate":"2022-04-11","endDate":null,"isBusiness":null,"businessName":null,"firstName":"Jane","lastName":"Doe","email":"jane.doe@example.com","workEmail":"jane.doe@acme.example","preferredName":"Jane","biologicalSex":"female","maritalStatus":"married","dateOfBirth":"1990-06-15","phone":"+12025550143","address":{"line1":"123 Example Street","line2":"Suite 400","city":"New York","state":"NY","postalCode":"10001","country":"US"},"displayName":"Jane Doe","manager":{"id":"wrk_3Fna7qP2mL8z","firstName":"Hank","lastName":"Rearden","displayName":"Hank Rearden"},"timeZone":"America/New_York","tShirtSize":"M","department":{"id":"dpt_7Rqa2mP9xK4c","name":"Engineering"},"primaryWorkplace":{"id":"wkp_4Nva8qT2mL7z","name":"New York Office","type":"office"},"latestRehireDate":"2024-02-05","terminationReason":null,"updatedAt":"2026-08-20T14:30:00.000Z","compensation":{"payRateId":"pyr_9Cka3pR8vM2x","per":"year","amount":15000000,"currency":"USD","display":"$150,000.00 / yr"},"customFields":[]}]}}}},"400":{"description":"The update is not valid for this worker in its current state. | The specified manager is not valid for this worker (e.g. a worker cannot manage themselves). | AddressInvalid","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/InvalidInputEncoded"},{"$ref":"#/components/schemas/InvalidManagerEncoded"},{"$ref":"#/components/schemas/AddressInvalidEncoded"}]}}}},"401":{"description":"ApiKeyUnauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKeyUnauthorizedEncoded"}}}},"403":{"description":"Job levels are not enabled for this company. | The requested action exceeds your current subscription limits. This may be due to US state limits or missing global payroll access. | MissingRequiredCompanyPermissions | ApiNotEnabled","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/JobLevelsNotEnabledEncoded"},{"$ref":"#/components/schemas/SubscriptionLimitErrorEncoded"},{"$ref":"#/components/schemas/MissingRequiredCompanyPermissionsEncoded"},{"$ref":"#/components/schemas/ApiNotEnabledEncoded"}]}}}},"404":{"description":"WorkerNotFound | The specified manager could not be found. The managerId must reference an existing worker. | DepartmentNotFound | The job level could not be found. | WorkplaceNotFound","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/WorkerNotFoundEncoded"},{"$ref":"#/components/schemas/ManagerNotFoundEncoded"},{"$ref":"#/components/schemas/DepartmentNotFoundEncoded"},{"$ref":"#/components/schemas/LevelNotFoundEncoded"},{"$ref":"#/components/schemas/WorkplaceNotFoundEncoded"}]}}}},"409":{"description":"The worker's email is their login identity. Changing it requires switching their auth account, which this endpoint does not do. | A worker with this email already exists in this organization. | Only an active worker can be terminated. | Only an offboarding or inactive worker can be reactivated. | The worker needs a complete US home address on file before their workplace can change to remote. | The company has not finished payroll setup, so workers cannot be onboarded to payroll yet. Complete payroll setup and try again. | WorkplaceAlreadyExists | The worker was modified by another request while this update was being validated. Retry the update.","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/EmailChangeRequiresAuthSwitchEncoded"},{"$ref":"#/components/schemas/WorkerAlreadyExistsErrorEncoded"},{"$ref":"#/components/schemas/WorkerNotActiveEncoded"},{"$ref":"#/components/schemas/WorkerNotOffboardedEncoded"},{"$ref":"#/components/schemas/WorkerHomeAddressRequiredEncoded"},{"$ref":"#/components/schemas/PayrollSetupIncompleteEncoded"},{"$ref":"#/components/schemas/WorkplaceAlreadyExistsEncoded"},{"$ref":"#/components/schemas/WorkerUpdateConflictEncoded"}]}}}},"429":{"description":"RateLimitExceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitExceededEncoded"}}}},"500":{"description":"InternalServerError","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/effect_HttpApiError_InternalServerErrorEncoded"},{"$ref":"#/components/schemas/effect_HttpApiError_InternalServerErrorEncoded"}]}}}}},"description":"Update a worker and return the updated worker object. Omitted fields remain unchanged. Requires workers:profile write, plus read access to any referenced department, level, or workplace. See individual fields for update restrictions.","summary":"Update Worker","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateWorker"}}},"required":true}},"get":{"tags":["Workers"],"operationId":"Workers.get","parameters":[{"name":"id","in":"path","schema":{"type":"string","pattern":"^wrk_","description":"The id of the worker.","examples":["wrk_1234"]},"required":true}],"security":[{"apiKey":[]}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","pattern":"^wrk_","description":"The id of the worker.","examples":["wrk_1234"]},"position":{"type":"string","examples":["Research Engineer"]},"type":{"type":"string","enum":["employee","contractor"]},"status":{"type":"string","enum":["draft","invited","onboarding","active","offboarding","inactive"]},"benefitEligible":{"type":"boolean","allOf":[{"description":"The worker's stored benefits eligibility flag.","examples":[true,false]}]},"startDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","allOf":[{"description":"The worker's employment start date. Reactivation after an offboarding is reported separately in latestRehireDate.","examples":["2022-04-11"]}]},"endDate":{"anyOf":[{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},{"type":"null"}],"allOf":[{"description":"The worker's final day of employment, or null when employment is ongoing.","examples":["2026-08-15",null]}]},"isBusiness":{"anyOf":[{"type":"boolean"},{"type":"null"}],"examples":[false]},"businessName":{"anyOf":[{"type":"string"},{"type":"null"}],"examples":[null,"Galt Enterprises, LLC"]},"firstName":{"type":"string","examples":["Jonathan","Melissa"]},"lastName":{"type":"string","examples":["Galt","Jones"]},"email":{"type":"string","format":"email","title":"Email","description":"An email with a reasonably valid regex (based on RFC 5321 atext characters)","examples":["john@joinwarp.com"]},"workEmail":{"anyOf":[{"type":"string","format":"email","title":"Email","description":"An email with a reasonably valid regex (based on RFC 5321 atext characters)","examples":["john@joinwarp.com"]},{"type":"null"}]},"preferredName":{"anyOf":[{"type":"string","examples":["John"]},{"type":"null"}]},"biologicalSex":{"anyOf":[{"type":"string","enum":["male","female"]},{"type":"null"}],"description":"The worker's biological sex, or null when unavailable.","examples":["female"]},"maritalStatus":{"anyOf":[{"type":"string","enum":["married","not_married"]},{"type":"null"}],"description":"The worker's marital status, or null when unavailable.","examples":["married"]},"dateOfBirth":{"anyOf":[{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},{"type":"null"}],"description":"The worker's date of birth, or null when unavailable.","examples":["1990-06-15"]},"phone":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The worker's personal phone number, or null when unavailable.","examples":["+12025550143"]},"address":{"anyOf":[{"$ref":"#/components/schemas/PublicWorkerAddress"},{"type":"null"}],"description":"The worker's home address, or null when unavailable.","examples":[{"line1":"123 Example Street","line2":"Suite 400","city":"New York","state":"NY","postalCode":"10001","country":"US"}]},"displayName":{"type":"string","description":"The \"ui\" name of a worker. If it's a business contractor business name is used. Otherwise we default to preferred name, then first-last.","examples":["Jack Galt"]},"manager":{"anyOf":[{"$ref":"#/components/schemas/PublicWorkerManager"},{"type":"null"}],"description":"The worker's manager, or null if unassigned.","examples":[{"id":"wrk_3Fna7qP2mL8z","firstName":"Hank","lastName":"Rearden","displayName":"Hank Rearden"},null]},"timeZone":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The IANA timezone of the worker (e.g., America/New_York).","examples":["America/New_York"]},"tShirtSize":{"anyOf":[{"type":"string","enum":["XS","S","M","L","XL","XXL","XXXL"]},{"type":"null"}],"description":"The worker's stored T-shirt size, or null when unset or unavailable.","examples":["M",null]},"department":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","pattern":"^dpt_","description":"The unique public id of the department","examples":["dpt_1234"]},"name":{"type":"string"}},"required":["id","name"],"additionalProperties":false},{"type":"null"}],"description":"The department the worker belongs to, or null if unassigned.","examples":[{"id":"dpt_7Rqa2mP9xK4c","name":"Engineering"},null]},"primaryWorkplace":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","pattern":"^wkp_","description":"Public workplace identifier","examples":["wkp_1234"]},"name":{"type":"string"},"type":{"type":"string","enum":["remote","office"]}},"required":["id","name","type"],"additionalProperties":false},{"type":"null"}],"description":"The primary workplace the worker is assigned to, or null if unassigned.","examples":[{"id":"wkp_4Nva8qT2mL7z","name":"New York Office","type":"office"},null]},"latestRehireDate":{"anyOf":[{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},{"type":"null"}],"description":"The date the worker was most recently reactivated after an offboarding. This is distinct from startDate and is null if the worker has not been rehired.","examples":["2024-02-05",null]},"terminationReason":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The reason the worker was terminated, or null when no termination reason is recorded.","examples":["Position eliminated",null]},"updatedAt":{"type":"string","examples":["2026-08-20T14:30:00.000Z"]},"level":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","pattern":"^jlvl_","description":"The unique public id of the job level","examples":["jlvl_1234"]},"code":{"type":"string"},"name":{"type":"string"},"track":{"type":"string","enum":["ic","manager","executive"]}},"required":["id","code","name","track"],"additionalProperties":false},{"type":"null"}],"description":"The worker's assigned job level, or null if unassigned. Omitted when job levels are not enabled."},"compensation":{"anyOf":[{"$ref":"#/components/schemas/PublicWorkerCompensation"},{"type":"null"}],"description":"The worker's current regular compensation, or the rate effective on a future start date. Null when the worker has no applicable regular pay rate or the API key lacks the corresponding compensation read scope.","examples":[{"payRateId":"pyr_9Cka3pR8vM2x","per":"year","amount":15000000,"currency":"USD","display":"$150,000.00 / yr"},null]},"customFields":{"anyOf":[{"type":"array","items":{"$ref":"#/components/schemas/PublicWorkerCustomField"},"description":"The worker's custom field values. Every active company custom field appears; fields outside this API key's permission scopes are redacted (value null, redacted true) rather than omitted, so the list is identical across keys. Empty when the company has no custom fields.","examples":[[]]},{"type":"null"}]}},"required":["id","position","type","status","benefitEligible","startDate","endDate","isBusiness","businessName","firstName","lastName","email","workEmail","preferredName","biologicalSex","maritalStatus","dateOfBirth","phone","address","displayName","timeZone","department","primaryWorkplace","latestRehireDate","terminationReason","updatedAt","compensation"],"additionalProperties":false,"description":"A worker profile, including lifecycle, workplace, profile, and compensation fields.","examples":[{"id":"wrk_khac8380c2Lm","position":"Research Engineer","type":"employee","status":"active","benefitEligible":true,"startDate":"2022-04-11","endDate":null,"isBusiness":null,"businessName":null,"firstName":"Jane","lastName":"Doe","email":"jane.doe@example.com","workEmail":"jane.doe@acme.example","preferredName":"Jane","biologicalSex":"female","maritalStatus":"married","dateOfBirth":"1990-06-15","phone":"+12025550143","address":{"line1":"123 Example Street","line2":"Suite 400","city":"New York","state":"NY","postalCode":"10001","country":"US"},"displayName":"Jane Doe","manager":{"id":"wrk_3Fna7qP2mL8z","firstName":"Hank","lastName":"Rearden","displayName":"Hank Rearden"},"timeZone":"America/New_York","tShirtSize":"M","department":{"id":"dpt_7Rqa2mP9xK4c","name":"Engineering"},"primaryWorkplace":{"id":"wkp_4Nva8qT2mL7z","name":"New York Office","type":"office"},"latestRehireDate":"2024-02-05","terminationReason":null,"updatedAt":"2026-08-20T14:30:00.000Z","compensation":{"payRateId":"pyr_9Cka3pR8vM2x","per":"year","amount":15000000,"currency":"USD","display":"$150,000.00 / yr"},"customFields":[]}]}}}},"401":{"description":"ApiKeyUnauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKeyUnauthorizedEncoded"}}}},"403":{"description":"MissingRequiredCompanyPermissions | ApiNotEnabled","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/MissingRequiredCompanyPermissionsEncoded"},{"$ref":"#/components/schemas/ApiNotEnabledEncoded"}]}}}},"404":{"description":"The specified worker could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkerNotFoundErrorEncoded"}}}},"429":{"description":"RateLimitExceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitExceededEncoded"}}}},"500":{"description":"InternalServerError","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/effect_HttpApiError_InternalServerErrorEncoded"},{"$ref":"#/components/schemas/effect_HttpApiError_InternalServerErrorEncoded"}]}}}}},"description":"Get a specific worker by ID.","summary":"Get Worker"},"delete":{"tags":["Workers"],"operationId":"Workers.deleteWorker","parameters":[{"name":"id","in":"path","schema":{"type":"string","pattern":"^wrk_","description":"The id of the worker.","examples":["wrk_1234"]},"required":true}],"security":[{"apiKey":[]}],"responses":{"204":{"description":"<No Content>"},"401":{"description":"ApiKeyUnauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKeyUnauthorizedEncoded"}}}},"403":{"description":"MissingRequiredCompanyPermissions | ApiNotEnabled","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/MissingRequiredCompanyPermissionsEncoded"},{"$ref":"#/components/schemas/ApiNotEnabledEncoded"}]}}}},"404":{"description":"The specified worker could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkerNotFoundErrorEncoded"}}}},"409":{"description":"This worker cannot be deleted because they have progressed beyond the draft or invited stage. Active workers must be properly offboarded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CannotDeleteWorkerEncoded"}}}},"429":{"description":"RateLimitExceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitExceededEncoded"}}}},"500":{"description":"InternalServerError","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/effect_HttpApiError_InternalServerErrorEncoded"},{"$ref":"#/components/schemas/effect_HttpApiError_InternalServerErrorEncoded"}]}}}}},"description":"Delete a worker. Only workers who have not yet completed onboarding can be deleted. Active workers must be properly offboarded.","summary":"Delete Worker"}},"/v1/workers/reveal_ssn":{"post":{"tags":["Workers"],"operationId":"Workers.revealSsn","parameters":[],"security":[{"apiKey":[]}],"responses":{"200":{"description":"Success","headers":{"cache-control":{"schema":{"type":"string","enum":["private, no-store"]},"required":true}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PublicWorkerSsn"},"examples":[[{"id":"wrk_khac8380c2Lm","ssn":"000123456"},{"id":"wrk_q7Vm2pR9xK4c","ssn":null}]]}}}},"401":{"description":"ApiKeyUnauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKeyUnauthorizedEncoded"}}}},"403":{"description":"MissingRequiredCompanyPermissions | ApiNotEnabled","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/MissingRequiredCompanyPermissionsEncoded"},{"$ref":"#/components/schemas/ApiNotEnabledEncoded"}]}}}},"404":{"description":"The specified worker could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkerNotFoundErrorEncoded"}}}},"429":{"description":"RateLimitExceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitExceededEncoded"}}}},"500":{"description":"InternalServerError","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/effect_HttpApiError_InternalServerErrorEncoded"},{"$ref":"#/components/schemas/effect_HttpApiError_InternalServerErrorEncoded"}]}}}}},"description":"Reveal full Social Security numbers for up to 50 workers. Requires the workers:pii read scope. Results preserve request order and use null when a worker has no SSN on file. The request fails if any worker is not found, emits one audit event per worker, and returns Cache-Control: private, no-store.","summary":"Reveal Worker SSNs","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"workerIds":{"type":"array","items":{"type":"string","pattern":"^wrk_","description":"The id of the worker.","examples":["wrk_1234"]},"description":"One to 50 unique worker ids. Results are returned in this order.","examples":[["wrk_khac8380c2Lm","wrk_q7Vm2pR9xK4c"]],"minItems":1,"maxItems":50,"uniqueItems":true}},"required":["workerIds"],"additionalProperties":false,"examples":[{"workerIds":["wrk_khac8380c2Lm","wrk_q7Vm2pR9xK4c"]}]}}},"required":true}}},"/v1/workers":{"get":{"tags":["Workers"],"operationId":"Workers.list","parameters":[{"name":"limit","in":"query","schema":{"anyOf":[{"type":"string"},{"type":"null"}]},"required":true},{"name":"afterId","in":"query","schema":{"anyOf":[{"type":"string","pattern":"^wrk_","description":"The id of the worker.","examples":["wrk_1234"]},{"type":"null"}]},"required":false},{"name":"beforeId","in":"query","schema":{"anyOf":[{"type":"string","pattern":"^wrk_","description":"The id of the worker.","examples":["wrk_1234"]},{"type":"null"}]},"required":false},{"name":"statuses","in":"query","schema":{"anyOf":[{"type":"array","items":{"type":"string","enum":["draft","invited","onboarding","active","offboarding","inactive"]}},{"type":"null"}]},"required":false},{"name":"types","in":"query","schema":{"anyOf":[{"type":"array","items":{"type":"string","enum":["employee","contractor"]}},{"type":"null"}]},"required":false},{"name":"workEmail","in":"query","schema":{"anyOf":[{"type":"string"},{"type":"null"}]},"required":false}],"security":[{"apiKey":[]}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"hasMore":{"type":"boolean"},"count":{"type":"integer"},"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","pattern":"^wrk_","description":"The id of the worker.","examples":["wrk_1234"]},"position":{"type":"string","examples":["Research Engineer"]},"type":{"type":"string","enum":["employee","contractor"]},"status":{"type":"string","enum":["draft","invited","onboarding","active","offboarding","inactive"]},"benefitEligible":{"type":"boolean","allOf":[{"description":"The worker's stored benefits eligibility flag.","examples":[true,false]}]},"startDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","allOf":[{"description":"The worker's employment start date. Reactivation after an offboarding is reported separately in latestRehireDate.","examples":["2022-04-11"]}]},"endDate":{"anyOf":[{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},{"type":"null"}],"allOf":[{"description":"The worker's final day of employment, or null when employment is ongoing.","examples":["2026-08-15",null]}]},"isBusiness":{"anyOf":[{"type":"boolean"},{"type":"null"}],"examples":[false]},"businessName":{"anyOf":[{"type":"string"},{"type":"null"}],"examples":[null,"Galt Enterprises, LLC"]},"firstName":{"type":"string","examples":["Jonathan","Melissa"]},"lastName":{"type":"string","examples":["Galt","Jones"]},"email":{"type":"string","format":"email","title":"Email","description":"An email with a reasonably valid regex (based on RFC 5321 atext characters)","examples":["john@joinwarp.com"]},"workEmail":{"anyOf":[{"type":"string","format":"email","title":"Email","description":"An email with a reasonably valid regex (based on RFC 5321 atext characters)","examples":["john@joinwarp.com"]},{"type":"null"}]},"preferredName":{"anyOf":[{"type":"string","examples":["John"]},{"type":"null"}]},"biologicalSex":{"anyOf":[{"type":"string","enum":["male","female"]},{"type":"null"}],"description":"The worker's biological sex, or null when unavailable.","examples":["female"]},"maritalStatus":{"anyOf":[{"type":"string","enum":["married","not_married"]},{"type":"null"}],"description":"The worker's marital status, or null when unavailable.","examples":["married"]},"dateOfBirth":{"anyOf":[{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},{"type":"null"}],"description":"The worker's date of birth, or null when unavailable.","examples":["1990-06-15"]},"phone":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The worker's personal phone number, or null when unavailable.","examples":["+12025550143"]},"address":{"anyOf":[{"$ref":"#/components/schemas/PublicWorkerAddress"},{"type":"null"}],"description":"The worker's home address, or null when unavailable.","examples":[{"line1":"123 Example Street","line2":"Suite 400","city":"New York","state":"NY","postalCode":"10001","country":"US"}]},"displayName":{"type":"string","description":"The \"ui\" name of a worker. If it's a business contractor business name is used. Otherwise we default to preferred name, then first-last.","examples":["Jack Galt"]},"manager":{"anyOf":[{"$ref":"#/components/schemas/PublicWorkerManager"},{"type":"null"}],"description":"The worker's manager, or null if unassigned.","examples":[{"id":"wrk_3Fna7qP2mL8z","firstName":"Hank","lastName":"Rearden","displayName":"Hank Rearden"},null]},"timeZone":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The IANA timezone of the worker (e.g., America/New_York).","examples":["America/New_York"]},"tShirtSize":{"anyOf":[{"type":"string","enum":["XS","S","M","L","XL","XXL","XXXL"]},{"type":"null"}],"description":"The worker's stored T-shirt size, or null when unset or unavailable.","examples":["M",null]},"department":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","pattern":"^dpt_","description":"The unique public id of the department","examples":["dpt_1234"]},"name":{"type":"string"}},"required":["id","name"],"additionalProperties":false},{"type":"null"}],"description":"The department the worker belongs to, or null if unassigned.","examples":[{"id":"dpt_7Rqa2mP9xK4c","name":"Engineering"},null]},"primaryWorkplace":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","pattern":"^wkp_","description":"Public workplace identifier","examples":["wkp_1234"]},"name":{"type":"string"},"type":{"type":"string","enum":["remote","office"]}},"required":["id","name","type"],"additionalProperties":false},{"type":"null"}],"description":"The primary workplace the worker is assigned to, or null if unassigned.","examples":[{"id":"wkp_4Nva8qT2mL7z","name":"New York Office","type":"office"},null]},"latestRehireDate":{"anyOf":[{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},{"type":"null"}],"description":"The date the worker was most recently reactivated after an offboarding. This is distinct from startDate and is null if the worker has not been rehired.","examples":["2024-02-05",null]},"terminationReason":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The reason the worker was terminated, or null when no termination reason is recorded.","examples":["Position eliminated",null]},"updatedAt":{"type":"string","examples":["2026-08-20T14:30:00.000Z"]},"level":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","pattern":"^jlvl_","description":"The unique public id of the job level","examples":["jlvl_1234"]},"code":{"type":"string"},"name":{"type":"string"},"track":{"type":"string","enum":["ic","manager","executive"]}},"required":["id","code","name","track"],"additionalProperties":false},{"type":"null"}],"description":"The worker's assigned job level, or null if unassigned. Omitted when job levels are not enabled."},"compensation":{"anyOf":[{"$ref":"#/components/schemas/PublicWorkerCompensation"},{"type":"null"}],"description":"The worker's current regular compensation, or the rate effective on a future start date. Null when the worker has no applicable regular pay rate or the API key lacks the corresponding compensation read scope.","examples":[{"payRateId":"pyr_9Cka3pR8vM2x","per":"year","amount":15000000,"currency":"USD","display":"$150,000.00 / yr"},null]},"customFields":{"anyOf":[{"type":"array","items":{"$ref":"#/components/schemas/PublicWorkerCustomField"},"description":"The worker's custom field values. Every active company custom field appears; fields outside this API key's permission scopes are redacted (value null, redacted true) rather than omitted, so the list is identical across keys. Empty when the company has no custom fields.","examples":[[]]},{"type":"null"}]}},"required":["id","position","type","status","benefitEligible","startDate","endDate","isBusiness","businessName","firstName","lastName","email","workEmail","preferredName","biologicalSex","maritalStatus","dateOfBirth","phone","address","displayName","timeZone","department","primaryWorkplace","latestRehireDate","terminationReason","updatedAt","compensation"],"additionalProperties":false,"description":"A worker profile, including lifecycle, workplace, profile, and compensation fields.","examples":[{"id":"wrk_khac8380c2Lm","position":"Research Engineer","type":"employee","status":"active","benefitEligible":true,"startDate":"2022-04-11","endDate":null,"isBusiness":null,"businessName":null,"firstName":"Jane","lastName":"Doe","email":"jane.doe@example.com","workEmail":"jane.doe@acme.example","preferredName":"Jane","biologicalSex":"female","maritalStatus":"married","dateOfBirth":"1990-06-15","phone":"+12025550143","address":{"line1":"123 Example Street","line2":"Suite 400","city":"New York","state":"NY","postalCode":"10001","country":"US"},"displayName":"Jane Doe","manager":{"id":"wrk_3Fna7qP2mL8z","firstName":"Hank","lastName":"Rearden","displayName":"Hank Rearden"},"timeZone":"America/New_York","tShirtSize":"M","department":{"id":"dpt_7Rqa2mP9xK4c","name":"Engineering"},"primaryWorkplace":{"id":"wkp_4Nva8qT2mL7z","name":"New York Office","type":"office"},"latestRehireDate":"2024-02-05","terminationReason":null,"updatedAt":"2026-08-20T14:30:00.000Z","compensation":{"payRateId":"pyr_9Cka3pR8vM2x","per":"year","amount":15000000,"currency":"USD","display":"$150,000.00 / yr"},"customFields":[]}]}}},"required":["hasMore","count","data"],"additionalProperties":false}}}},"401":{"description":"ApiKeyUnauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKeyUnauthorizedEncoded"}}}},"403":{"description":"MissingRequiredCompanyPermissions | ApiNotEnabled","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/MissingRequiredCompanyPermissionsEncoded"},{"$ref":"#/components/schemas/ApiNotEnabledEncoded"}]}}}},"429":{"description":"RateLimitExceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitExceededEncoded"}}}},"500":{"description":"InternalServerError","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/effect_HttpApiError_InternalServerErrorEncoded"},{"$ref":"#/components/schemas/effect_HttpApiError_InternalServerErrorEncoded"}]}}}}},"description":"List all workers. Workers include anyone employed by the company, whether US or international, full-time employees or contractors.","summary":"List Workers"}},"/v1/workers/employee":{"post":{"tags":["Workers"],"operationId":"Workers.createEmployee","parameters":[],"security":[{"apiKey":[]}],"responses":{"201":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","pattern":"^wrk_","description":"The id of the worker.","examples":["wrk_1234"]},"position":{"type":"string","examples":["Research Engineer"]},"type":{"type":"string","enum":["employee","contractor"]},"status":{"type":"string","enum":["draft","invited","onboarding","active","offboarding","inactive"]},"benefitEligible":{"type":"boolean","allOf":[{"description":"The worker's stored benefits eligibility flag.","examples":[true,false]}]},"startDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","allOf":[{"description":"The worker's employment start date. Reactivation after an offboarding is reported separately in latestRehireDate.","examples":["2022-04-11"]}]},"endDate":{"anyOf":[{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},{"type":"null"}],"allOf":[{"description":"The worker's final day of employment, or null when employment is ongoing.","examples":["2026-08-15",null]}]},"isBusiness":{"anyOf":[{"type":"boolean"},{"type":"null"}],"examples":[false]},"businessName":{"anyOf":[{"type":"string"},{"type":"null"}],"examples":[null,"Galt Enterprises, LLC"]},"firstName":{"type":"string","examples":["Jonathan","Melissa"]},"lastName":{"type":"string","examples":["Galt","Jones"]},"email":{"type":"string","format":"email","title":"Email","description":"An email with a reasonably valid regex (based on RFC 5321 atext characters)","examples":["john@joinwarp.com"]},"workEmail":{"anyOf":[{"type":"string","format":"email","title":"Email","description":"An email with a reasonably valid regex (based on RFC 5321 atext characters)","examples":["john@joinwarp.com"]},{"type":"null"}]},"preferredName":{"anyOf":[{"type":"string","examples":["John"]},{"type":"null"}]},"biologicalSex":{"anyOf":[{"type":"string","enum":["male","female"]},{"type":"null"}],"description":"The worker's biological sex, or null when unavailable.","examples":["female"]},"maritalStatus":{"anyOf":[{"type":"string","enum":["married","not_married"]},{"type":"null"}],"description":"The worker's marital status, or null when unavailable.","examples":["married"]},"dateOfBirth":{"anyOf":[{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},{"type":"null"}],"description":"The worker's date of birth, or null when unavailable.","examples":["1990-06-15"]},"phone":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The worker's personal phone number, or null when unavailable.","examples":["+12025550143"]},"address":{"anyOf":[{"$ref":"#/components/schemas/PublicWorkerAddress"},{"type":"null"}],"description":"The worker's home address, or null when unavailable.","examples":[{"line1":"123 Example Street","line2":"Suite 400","city":"New York","state":"NY","postalCode":"10001","country":"US"}]},"displayName":{"type":"string","description":"The \"ui\" name of a worker. If it's a business contractor business name is used. Otherwise we default to preferred name, then first-last.","examples":["Jack Galt"]},"manager":{"anyOf":[{"$ref":"#/components/schemas/PublicWorkerManager"},{"type":"null"}],"description":"The worker's manager, or null if unassigned.","examples":[{"id":"wrk_3Fna7qP2mL8z","firstName":"Hank","lastName":"Rearden","displayName":"Hank Rearden"},null]},"timeZone":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The IANA timezone of the worker (e.g., America/New_York).","examples":["America/New_York"]},"tShirtSize":{"anyOf":[{"type":"string","enum":["XS","S","M","L","XL","XXL","XXXL"]},{"type":"null"}],"description":"The worker's stored T-shirt size, or null when unset or unavailable.","examples":["M",null]},"department":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","pattern":"^dpt_","description":"The unique public id of the department","examples":["dpt_1234"]},"name":{"type":"string"}},"required":["id","name"],"additionalProperties":false},{"type":"null"}],"description":"The department the worker belongs to, or null if unassigned.","examples":[{"id":"dpt_7Rqa2mP9xK4c","name":"Engineering"},null]},"primaryWorkplace":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","pattern":"^wkp_","description":"Public workplace identifier","examples":["wkp_1234"]},"name":{"type":"string"},"type":{"type":"string","enum":["remote","office"]}},"required":["id","name","type"],"additionalProperties":false},{"type":"null"}],"description":"The primary workplace the worker is assigned to, or null if unassigned.","examples":[{"id":"wkp_4Nva8qT2mL7z","name":"New York Office","type":"office"},null]},"latestRehireDate":{"anyOf":[{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},{"type":"null"}],"description":"The date the worker was most recently reactivated after an offboarding. This is distinct from startDate and is null if the worker has not been rehired.","examples":["2024-02-05",null]},"terminationReason":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The reason the worker was terminated, or null when no termination reason is recorded.","examples":["Position eliminated",null]},"updatedAt":{"type":"string","examples":["2026-08-20T14:30:00.000Z"]},"level":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","pattern":"^jlvl_","description":"The unique public id of the job level","examples":["jlvl_1234"]},"code":{"type":"string"},"name":{"type":"string"},"track":{"type":"string","enum":["ic","manager","executive"]}},"required":["id","code","name","track"],"additionalProperties":false},{"type":"null"}],"description":"The worker's assigned job level, or null if unassigned. Omitted when job levels are not enabled."},"compensation":{"anyOf":[{"$ref":"#/components/schemas/PublicWorkerCompensation"},{"type":"null"}],"description":"The worker's current regular compensation, or the rate effective on a future start date. Null when the worker has no applicable regular pay rate or the API key lacks the corresponding compensation read scope.","examples":[{"payRateId":"pyr_9Cka3pR8vM2x","per":"year","amount":15000000,"currency":"USD","display":"$150,000.00 / yr"},null]},"customFields":{"anyOf":[{"type":"array","items":{"$ref":"#/components/schemas/PublicWorkerCustomField"},"description":"The worker's custom field values. Every active company custom field appears; fields outside this API key's permission scopes are redacted (value null, redacted true) rather than omitted, so the list is identical across keys. Empty when the company has no custom fields.","examples":[[]]},{"type":"null"}]}},"required":["id","position","type","status","benefitEligible","startDate","endDate","isBusiness","businessName","firstName","lastName","email","workEmail","preferredName","biologicalSex","maritalStatus","dateOfBirth","phone","address","displayName","timeZone","department","primaryWorkplace","latestRehireDate","terminationReason","updatedAt","compensation"],"additionalProperties":false,"description":"A worker profile, including lifecycle, workplace, profile, and compensation fields.","examples":[{"id":"wrk_khac8380c2Lm","position":"Research Engineer","type":"employee","status":"active","benefitEligible":true,"startDate":"2022-04-11","endDate":null,"isBusiness":null,"businessName":null,"firstName":"Jane","lastName":"Doe","email":"jane.doe@example.com","workEmail":"jane.doe@acme.example","preferredName":"Jane","biologicalSex":"female","maritalStatus":"married","dateOfBirth":"1990-06-15","phone":"+12025550143","address":{"line1":"123 Example Street","line2":"Suite 400","city":"New York","state":"NY","postalCode":"10001","country":"US"},"displayName":"Jane Doe","manager":{"id":"wrk_3Fna7qP2mL8z","firstName":"Hank","lastName":"Rearden","displayName":"Hank Rearden"},"timeZone":"America/New_York","tShirtSize":"M","department":{"id":"dpt_7Rqa2mP9xK4c","name":"Engineering"},"primaryWorkplace":{"id":"wkp_4Nva8qT2mL7z","name":"New York Office","type":"office"},"latestRehireDate":"2024-02-05","terminationReason":null,"updatedAt":"2026-08-20T14:30:00.000Z","compensation":{"payRateId":"pyr_9Cka3pR8vM2x","per":"year","amount":15000000,"currency":"USD","display":"$150,000.00 / yr"},"customFields":[]}]}}}},"400":{"description":"You are hiring in a state where your company does not have an existing tax registration. Set stateRegistration to 'self_managed' or 'warp_managed' to proceed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StateRegistrationRequiredEncoded"}}}},"401":{"description":"ApiKeyUnauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKeyUnauthorizedEncoded"}}}},"403":{"description":"Job levels are not enabled for this company. | The requested action exceeds your current subscription limits. This may be due to US state limits or missing global payroll access. | MissingRequiredCompanyPermissions | ApiNotEnabled","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/JobLevelsNotEnabledEncoded"},{"$ref":"#/components/schemas/SubscriptionLimitErrorEncoded"},{"$ref":"#/components/schemas/MissingRequiredCompanyPermissionsEncoded"},{"$ref":"#/components/schemas/ApiNotEnabledEncoded"}]}}}},"404":{"description":"DepartmentNotFound | WorkplaceNotFound | The specified manager could not be found. The managerId must reference an existing worker. | The job level could not be found. | The specified pay schedule has not been configured for your company. Create a pay schedule with this frequency before assigning workers to it.","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/DepartmentNotFoundEncoded"},{"$ref":"#/components/schemas/WorkplaceNotFoundEncoded"},{"$ref":"#/components/schemas/ManagerNotFoundErrorEncoded"},{"$ref":"#/components/schemas/LevelNotFoundEncoded"},{"$ref":"#/components/schemas/PayScheduleNotConfiguredEncoded"}]}}}},"429":{"description":"RateLimitExceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitExceededEncoded"}}}},"500":{"description":"InternalServerError","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/effect_HttpApiError_InternalServerErrorEncoded"},{"$ref":"#/components/schemas/effect_HttpApiError_InternalServerErrorEncoded"}]}}}}},"description":"Create a new US employee. The worker will be created in draft status and must be invited separately via the invite endpoint. If hiring in a state without an existing tax registration, you must specify the stateRegistration field.","summary":"Create Employee","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"firstName":{"type":"string","pattern":"^\\S[\\s\\S]*\\S$|^\\S$|^$","minLength":1,"examples":["Jonathan"]},"lastName":{"type":"string","pattern":"^\\S[\\s\\S]*\\S$|^\\S$|^$","minLength":1,"examples":["Galt"]},"position":{"type":"string","pattern":"^\\S[\\s\\S]*\\S$|^\\S$|^$","minLength":1,"description":"The employee's job title.","examples":["Software Engineer","VP of Sales"]},"startDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"email":{"type":"string","format":"email","title":"Email","description":"Personal email address. The invite will be sent here.","examples":["john@joinwarp.com"]},"workEmail":{"anyOf":[{"anyOf":[{"type":"string","format":"email","title":"Email","description":"An email with a reasonably valid regex (based on RFC 5321 atext characters)","examples":["john@joinwarp.com"]},{"type":"null"}],"description":"Company-issued email address, if applicable."},{"type":"null"}]},"requireI9":{"anyOf":[{"type":"boolean","description":"Whether the employee is required to complete I-9 work authorization. Set to false if the employee has already been verified off-platform. Defaults to true."},{"type":"null"}]},"stateRegistration":{"anyOf":[{"type":"string","enum":["self_managed","warp_managed"],"description":"How state tax registration is handled for this employee's work state. Required when hiring in a state where your company doesn't have an existing registration. Use 'self_managed' if you've already registered in this state, or 'warp_managed' for Warp to handle registration on your behalf."},{"type":"null"}]},"departmentId":{"type":"string","pattern":"^dpt_","description":"The department to assign this employee to.","examples":["dpt_1234"]},"levelId":{"anyOf":[{"anyOf":[{"type":"string","pattern":"^jlvl_","description":"The unique public id of the job level","examples":["jlvl_1234"]},{"type":"null"}]},{"type":"null"}],"description":"The job level to assign this employee to, or null to leave unassigned. Omit this field when job levels are not enabled."},"managerId":{"type":"string","pattern":"^wrk_","description":"The worker id of this employee's direct manager.","examples":["wrk_1234"]},"stockOptions":{"anyOf":[{"anyOf":[{"anyOf":[{"type":"number"},{"type":"string","enum":["Infinity","-Infinity","NaN"]}]},{"type":"null"}],"description":"Number of stock options granted to this employee.","examples":[10000]},{"type":"null"}]},"workLocation":{"anyOf":[{"$ref":"#/components/schemas/OfficeWorkLocation"},{"$ref":"#/components/schemas/RemoteWorkLocation"}],"description":"Where the employee will work. Either an existing company workplace or a remote US state."},"compensation":{"type":"object","properties":{"amount":{"type":"number","exclusiveMinimum":0,"description":"The pay amount. Interpreted based on the \"per\" field.","examples":[85000,45.5]},"per":{"type":"string","enum":["hour","year"],"description":"Whether the amount is per hour or per year."}},"required":["amount","per"],"additionalProperties":false,"description":"The employee's base compensation."},"paySchedule":{"anyOf":[{"anyOf":[{"type":"string","enum":["weekly","biweekly","monthly","semimonthly","quarterly","annually"]},{"type":"null"}],"description":"The employee's pay schedule. Must be a pay schedule that the company has configured."},{"type":"null"}]}},"required":["firstName","lastName","position","startDate","email","departmentId","managerId","workLocation","compensation"],"additionalProperties":false}}},"required":true}}},"/v1/workers/contractor":{"post":{"tags":["Workers"],"operationId":"Workers.createContractor","parameters":[],"security":[{"apiKey":[]}],"responses":{"201":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","pattern":"^wrk_","description":"The id of the worker.","examples":["wrk_1234"]},"position":{"type":"string","examples":["Research Engineer"]},"type":{"type":"string","enum":["employee","contractor"]},"status":{"type":"string","enum":["draft","invited","onboarding","active","offboarding","inactive"]},"benefitEligible":{"type":"boolean","allOf":[{"description":"The worker's stored benefits eligibility flag.","examples":[true,false]}]},"startDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","allOf":[{"description":"The worker's employment start date. Reactivation after an offboarding is reported separately in latestRehireDate.","examples":["2022-04-11"]}]},"endDate":{"anyOf":[{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},{"type":"null"}],"allOf":[{"description":"The worker's final day of employment, or null when employment is ongoing.","examples":["2026-08-15",null]}]},"isBusiness":{"anyOf":[{"type":"boolean"},{"type":"null"}],"examples":[false]},"businessName":{"anyOf":[{"type":"string"},{"type":"null"}],"examples":[null,"Galt Enterprises, LLC"]},"firstName":{"type":"string","examples":["Jonathan","Melissa"]},"lastName":{"type":"string","examples":["Galt","Jones"]},"email":{"type":"string","format":"email","title":"Email","description":"An email with a reasonably valid regex (based on RFC 5321 atext characters)","examples":["john@joinwarp.com"]},"workEmail":{"anyOf":[{"type":"string","format":"email","title":"Email","description":"An email with a reasonably valid regex (based on RFC 5321 atext characters)","examples":["john@joinwarp.com"]},{"type":"null"}]},"preferredName":{"anyOf":[{"type":"string","examples":["John"]},{"type":"null"}]},"biologicalSex":{"anyOf":[{"type":"string","enum":["male","female"]},{"type":"null"}],"description":"The worker's biological sex, or null when unavailable.","examples":["female"]},"maritalStatus":{"anyOf":[{"type":"string","enum":["married","not_married"]},{"type":"null"}],"description":"The worker's marital status, or null when unavailable.","examples":["married"]},"dateOfBirth":{"anyOf":[{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},{"type":"null"}],"description":"The worker's date of birth, or null when unavailable.","examples":["1990-06-15"]},"phone":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The worker's personal phone number, or null when unavailable.","examples":["+12025550143"]},"address":{"anyOf":[{"$ref":"#/components/schemas/PublicWorkerAddress"},{"type":"null"}],"description":"The worker's home address, or null when unavailable.","examples":[{"line1":"123 Example Street","line2":"Suite 400","city":"New York","state":"NY","postalCode":"10001","country":"US"}]},"displayName":{"type":"string","description":"The \"ui\" name of a worker. If it's a business contractor business name is used. Otherwise we default to preferred name, then first-last.","examples":["Jack Galt"]},"manager":{"anyOf":[{"$ref":"#/components/schemas/PublicWorkerManager"},{"type":"null"}],"description":"The worker's manager, or null if unassigned.","examples":[{"id":"wrk_3Fna7qP2mL8z","firstName":"Hank","lastName":"Rearden","displayName":"Hank Rearden"},null]},"timeZone":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The IANA timezone of the worker (e.g., America/New_York).","examples":["America/New_York"]},"tShirtSize":{"anyOf":[{"type":"string","enum":["XS","S","M","L","XL","XXL","XXXL"]},{"type":"null"}],"description":"The worker's stored T-shirt size, or null when unset or unavailable.","examples":["M",null]},"department":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","pattern":"^dpt_","description":"The unique public id of the department","examples":["dpt_1234"]},"name":{"type":"string"}},"required":["id","name"],"additionalProperties":false},{"type":"null"}],"description":"The department the worker belongs to, or null if unassigned.","examples":[{"id":"dpt_7Rqa2mP9xK4c","name":"Engineering"},null]},"primaryWorkplace":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","pattern":"^wkp_","description":"Public workplace identifier","examples":["wkp_1234"]},"name":{"type":"string"},"type":{"type":"string","enum":["remote","office"]}},"required":["id","name","type"],"additionalProperties":false},{"type":"null"}],"description":"The primary workplace the worker is assigned to, or null if unassigned.","examples":[{"id":"wkp_4Nva8qT2mL7z","name":"New York Office","type":"office"},null]},"latestRehireDate":{"anyOf":[{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},{"type":"null"}],"description":"The date the worker was most recently reactivated after an offboarding. This is distinct from startDate and is null if the worker has not been rehired.","examples":["2024-02-05",null]},"terminationReason":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The reason the worker was terminated, or null when no termination reason is recorded.","examples":["Position eliminated",null]},"updatedAt":{"type":"string","examples":["2026-08-20T14:30:00.000Z"]},"level":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","pattern":"^jlvl_","description":"The unique public id of the job level","examples":["jlvl_1234"]},"code":{"type":"string"},"name":{"type":"string"},"track":{"type":"string","enum":["ic","manager","executive"]}},"required":["id","code","name","track"],"additionalProperties":false},{"type":"null"}],"description":"The worker's assigned job level, or null if unassigned. Omitted when job levels are not enabled."},"compensation":{"anyOf":[{"$ref":"#/components/schemas/PublicWorkerCompensation"},{"type":"null"}],"description":"The worker's current regular compensation, or the rate effective on a future start date. Null when the worker has no applicable regular pay rate or the API key lacks the corresponding compensation read scope.","examples":[{"payRateId":"pyr_9Cka3pR8vM2x","per":"year","amount":15000000,"currency":"USD","display":"$150,000.00 / yr"},null]},"customFields":{"anyOf":[{"type":"array","items":{"$ref":"#/components/schemas/PublicWorkerCustomField"},"description":"The worker's custom field values. Every active company custom field appears; fields outside this API key's permission scopes are redacted (value null, redacted true) rather than omitted, so the list is identical across keys. Empty when the company has no custom fields.","examples":[[]]},{"type":"null"}]}},"required":["id","position","type","status","benefitEligible","startDate","endDate","isBusiness","businessName","firstName","lastName","email","workEmail","preferredName","biologicalSex","maritalStatus","dateOfBirth","phone","address","displayName","timeZone","department","primaryWorkplace","latestRehireDate","terminationReason","updatedAt","compensation"],"additionalProperties":false,"description":"A worker profile, including lifecycle, workplace, profile, and compensation fields.","examples":[{"id":"wrk_khac8380c2Lm","position":"Research Engineer","type":"employee","status":"active","benefitEligible":true,"startDate":"2022-04-11","endDate":null,"isBusiness":null,"businessName":null,"firstName":"Jane","lastName":"Doe","email":"jane.doe@example.com","workEmail":"jane.doe@acme.example","preferredName":"Jane","biologicalSex":"female","maritalStatus":"married","dateOfBirth":"1990-06-15","phone":"+12025550143","address":{"line1":"123 Example Street","line2":"Suite 400","city":"New York","state":"NY","postalCode":"10001","country":"US"},"displayName":"Jane Doe","manager":{"id":"wrk_3Fna7qP2mL8z","firstName":"Hank","lastName":"Rearden","displayName":"Hank Rearden"},"timeZone":"America/New_York","tShirtSize":"M","department":{"id":"dpt_7Rqa2mP9xK4c","name":"Engineering"},"primaryWorkplace":{"id":"wkp_4Nva8qT2mL7z","name":"New York Office","type":"office"},"latestRehireDate":"2024-02-05","terminationReason":null,"updatedAt":"2026-08-20T14:30:00.000Z","compensation":{"payRateId":"pyr_9Cka3pR8vM2x","per":"year","amount":15000000,"currency":"USD","display":"$150,000.00 / yr"},"customFields":[]}]}}}},"401":{"description":"ApiKeyUnauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKeyUnauthorizedEncoded"}}}},"403":{"description":"Job levels are not enabled for this company. | MissingRequiredCompanyPermissions | ApiNotEnabled","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/JobLevelsNotEnabledEncoded"},{"$ref":"#/components/schemas/MissingRequiredCompanyPermissionsEncoded"},{"$ref":"#/components/schemas/ApiNotEnabledEncoded"}]}}}},"404":{"description":"DepartmentNotFound | The specified manager could not be found. The managerId must reference an existing worker. | The job level could not be found. | The specified pay schedule has not been configured for your company. Create a pay schedule with this frequency before assigning workers to it.","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/DepartmentNotFoundEncoded"},{"$ref":"#/components/schemas/ManagerNotFoundErrorEncoded"},{"$ref":"#/components/schemas/LevelNotFoundEncoded"},{"$ref":"#/components/schemas/PayScheduleNotConfiguredEncoded"}]}}}},"429":{"description":"RateLimitExceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitExceededEncoded"}}}},"500":{"description":"InternalServerError","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/effect_HttpApiError_InternalServerErrorEncoded"},{"$ref":"#/components/schemas/effect_HttpApiError_InternalServerErrorEncoded"}]}}}}},"description":"Create a new contractor. The worker will be created in draft status and must be invited separately via the invite endpoint. For business contractors, the businessName field is required.","summary":"Create Contractor","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"entityType":{"type":"string","enum":["individual","business"],"description":"Whether the contractor is an individual person or a business entity."},"firstName":{"type":"string","pattern":"^\\S[\\s\\S]*\\S$|^\\S$|^$","minLength":1,"examples":["Melissa"]},"lastName":{"type":"string","pattern":"^\\S[\\s\\S]*\\S$|^\\S$|^$","minLength":1,"examples":["Jones"]},"position":{"type":"string","pattern":"^\\S[\\s\\S]*\\S$|^\\S$|^$","minLength":1,"description":"The contractor's role or job title.","examples":["Design Consultant","Freelance Developer"]},"businessName":{"anyOf":[{"type":"string","pattern":"^\\S[\\s\\S]*\\S$|^\\S$|^$","minLength":1,"description":"Required when entityType is \"business\". The legal name of the contractor's business.","examples":["Galt Enterprises, LLC"]},{"type":"null"}]},"scopeOfWork":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A description of the work the contractor will perform.","examples":["Frontend development for the customer dashboard"]},{"type":"null"}]},"startDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"email":{"type":"string","format":"email","title":"Email","description":"Personal email address. The invite will be sent here.","examples":["john@joinwarp.com"]},"workEmail":{"anyOf":[{"anyOf":[{"type":"string","format":"email","title":"Email","description":"An email with a reasonably valid regex (based on RFC 5321 atext characters)","examples":["john@joinwarp.com"]},{"type":"null"}],"description":"Company-issued email address, if applicable."},{"type":"null"}]},"departmentId":{"type":"string","pattern":"^dpt_","description":"The department to assign this contractor to.","examples":["dpt_1234"]},"levelId":{"anyOf":[{"anyOf":[{"type":"string","pattern":"^jlvl_","description":"The unique public id of the job level","examples":["jlvl_1234"]},{"type":"null"}]},{"type":"null"}],"description":"The job level to assign this contractor to, or null to leave unassigned. Omit this field when job levels are not enabled."},"managerId":{"type":"string","pattern":"^wrk_","description":"The worker id of this contractor's direct manager.","examples":["wrk_1234"]},"workCountry":{"type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"compensation":{"anyOf":[{"anyOf":[{"type":"object","properties":{"currency":{"type":"string","enum":["USD","AUD","BGN","BRL","CAD","CHF","CZK","DKK","EUR","GBP","HKD","HUF","IDR","INR","JPY","MYR","NOK","NZD","CNY","PLN","RON","TRY","SEK","SGD","AED","ARS","BDT","BWP","CLP","COP","CRC","EGP","FJD","GEL","GHS","ILS","KES","KRW","LKR","MAD","MXN","NPR","PHP","PKR","THB","UAH","UGX","UYU","VND","ZAR","ZMW","TND","NGN","RSD","TWD","GTQ","HNL","DOP","SAR","XAF","PEN"]},"amount":{"type":"number","exclusiveMinimum":0,"description":"The pay amount. Interpreted based on the \"per\" field.","examples":[5000,75]},"per":{"$ref":"#/components/schemas/PublicPayRatePer_1"}},"required":["currency","amount","per"],"additionalProperties":false,"description":"The pay rate for the contractor. Leave this blank if you'd like to pay this contractor on-demand or via invoicing."},{"type":"null"}],"description":"The contractor's pay rate. Omit if you'd like to pay on-demand or via invoicing."},{"type":"null"}]},"paySchedule":{"anyOf":[{"anyOf":[{"type":"string","enum":["weekly","biweekly","monthly","semimonthly","quarterly","annually"]},{"type":"null"}],"description":"The contractor's pay schedule. Must be a pay schedule that the company has configured."},{"type":"null"}]}},"required":["entityType","firstName","lastName","position","startDate","email","departmentId","managerId","workCountry"],"additionalProperties":false}}},"required":true}}},"/v1/workers/{id}/invite":{"post":{"tags":["Workers"],"operationId":"Workers.invite","parameters":[{"name":"id","in":"path","schema":{"type":"string","pattern":"^wrk_","description":"The id of the worker.","examples":["wrk_1234"]},"required":true}],"security":[{"apiKey":[]}],"responses":{"201":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","pattern":"^wrk_","description":"The id of the worker.","examples":["wrk_1234"]},"position":{"type":"string","examples":["Research Engineer"]},"type":{"type":"string","enum":["employee","contractor"]},"status":{"type":"string","enum":["draft","invited","onboarding","active","offboarding","inactive"]},"benefitEligible":{"type":"boolean","allOf":[{"description":"The worker's stored benefits eligibility flag.","examples":[true,false]}]},"startDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","allOf":[{"description":"The worker's employment start date. Reactivation after an offboarding is reported separately in latestRehireDate.","examples":["2022-04-11"]}]},"endDate":{"anyOf":[{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},{"type":"null"}],"allOf":[{"description":"The worker's final day of employment, or null when employment is ongoing.","examples":["2026-08-15",null]}]},"isBusiness":{"anyOf":[{"type":"boolean"},{"type":"null"}],"examples":[false]},"businessName":{"anyOf":[{"type":"string"},{"type":"null"}],"examples":[null,"Galt Enterprises, LLC"]},"firstName":{"type":"string","examples":["Jonathan","Melissa"]},"lastName":{"type":"string","examples":["Galt","Jones"]},"email":{"type":"string","format":"email","title":"Email","description":"An email with a reasonably valid regex (based on RFC 5321 atext characters)","examples":["john@joinwarp.com"]},"workEmail":{"anyOf":[{"type":"string","format":"email","title":"Email","description":"An email with a reasonably valid regex (based on RFC 5321 atext characters)","examples":["john@joinwarp.com"]},{"type":"null"}]},"preferredName":{"anyOf":[{"type":"string","examples":["John"]},{"type":"null"}]},"biologicalSex":{"anyOf":[{"type":"string","enum":["male","female"]},{"type":"null"}],"description":"The worker's biological sex, or null when unavailable.","examples":["female"]},"maritalStatus":{"anyOf":[{"type":"string","enum":["married","not_married"]},{"type":"null"}],"description":"The worker's marital status, or null when unavailable.","examples":["married"]},"dateOfBirth":{"anyOf":[{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},{"type":"null"}],"description":"The worker's date of birth, or null when unavailable.","examples":["1990-06-15"]},"phone":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The worker's personal phone number, or null when unavailable.","examples":["+12025550143"]},"address":{"anyOf":[{"$ref":"#/components/schemas/PublicWorkerAddress"},{"type":"null"}],"description":"The worker's home address, or null when unavailable.","examples":[{"line1":"123 Example Street","line2":"Suite 400","city":"New York","state":"NY","postalCode":"10001","country":"US"}]},"displayName":{"type":"string","description":"The \"ui\" name of a worker. If it's a business contractor business name is used. Otherwise we default to preferred name, then first-last.","examples":["Jack Galt"]},"manager":{"anyOf":[{"$ref":"#/components/schemas/PublicWorkerManager"},{"type":"null"}],"description":"The worker's manager, or null if unassigned.","examples":[{"id":"wrk_3Fna7qP2mL8z","firstName":"Hank","lastName":"Rearden","displayName":"Hank Rearden"},null]},"timeZone":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The IANA timezone of the worker (e.g., America/New_York).","examples":["America/New_York"]},"tShirtSize":{"anyOf":[{"type":"string","enum":["XS","S","M","L","XL","XXL","XXXL"]},{"type":"null"}],"description":"The worker's stored T-shirt size, or null when unset or unavailable.","examples":["M",null]},"department":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","pattern":"^dpt_","description":"The unique public id of the department","examples":["dpt_1234"]},"name":{"type":"string"}},"required":["id","name"],"additionalProperties":false},{"type":"null"}],"description":"The department the worker belongs to, or null if unassigned.","examples":[{"id":"dpt_7Rqa2mP9xK4c","name":"Engineering"},null]},"primaryWorkplace":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","pattern":"^wkp_","description":"Public workplace identifier","examples":["wkp_1234"]},"name":{"type":"string"},"type":{"type":"string","enum":["remote","office"]}},"required":["id","name","type"],"additionalProperties":false},{"type":"null"}],"description":"The primary workplace the worker is assigned to, or null if unassigned.","examples":[{"id":"wkp_4Nva8qT2mL7z","name":"New York Office","type":"office"},null]},"latestRehireDate":{"anyOf":[{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},{"type":"null"}],"description":"The date the worker was most recently reactivated after an offboarding. This is distinct from startDate and is null if the worker has not been rehired.","examples":["2024-02-05",null]},"terminationReason":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The reason the worker was terminated, or null when no termination reason is recorded.","examples":["Position eliminated",null]},"updatedAt":{"type":"string","examples":["2026-08-20T14:30:00.000Z"]},"level":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","pattern":"^jlvl_","description":"The unique public id of the job level","examples":["jlvl_1234"]},"code":{"type":"string"},"name":{"type":"string"},"track":{"type":"string","enum":["ic","manager","executive"]}},"required":["id","code","name","track"],"additionalProperties":false},{"type":"null"}],"description":"The worker's assigned job level, or null if unassigned. Omitted when job levels are not enabled."},"compensation":{"anyOf":[{"$ref":"#/components/schemas/PublicWorkerCompensation"},{"type":"null"}],"description":"The worker's current regular compensation, or the rate effective on a future start date. Null when the worker has no applicable regular pay rate or the API key lacks the corresponding compensation read scope.","examples":[{"payRateId":"pyr_9Cka3pR8vM2x","per":"year","amount":15000000,"currency":"USD","display":"$150,000.00 / yr"},null]},"customFields":{"anyOf":[{"type":"array","items":{"$ref":"#/components/schemas/PublicWorkerCustomField"},"description":"The worker's custom field values. Every active company custom field appears; fields outside this API key's permission scopes are redacted (value null, redacted true) rather than omitted, so the list is identical across keys. Empty when the company has no custom fields.","examples":[[]]},{"type":"null"}]}},"required":["id","position","type","status","benefitEligible","startDate","endDate","isBusiness","businessName","firstName","lastName","email","workEmail","preferredName","biologicalSex","maritalStatus","dateOfBirth","phone","address","displayName","timeZone","department","primaryWorkplace","latestRehireDate","terminationReason","updatedAt","compensation"],"additionalProperties":false,"description":"A worker profile, including lifecycle, workplace, profile, and compensation fields.","examples":[{"id":"wrk_khac8380c2Lm","position":"Research Engineer","type":"employee","status":"active","benefitEligible":true,"startDate":"2022-04-11","endDate":null,"isBusiness":null,"businessName":null,"firstName":"Jane","lastName":"Doe","email":"jane.doe@example.com","workEmail":"jane.doe@acme.example","preferredName":"Jane","biologicalSex":"female","maritalStatus":"married","dateOfBirth":"1990-06-15","phone":"+12025550143","address":{"line1":"123 Example Street","line2":"Suite 400","city":"New York","state":"NY","postalCode":"10001","country":"US"},"displayName":"Jane Doe","manager":{"id":"wrk_3Fna7qP2mL8z","firstName":"Hank","lastName":"Rearden","displayName":"Hank Rearden"},"timeZone":"America/New_York","tShirtSize":"M","department":{"id":"dpt_7Rqa2mP9xK4c","name":"Engineering"},"primaryWorkplace":{"id":"wkp_4Nva8qT2mL7z","name":"New York Office","type":"office"},"latestRehireDate":"2024-02-05","terminationReason":null,"updatedAt":"2026-08-20T14:30:00.000Z","compensation":{"payRateId":"pyr_9Cka3pR8vM2x","per":"year","amount":15000000,"currency":"USD","display":"$150,000.00 / yr"},"customFields":[]}]}}}},"401":{"description":"ApiKeyUnauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKeyUnauthorizedEncoded"}}}},"403":{"description":"The requested action exceeds your current subscription limits. This may be due to US state limits or missing global payroll access. | MissingRequiredCompanyPermissions | ApiNotEnabled","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/SubscriptionLimitErrorEncoded"},{"$ref":"#/components/schemas/MissingRequiredCompanyPermissionsEncoded"},{"$ref":"#/components/schemas/ApiNotEnabledEncoded"}]}}}},"404":{"description":"The specified worker could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkerNotFoundErrorEncoded"}}}},"409":{"description":"The worker's current status does not allow this action. For example, only draft or invited workers can be invited, and only draft or invited workers can be deleted. | A worker with this email already exists in this organization.","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/InvalidWorkerStatusErrorEncoded"},{"$ref":"#/components/schemas/WorkerAlreadyExistsErrorEncoded"}]}}}},"429":{"description":"RateLimitExceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitExceededEncoded"}}}},"500":{"description":"InternalServerError","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/effect_HttpApiError_InternalServerErrorEncoded"},{"$ref":"#/components/schemas/effect_HttpApiError_InternalServerErrorEncoded"}]}}}}},"description":"Send or resend the worker invite so they can accept and complete onboarding to Warp. If the worker has already been invited, the invite will be resent with extended validity.","summary":"Invite Worker"}},"/v1/workplaces":{"get":{"tags":["Workplaces"],"operationId":"Workplaces.list","parameters":[{"name":"limit","in":"query","schema":{"anyOf":[{"type":"string"},{"type":"null"}]},"required":true},{"name":"afterId","in":"query","schema":{"anyOf":[{"type":"string","pattern":"^wkp_","description":"Public workplace identifier","examples":["wkp_1234"]},{"type":"null"}]},"required":false},{"name":"beforeId","in":"query","schema":{"anyOf":[{"type":"string","pattern":"^wkp_","description":"Public workplace identifier","examples":["wkp_1234"]},{"type":"null"}]},"required":false}],"security":[{"apiKey":[]}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"hasMore":{"type":"boolean"},"count":{"type":"integer"},"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","pattern":"^wkp_","description":"Public workplace identifier","examples":["wkp_1234"]},"name":{"type":"string","examples":["Warp HQ","Remote - John Doe"]},"type":{"type":"string","enum":["remote","office"]},"status":{"type":"string","enum":["active","archived"]},"address":{"type":"object","properties":{"line1":{"type":"string","minLength":1},"line2":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"null"}]},{"type":"null"}]},"city":{"type":"string"},"postalCode":{"type":"string"},"state":{"type":"string","enum":["AL","AK","AZ","AR","CA","CO","CT","DC","DE","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY"]},"country":{"type":"string","enum":["US"]}},"required":["line1","city","postalCode","state","country"],"additionalProperties":false,"description":"A valid US address"},"createdAt":{"type":"string"}},"required":["id","name","type","status","address","createdAt"],"additionalProperties":false}}},"required":["hasMore","count","data"],"additionalProperties":false}}}},"401":{"description":"ApiKeyUnauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKeyUnauthorizedEncoded"}}}},"403":{"description":"MissingRequiredCompanyPermissions | ApiNotEnabled","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/MissingRequiredCompanyPermissionsEncoded"},{"$ref":"#/components/schemas/ApiNotEnabledEncoded"}]}}}},"429":{"description":"RateLimitExceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitExceededEncoded"}}}},"500":{"description":"InternalServerError","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/effect_HttpApiError_InternalServerErrorEncoded"},{"$ref":"#/components/schemas/effect_HttpApiError_InternalServerErrorEncoded"}]}}}}},"description":"List all workplaces for your company.","summary":"List Workplaces"},"post":{"tags":["Workplaces"],"operationId":"Workplaces.create","parameters":[],"security":[{"apiKey":[]}],"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","pattern":"^wkp_","description":"Public workplace identifier","examples":["wkp_1234"]},"name":{"type":"string","examples":["Warp HQ","Remote - John Doe"]},"type":{"type":"string","enum":["remote","office"]},"status":{"type":"string","enum":["active","archived"]},"address":{"type":"object","properties":{"line1":{"type":"string","minLength":1},"line2":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"null"}]},{"type":"null"}]},"city":{"type":"string"},"postalCode":{"type":"string"},"state":{"type":"string","enum":["AL","AK","AZ","AR","CA","CO","CT","DC","DE","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY"]},"country":{"type":"string","enum":["US"]}},"required":["line1","city","postalCode","state","country"],"additionalProperties":false,"description":"A valid US address"},"createdAt":{"type":"string"}},"required":["id","name","type","status","address","createdAt"],"additionalProperties":false}}}},"400":{"description":"AddressInvalid","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddressInvalidEncoded"}}}},"401":{"description":"ApiKeyUnauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKeyUnauthorizedEncoded"}}}},"403":{"description":"MissingRequiredCompanyPermissions | ApiNotEnabled","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/MissingRequiredCompanyPermissionsEncoded"},{"$ref":"#/components/schemas/ApiNotEnabledEncoded"}]}}}},"409":{"description":"WorkplaceAlreadyExists","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkplaceAlreadyExistsEncoded"}}}},"429":{"description":"RateLimitExceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitExceededEncoded"}}}},"500":{"description":"InternalServerError","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/effect_HttpApiError_InternalServerErrorEncoded"},{"$ref":"#/components/schemas/effect_HttpApiError_InternalServerErrorEncoded"}]}}}}},"description":"Create a new workplace.","summary":"Create Workplace","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","pattern":"^\\S[\\s\\S]*\\S$|^\\S$|^$","minLength":1},"type":{"type":"string","enum":["remote","office"]},"address":{"type":"object","properties":{"line1":{"type":"string","minLength":1},"line2":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"null"}]},{"type":"null"}]},"city":{"type":"string"},"postalCode":{"type":"string"},"state":{"type":"string","enum":["AL","AK","AZ","AR","CA","CO","CT","DC","DE","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY"]},"country":{"type":"string","enum":["US"]}},"required":["line1","city","postalCode","state","country"],"additionalProperties":false,"description":"A valid US address"}},"required":["name","type","address"],"additionalProperties":false}}},"required":true}}},"/v1/workplaces/{id}":{"patch":{"tags":["Workplaces"],"operationId":"Workplaces.update","parameters":[{"name":"id","in":"path","schema":{"type":"string","pattern":"^wkp_","description":"Public workplace identifier","examples":["wkp_1234"]},"required":true}],"security":[{"apiKey":[]}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","pattern":"^wkp_","description":"Public workplace identifier","examples":["wkp_1234"]},"name":{"type":"string","examples":["Warp HQ","Remote - John Doe"]},"type":{"type":"string","enum":["remote","office"]},"status":{"type":"string","enum":["active","archived"]},"address":{"type":"object","properties":{"line1":{"type":"string","minLength":1},"line2":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"null"}]},{"type":"null"}]},"city":{"type":"string"},"postalCode":{"type":"string"},"state":{"type":"string","enum":["AL","AK","AZ","AR","CA","CO","CT","DC","DE","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY"]},"country":{"type":"string","enum":["US"]}},"required":["line1","city","postalCode","state","country"],"additionalProperties":false,"description":"A valid US address"},"createdAt":{"type":"string"}},"required":["id","name","type","status","address","createdAt"],"additionalProperties":false}}}},"401":{"description":"ApiKeyUnauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKeyUnauthorizedEncoded"}}}},"403":{"description":"MissingRequiredCompanyPermissions | ApiNotEnabled","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/MissingRequiredCompanyPermissionsEncoded"},{"$ref":"#/components/schemas/ApiNotEnabledEncoded"}]}}}},"404":{"description":"WorkplaceNotFound","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkplaceNotFoundEncoded"}}}},"409":{"description":"WorkplaceAlreadyExists","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkplaceAlreadyExistsEncoded"}}}},"429":{"description":"RateLimitExceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitExceededEncoded"}}}},"500":{"description":"InternalServerError","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/effect_HttpApiError_InternalServerErrorEncoded"},{"$ref":"#/components/schemas/effect_HttpApiError_InternalServerErrorEncoded"}]}}}}},"description":"Update an existing workplace.","summary":"Update Workplace","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}]}},"additionalProperties":false}}},"required":true}}}},"components":{"schemas":{"PublicWorkerAddress":{"type":"object","properties":{"line1":{"type":"string","allOf":[{"description":"The first line of the home street address.","examples":["123 Example Street"]}]},"line2":{"anyOf":[{"type":"string"},{"type":"null"}],"allOf":[{"description":"The second line of the home street address, or null when unused.","examples":["Suite 400"]}]},"city":{"type":"string","allOf":[{"description":"The home address city or locality.","examples":["New York"]}]},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"allOf":[{"description":"The home address state, province, or region, or null when not applicable.","examples":["NY"]}]},"postalCode":{"anyOf":[{"type":"string"},{"type":"null"}],"allOf":[{"description":"The home address postal code, or null when unavailable.","examples":["10001"]}]},"country":{"type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"],"allOf":[{"description":"The ISO 3166-1 alpha-2 country code of the home address.","examples":["US"]}]}},"required":["line1","line2","city","state","postalCode","country"],"additionalProperties":false,"description":"The worker's home address.","examples":[{"line1":"123 Example Street","line2":"Suite 400","city":"New York","state":"NY","postalCode":"10001","country":"US"}]},"PublicWorkerManager":{"type":"object","properties":{"id":{"type":"string","pattern":"^wrk_","description":"The id of the worker.","examples":["wrk_1234"],"allOf":[{"description":"The manager's worker ID.","examples":["wrk_3Fna7qP2mL8z"]}]},"firstName":{"type":"string","allOf":[{"description":"The manager's first name.","examples":["Hank"]}]},"lastName":{"type":"string","allOf":[{"description":"The manager's last name.","examples":["Rearden"]}]},"displayName":{"type":"string","allOf":[{"description":"The manager's display name.","examples":["Hank Rearden"]}]}},"required":["id","firstName","lastName","displayName"],"additionalProperties":false,"description":"The worker's manager.","examples":[{"id":"wrk_3Fna7qP2mL8z","firstName":"Hank","lastName":"Rearden","displayName":"Hank Rearden"}]},"PublicPayRatePer":{"type":"string","enum":["year","month","week","hour"],"description":"The period represented by the pay rate amount."},"PublicWorkerCompensation":{"type":"object","properties":{"payRateId":{"type":"string","pattern":"^pyr_","description":"The tag of the pay rate.","examples":["pyr_1234"],"allOf":[{"description":"The ID of the regular pay rate represented here.","examples":["pyr_9Cka3pR8vM2x"]}]},"per":{"allOf":[{"$ref":"#/components/schemas/PublicPayRatePer"},{"description":"The period represented by the pay rate amount.","examples":["year"]}]},"amount":{"type":"integer","description":"minor units — cents, e.g. 2345 for $23.45","allOf":[{"minimum":0,"description":"Amount in the currency base unit, e.g. cents for USD."},{"description":"The pay rate in integer minor currency units, such as cents for USD.","examples":[15000000]}]},"currency":{"type":"string","enum":["USD","AUD","BGN","BRL","CAD","CHF","CZK","DKK","EUR","GBP","HKD","HUF","IDR","INR","JPY","MYR","NOK","NZD","CNY","PLN","RON","TRY","SEK","SGD","AED","ARS","BDT","BWP","CLP","COP","CRC","EGP","FJD","GEL","GHS","ILS","KES","KRW","LKR","MAD","MXN","NPR","PHP","PKR","THB","UAH","UGX","UYU","VND","ZAR","ZMW","TND","NGN","RSD","TWD","GTQ","HNL","DOP","SAR","XAF","PEN"],"allOf":[{"description":"The ISO 4217 currency of the pay rate.","examples":["USD"]}]},"display":{"type":"string","description":"The server-formatted pay rate, including its period.","examples":["$150,000.00 / yr","$10,000.00 / month","$50.00 / hr"]}},"required":["payRateId","per","amount","currency","display"],"additionalProperties":false,"description":"The worker's current regular pay rate. For a worker whose start date is in the future, this is the regular rate effective on their start date. Null when no regular rate applies or when the API key lacks the corresponding US or global compensation read scope.","examples":[{"payRateId":"pyr_9Cka3pR8vM2x","per":"year","amount":15000000,"currency":"USD","display":"$150,000.00 / yr"}]},"PublicTextWorkerCustomField":{"type":"object","properties":{"type":{"type":"string","enum":["text"]},"id":{"type":"string","pattern":"^cf_","description":"The tag of a company custom worker field.","examples":["cf_1234"]},"name":{"type":"string"},"redacted":{"type":"boolean","description":"True when this API key’s permission scopes cannot read the field’s category. The value fields are withheld (null), not absent — null does not imply the worker has no value."},"display":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The value rendered as the Warp dashboard displays it; null when unset or redacted."},"value":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The worker’s text; null when unset or when the field is redacted for this API key."}},"required":["type","id","name","redacted","display","value"],"additionalProperties":false},"PublicNumberWorkerCustomField":{"type":"object","properties":{"type":{"type":"string","enum":["number"]},"id":{"type":"string","pattern":"^cf_","description":"The tag of a company custom worker field.","examples":["cf_1234"]},"name":{"type":"string"},"redacted":{"type":"boolean","description":"True when this API key’s permission scopes cannot read the field’s category. The value fields are withheld (null), not absent — null does not imply the worker has no value."},"display":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The value rendered as the Warp dashboard displays it; null when unset or redacted."},"value":{"anyOf":[{"anyOf":[{"type":"number"},{"type":"string","enum":["Infinity","-Infinity","NaN"]}]},{"type":"null"}],"description":"The worker’s number; null when unset or when the field is redacted for this API key."}},"required":["type","id","name","redacted","display","value"],"additionalProperties":false},"PublicDateWorkerCustomField":{"type":"object","properties":{"type":{"type":"string","enum":["date"]},"id":{"type":"string","pattern":"^cf_","description":"The tag of a company custom worker field.","examples":["cf_1234"]},"name":{"type":"string"},"redacted":{"type":"boolean","description":"True when this API key’s permission scopes cannot read the field’s category. The value fields are withheld (null), not absent — null does not imply the worker has no value."},"display":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The value rendered as the Warp dashboard displays it; null when unset or redacted."},"value":{"anyOf":[{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},{"type":"null"}],"description":"The worker’s date; null when unset or when the field is redacted for this API key."}},"required":["type","id","name","redacted","display","value"],"additionalProperties":false},"PublicBooleanWorkerCustomField":{"type":"object","properties":{"type":{"type":"string","enum":["boolean"]},"id":{"type":"string","pattern":"^cf_","description":"The tag of a company custom worker field.","examples":["cf_1234"]},"name":{"type":"string"},"redacted":{"type":"boolean","description":"True when this API key’s permission scopes cannot read the field’s category. The value fields are withheld (null), not absent — null does not imply the worker has no value."},"display":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The value rendered as the Warp dashboard displays it; null when unset or redacted."},"value":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"The worker’s answer; null when unset or when the field is redacted for this API key."}},"required":["type","id","name","redacted","display","value"],"additionalProperties":false},"PublicCurrencyWorkerCustomField":{"type":"object","properties":{"type":{"type":"string","enum":["currency"]},"id":{"type":"string","pattern":"^cf_","description":"The tag of a company custom worker field.","examples":["cf_1234"]},"name":{"type":"string"},"redacted":{"type":"boolean","description":"True when this API key’s permission scopes cannot read the field’s category. The value fields are withheld (null), not absent — null does not imply the worker has no value."},"display":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The value rendered as the Warp dashboard displays it; null when unset or redacted."},"amount":{"anyOf":[{"type":"integer","description":"minor units — cents, e.g. 2345 for $23.45"},{"type":"null"}],"description":"The amount in integer base units of currencyCode (e.g. cents); null when unset or when the field is redacted for this API key."},"currencyCode":{"anyOf":[{"type":"string","enum":["USD","AUD","BGN","BRL","CAD","CHF","CZK","DKK","EUR","GBP","HKD","HUF","IDR","INR","JPY","MYR","NOK","NZD","CNY","PLN","RON","TRY","SEK","SGD","AED","ARS","BDT","BWP","CLP","COP","CRC","EGP","FJD","GEL","GHS","ILS","KES","KRW","LKR","MAD","MXN","NPR","PHP","PKR","THB","UAH","UGX","UYU","VND","ZAR","ZMW","TND","NGN","RSD","TWD","GTQ","HNL","DOP","SAR","XAF","PEN"]},{"type":"null"}],"description":"The amount’s currency; null when unset or when the field is redacted for this API key."}},"required":["type","id","name","redacted","display","amount","currencyCode"],"additionalProperties":false},"PublicPercentageWorkerCustomField":{"type":"object","properties":{"type":{"type":"string","enum":["percentage"]},"id":{"type":"string","pattern":"^cf_","description":"The tag of a company custom worker field.","examples":["cf_1234"]},"name":{"type":"string"},"redacted":{"type":"boolean","description":"True when this API key’s permission scopes cannot read the field’s category. The value fields are withheld (null), not absent — null does not imply the worker has no value."},"display":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The value rendered as the Warp dashboard displays it; null when unset or redacted."},"value":{"anyOf":[{"anyOf":[{"type":"number"},{"type":"string","enum":["Infinity","-Infinity","NaN"]}]},{"type":"null"}],"description":"The worker’s percentage; null when unset or when the field is redacted for this API key."}},"required":["type","id","name","redacted","display","value"],"additionalProperties":false},"PublicSelectWorkerCustomField":{"type":"object","properties":{"type":{"type":"string","enum":["select"]},"id":{"type":"string","pattern":"^cf_","description":"The tag of a company custom worker field.","examples":["cf_1234"]},"name":{"type":"string"},"redacted":{"type":"boolean","description":"True when this API key’s permission scopes cannot read the field’s category. The value fields are withheld (null), not absent — null does not imply the worker has no value."},"display":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The value rendered as the Warp dashboard displays it; null when unset or redacted."},"option":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","pattern":"^cfo_","description":"The tag of a company custom worker field option.","examples":["cfo_1234"]},"label":{"type":"string"},"value":{"type":"string"},"sortOrder":{"anyOf":[{"type":"number"},{"type":"string","enum":["Infinity","-Infinity","NaN"]}]},"status":{"type":"string","enum":["active","archived"]},"createdAt":{"type":"string"}},"required":["id","label","value","sortOrder","status","createdAt"],"additionalProperties":false},{"type":"null"}],"description":"The selected option; null when unset or when the field is redacted for this API key."}},"required":["type","id","name","redacted","display","option"],"additionalProperties":false},"PublicMultiSelectWorkerCustomField":{"type":"object","properties":{"type":{"type":"string","enum":["multi_select"]},"id":{"type":"string","pattern":"^cf_","description":"The tag of a company custom worker field.","examples":["cf_1234"]},"name":{"type":"string"},"redacted":{"type":"boolean","description":"True when this API key’s permission scopes cannot read the field’s category. The value fields are withheld (null), not absent — null does not imply the worker has no value."},"display":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The value rendered as the Warp dashboard displays it; null when unset or redacted."},"options":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","pattern":"^cfo_","description":"The tag of a company custom worker field option.","examples":["cfo_1234"]},"label":{"type":"string"},"value":{"type":"string"},"sortOrder":{"anyOf":[{"type":"number"},{"type":"string","enum":["Infinity","-Infinity","NaN"]}]},"status":{"type":"string","enum":["active","archived"]},"createdAt":{"type":"string"}},"required":["id","label","value","sortOrder","status","createdAt"],"additionalProperties":false}},{"type":"null"}],"description":"The selected options; null when unset or when the field is redacted for this API key."}},"required":["type","id","name","redacted","display","options"],"additionalProperties":false},"PublicWorkerCustomField":{"anyOf":[{"$ref":"#/components/schemas/PublicTextWorkerCustomField"},{"$ref":"#/components/schemas/PublicNumberWorkerCustomField"},{"$ref":"#/components/schemas/PublicDateWorkerCustomField"},{"$ref":"#/components/schemas/PublicBooleanWorkerCustomField"},{"$ref":"#/components/schemas/PublicCurrencyWorkerCustomField"},{"$ref":"#/components/schemas/PublicPercentageWorkerCustomField"},{"$ref":"#/components/schemas/PublicSelectWorkerCustomField"},{"$ref":"#/components/schemas/PublicMultiSelectWorkerCustomField"}]},"PublicMoneyAmount":{"type":"object","properties":{"amount":{"type":"integer","description":"minor units — cents, e.g. 2345 for $23.45","allOf":[{"minimum":0,"description":"Amount in the currency base unit, e.g. cents for USD."}]},"currency":{"type":"string","enum":["USD","AUD","BGN","BRL","CAD","CHF","CZK","DKK","EUR","GBP","HKD","HUF","IDR","INR","JPY","MYR","NOK","NZD","CNY","PLN","RON","TRY","SEK","SGD","AED","ARS","BDT","BWP","CLP","COP","CRC","EGP","FJD","GEL","GHS","ILS","KES","KRW","LKR","MAD","MXN","NPR","PHP","PKR","THB","UAH","UGX","UYU","VND","ZAR","ZMW","TND","NGN","RSD","TWD","GTQ","HNL","DOP","SAR","XAF","PEN"]},"display":{"type":"string","description":"The server-formatted display string for the amount in its currency.","examples":["$150,000.00","$85.50"]}},"required":["amount","currency","display"],"additionalProperties":false,"description":"A monetary amount with its currency and server-formatted display value."},"PublicHealthPlanStatus":{"type":"string","enum":["active","terminated"],"description":"The public lifecycle status of a health plan."},"PublicHealthPlanCarrier":{"type":"object","properties":{"id":{"type":"string","pattern":"^car_","description":"The tag of a carrier.","examples":["car_1234"]},"name":{"type":"string","description":"The carrier name."}},"required":["id","name"],"additionalProperties":false,"description":"The insurance carrier underwriting the health plan."},"PublicHealthPlan":{"type":"object","properties":{"id":{"type":"string","pattern":"^chpl_","description":"The tag of a company health plan.","examples":["chpl_1234"]},"carrier":{"$ref":"#/components/schemas/PublicHealthPlanCarrier"},"type":{"type":"string","enum":["medical","dental","vision","life","short_term_disability","long_term_disability","accident","critical_illness","hospital"],"description":"The health coverage type."},"name":{"type":"string","description":"The company-facing plan name."},"groupNumber":{"anyOf":[{"type":"string","description":"Group number assigned by the carrier for this health plan.","examples":["GRP-12345"]},{"type":"null"}],"description":"The carrier-assigned group number."},"networkType":{"anyOf":[{"type":"string","enum":["hmo","ppo","epo","pos","hdhp","indemnity"]},{"type":"null"}],"description":"The plan network structure."},"effectiveStartDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"effectiveEndDate":{"anyOf":[{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},{"type":"null"}]},"status":{"$ref":"#/components/schemas/PublicHealthPlanStatus"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"}},"required":["id","carrier","type","name","groupNumber","networkType","effectiveStartDate","effectiveEndDate","status","createdAt","updatedAt"],"additionalProperties":false,"description":"A company health plan available through Warp."},"effect_HttpApiError_InternalServerErrorEncoded":{"type":"object","properties":{"_tag":{"type":"string","enum":["InternalServerError"]}},"required":["_tag"],"additionalProperties":false},"ApiKeyUnauthorizedEncoded":{"type":"object","properties":{"_tag":{"type":"string","enum":["ApiKeyUnauthorized"]},"message":{"type":"string"}},"required":["_tag","message"],"additionalProperties":false},"RateLimitExceededEncoded":{"type":"object","properties":{"_tag":{"type":"string","enum":["RateLimitExceeded"]},"retryAt":{"type":"string"},"message":{"type":"string"}},"required":["_tag","retryAt","message"],"additionalProperties":false},"MissingRequiredCompanyPermissionsEncoded":{"type":"object","properties":{"_tag":{"type":"string","enum":["MissingRequiredCompanyPermissions"]},"requiredPermissions":{"type":"array","items":{"type":"object","properties":{"scope":{"type":"string","enum":["workers:profile","workers:global:compensation","workers:us:compensation","workers:compliance","workers:pii","workers:banking","workers:access","workers:dependents","workers:dependents:pii","workers:custom_fields","payrolls:global","payrolls:us","pay_schedules","offers","departments","levels","performance","workplaces","time_off","time_tracking","expenses","general_ledger","benefits","tax_compliance","kyb","mdm","lms","authorized_users","billing","settings","developer","ai_spend"]},"level":{"type":"string","enum":["read","write","manage"]}},"required":["scope","level"],"additionalProperties":false}},"message":{"type":"string"}},"required":["_tag","requiredPermissions","message"],"additionalProperties":false},"ApiNotEnabledEncoded":{"type":"object","properties":{"_tag":{"type":"string","enum":["ApiNotEnabled"]},"message":{"type":"string"}},"required":["_tag","message"],"additionalProperties":false},"HealthPlanNotFoundErrorEncoded":{"type":"object","properties":{"_tag":{"type":"string","enum":["HealthPlanNotFoundError"]},"id":{"type":"string","pattern":"^chpl_","description":"The tag of a company health plan.","examples":["chpl_1234"]},"message":{"type":"string"}},"required":["_tag","id","message"],"additionalProperties":false},"PublicRetirementPlanStatus":{"type":"string","enum":["active","terminated"],"description":"The public lifecycle status of a retirement plan."},"PublicRetirementPlanProvider":{"type":"string","enum":["manual","human_interest","accrue"],"description":"The system administering the plan. Manual plans are administered by the company outside a connected provider."},"PublicRetirementPlan":{"type":"object","properties":{"id":{"type":"string","pattern":"^crpl_","description":"The tag of a company retirement plan.","examples":["crpl_1234"]},"type":{"type":"string","enum":["401k","roth_401k","403b","roth_403b","457","roth_457","simple_ira","roth_simple_ira"],"description":"The retirement plan type."},"name":{"type":"string","description":"The company-facing plan name."},"provider":{"$ref":"#/components/schemas/PublicRetirementPlanProvider"},"effectiveStartDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"effectiveEndDate":{"anyOf":[{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},{"type":"null"}]},"status":{"$ref":"#/components/schemas/PublicRetirementPlanStatus"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"}},"required":["id","type","name","provider","effectiveStartDate","effectiveEndDate","status","createdAt","updatedAt"],"additionalProperties":false,"description":"A company retirement plan available through Warp."},"RetirementPlanNotFoundErrorEncoded":{"type":"object","properties":{"_tag":{"type":"string","enum":["RetirementPlanNotFoundError"]},"id":{"type":"string","pattern":"^crpl_","description":"The tag of a company retirement plan.","examples":["crpl_1234"]},"message":{"type":"string"}},"required":["_tag","id","message"],"additionalProperties":false},"PublicBenefitDeductionCategory":{"type":"string","enum":["health","retirement","health_savings","commuter","voluntary","post_tax","other"],"description":"The broad reporting category. The type field identifies the specific payroll deduction."},"PublicBenefitDeductionStatus":{"type":"string","enum":["active","pending","suspended","terminated"],"description":"The public lifecycle status of the current deduction version."},"PublicWorkerReference":{"type":"object","properties":{"id":{"type":"string","pattern":"^wrk_","description":"The worker id.","examples":["wrk_1234"]},"firstName":{"type":"string","description":"The worker first name."},"lastName":{"type":"string","description":"The worker last name."}},"required":["id","firstName","lastName"],"additionalProperties":false,"description":"Basic identifying information for a worker associated with another resource."},"HealthPlanReference":{"type":"object","properties":{"type":{"type":"string","enum":["health_plan"]},"id":{"type":"string","pattern":"^chpl_","description":"The tag of a company health plan.","examples":["chpl_1234"]},"name":{"type":"string","description":"The associated health plan name."}},"required":["type","id","name"],"additionalProperties":false,"description":"The health plan associated with the deduction."},"RetirementPlanReference":{"type":"object","properties":{"type":{"type":"string","enum":["retirement_plan"]},"id":{"type":"string","pattern":"^crpl_","description":"The tag of a company retirement plan.","examples":["crpl_1234"]},"name":{"type":"string","description":"The associated retirement plan name."}},"required":["type","id","name"],"additionalProperties":false,"description":"The retirement plan associated with the deduction."},"PublicBenefitDeductionPlan":{"anyOf":[{"anyOf":[{"$ref":"#/components/schemas/HealthPlanReference"},{"$ref":"#/components/schemas/RetirementPlanReference"}]},{"type":"null"}],"description":"The associated benefit plan, or null for a planless payroll deduction."},"FixedAmountBenefitCalculation":{"type":"object","properties":{"type":{"type":"string","enum":["fixed_amount"]},"frequency":{"anyOf":[{"type":"string","enum":["per_paycheck","monthly"]},{"type":"null"}],"description":"The fixed-amount expression frequency. Null for a one-time deduction."},"employeeContribution":{"$ref":"#/components/schemas/PublicMoneyAmount"},"employerContribution":{"$ref":"#/components/schemas/PublicMoneyAmount"}},"required":["type","frequency","employeeContribution","employerContribution"],"additionalProperties":false,"description":"Employee and employer contributions expressed as fixed monetary amounts."},"PercentageContribution":{"type":"object","properties":{"percentage":{"anyOf":[{"type":"number"},{"type":"string","enum":["Infinity","-Infinity","NaN"]}]},"display":{"type":"string","description":"The server-formatted percentage, for example \"3%\"."}},"required":["percentage","display"],"additionalProperties":false,"description":"A contribution expressed as a percentage of eligible earnings."},"PercentageBenefitCalculation":{"type":"object","properties":{"type":{"type":"string","enum":["percentage"]},"employeeContribution":{"$ref":"#/components/schemas/PercentageContribution"},"employerContribution":{"$ref":"#/components/schemas/PercentageContribution"}},"required":["type","employeeContribution","employerContribution"],"additionalProperties":false,"description":"Employee and employer contributions expressed as percentages of eligible earnings."},"PublicBenefitDeductionCalculation":{"anyOf":[{"$ref":"#/components/schemas/FixedAmountBenefitCalculation"},{"$ref":"#/components/schemas/PercentageBenefitCalculation"}],"description":"How the employee and employer contributions are calculated."},"PublicBenefitDeduction":{"type":"object","properties":{"id":{"type":"string","pattern":"^pbdg_","description":"Stable identifier shared by every internal version of this deduction.","examples":["pbdg_1234"]},"worker":{"$ref":"#/components/schemas/PublicWorkerReference"},"name":{"type":"string","description":"The deduction name shown in payroll and benefits surfaces."},"category":{"$ref":"#/components/schemas/PublicBenefitDeductionCategory"},"type":{"type":"string","enum":["medical","dental","vision","life","short_term_disability","long_term_disability","401k","roth_401k","403b","roth_403b","457","roth_457","hsa","fsa_medical","fsa_dependent_care","transit","parking","accident","cancer","critical_illness","hospital","medical_other","simple_ira","roth_simple_ira","nqdc","nontaxable_fringe","pucc","voluntary","post_tax","other"],"description":"The specific payroll deduction type within the broader category."},"recurrence":{"type":"string","enum":["recurring","one_time"],"description":"Whether the deduction recurs or applies once."},"plan":{"$ref":"#/components/schemas/PublicBenefitDeductionPlan"},"calculation":{"$ref":"#/components/schemas/PublicBenefitDeductionCalculation"},"effectiveStartDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"effectiveEndDate":{"anyOf":[{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},{"type":"null"}]},"status":{"$ref":"#/components/schemas/PublicBenefitDeductionStatus"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"}},"required":["id","worker","name","category","type","recurrence","plan","calculation","effectiveStartDate","effectiveEndDate","status","createdAt","updatedAt"],"additionalProperties":false,"description":"The current version of a stable payroll benefit deduction."},"BenefitDeductionNotFoundErrorEncoded":{"type":"object","properties":{"_tag":{"type":"string","enum":["BenefitDeductionNotFoundError"]},"id":{"type":"string","pattern":"^pbdg_","description":"The version-group tag of a payroll benefit deduction. Stable across edits.","examples":["pbdg_1234"]},"message":{"type":"string"}},"required":["_tag","id","message"],"additionalProperties":false},"BenefitDeductionWriteType":{"type":"string","enum":["medical","dental","vision","life","short_term_disability","long_term_disability","401k","roth_401k","403b","roth_403b","457","roth_457","simple_ira","roth_simple_ira","hsa","fsa_medical","fsa_dependent_care","transit","parking","accident","cancer","critical_illness","hospital","medical_other","nqdc","nontaxable_fringe"],"description":"The payroll deduction type to create."},"BenefitPlanInput":{"anyOf":[{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["health_plan"]},"id":{"type":"string","pattern":"^chpl_","description":"The tag of a company health plan.","examples":["chpl_1234"]}},"required":["type","id"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["retirement_plan"]},"id":{"type":"string","pattern":"^crpl_","description":"The tag of a company retirement plan.","examples":["crpl_1234"]}},"required":["type","id"],"additionalProperties":false}]},{"type":"null"}],"description":"A matching company plan, or null for a planless deduction."},"BenefitMoneyInput":{"type":"object","properties":{"amount":{"type":"integer","description":"minor units — cents, e.g. 2345 for $23.45","allOf":[{"minimum":0,"description":"Amount in the currency base unit, e.g. cents for USD."}]},"currency":{"type":"string","enum":["USD","AUD","BGN","BRL","CAD","CHF","CZK","DKK","EUR","GBP","HKD","HUF","IDR","INR","JPY","MYR","NOK","NZD","CNY","PLN","RON","TRY","SEK","SGD","AED","ARS","BDT","BWP","CLP","COP","CRC","EGP","FJD","GEL","GHS","ILS","KES","KRW","LKR","MAD","MXN","NPR","PHP","PKR","THB","UAH","UGX","UYU","VND","ZAR","ZMW","TND","NGN","RSD","TWD","GTQ","HNL","DOP","SAR","XAF","PEN"]}},"required":["amount","currency"],"additionalProperties":false,"description":"A non-negative amount in cents. Currently only USD is accepted."},"FixedAmountBenefitInput":{"type":"object","properties":{"type":{"type":"string","enum":["fixed_amount"]},"frequency":{"anyOf":[{"type":"string","enum":["monthly","per_paycheck"]},{"type":"null"}]},"employeeContribution":{"$ref":"#/components/schemas/BenefitMoneyInput"},"employerContribution":{"$ref":"#/components/schemas/BenefitMoneyInput"}},"required":["type","frequency","employeeContribution","employerContribution"],"additionalProperties":false,"description":"Fixed contributions. Frequency must be null for one-time deductions."},"PercentageBenefitInput":{"type":"object","properties":{"type":{"type":"string","enum":["percentage"]},"employeeContribution":{"type":"object","properties":{"percentage":{"anyOf":[{"type":"number"},{"type":"string","enum":["Infinity","-Infinity","NaN"]}]}},"required":["percentage"],"additionalProperties":false},"employerContribution":{"type":"object","properties":{"percentage":{"anyOf":[{"type":"number"},{"type":"string","enum":["Infinity","-Infinity","NaN"]}]}},"required":["percentage"],"additionalProperties":false}},"required":["type","employeeContribution","employerContribution"],"additionalProperties":false,"description":"Employee and employer contributions as percentages of eligible earnings."},"BenefitCalculationInput":{"anyOf":[{"$ref":"#/components/schemas/FixedAmountBenefitInput"},{"$ref":"#/components/schemas/PercentageBenefitInput"}],"description":"Both contributions must be supplied."},"CreateBenefitDeduction":{"type":"object","properties":{"workerId":{"type":"string","pattern":"^wrk_","description":"The id of the worker.","examples":["wrk_1234"]},"type":{"$ref":"#/components/schemas/BenefitDeductionWriteType"},"plan":{"anyOf":[{"$ref":"#/components/schemas/BenefitPlanInput"},{"type":"null"}]},"name":{"anyOf":[{"type":"string","pattern":"^\\S[\\s\\S]*\\S$|^\\S$|^$","minLength":1},{"type":"null"}]},"calculation":{"$ref":"#/components/schemas/BenefitCalculationInput"},"recurrence":{"anyOf":[{"type":"string","enum":["recurring","one_time"]},{"type":"null"}]},"effectiveStartDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"effectiveEndDate":{"anyOf":[{"anyOf":[{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},{"type":"null"}]},{"type":"null"}]}},"required":["workerId","type","calculation","effectiveStartDate"],"additionalProperties":false,"description":"Create a deduction for an eligible worker. Per-paycheck amounts are supported for retirement deductions only. No plan is created implicitly."},"PublicBenefitDeduction_1":{"type":"object","properties":{"id":{"type":"string","pattern":"^pbdg_","description":"Stable identifier shared by every internal version of this deduction.","examples":["pbdg_1234"]},"worker":{"$ref":"#/components/schemas/PublicWorkerReference"},"name":{"type":"string","description":"The deduction name shown in payroll and benefits surfaces."},"category":{"$ref":"#/components/schemas/PublicBenefitDeductionCategory"},"type":{"type":"string","enum":["medical","dental","vision","life","short_term_disability","long_term_disability","401k","roth_401k","403b","roth_403b","457","roth_457","hsa","fsa_medical","fsa_dependent_care","transit","parking","accident","cancer","critical_illness","hospital","medical_other","simple_ira","roth_simple_ira","nqdc","nontaxable_fringe","pucc","voluntary","post_tax","other"],"description":"The specific payroll deduction type within the broader category."},"recurrence":{"type":"string","enum":["recurring","one_time"],"description":"Whether the deduction recurs or applies once."},"plan":{"$ref":"#/components/schemas/PublicBenefitDeductionPlan"},"calculation":{"$ref":"#/components/schemas/PublicBenefitDeductionCalculation"},"effectiveStartDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"effectiveEndDate":{"anyOf":[{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},{"type":"null"}]},"status":{"$ref":"#/components/schemas/PublicBenefitDeductionStatus"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"}},"required":["id","worker","name","category","type","recurrence","plan","calculation","effectiveStartDate","effectiveEndDate","status","createdAt","updatedAt"],"additionalProperties":false,"description":"The current version of a stable payroll benefit deduction."},"BenefitWriteNotAllowedErrorEncoded":{"type":"object","properties":{"_tag":{"type":"string","enum":["BenefitWriteNotAllowedError"]},"message":{"type":"string"}},"required":["_tag","message"],"additionalProperties":false},"BenefitConflictErrorEncoded":{"type":"object","properties":{"_tag":{"type":"string","enum":["BenefitConflictError"]},"message":{"type":"string"}},"required":["_tag","message"],"additionalProperties":false},"InvalidBenefitInputErrorEncoded":{"type":"object","properties":{"_tag":{"type":"string","enum":["InvalidBenefitInputError"]},"message":{"type":"string"}},"required":["_tag","message"],"additionalProperties":false},"WorkerNotFoundErrorEncoded":{"type":"object","properties":{"_tag":{"type":"string","enum":["WorkerNotFoundError"]},"id":{"type":"string","pattern":"^wrk_","description":"The id of the worker.","examples":["wrk_1234"]},"message":{"type":"string"}},"required":["_tag","id","message"],"additionalProperties":false},"UpdateBenefitDeduction":{"type":"object","properties":{"name":{"anyOf":[{"type":"string","pattern":"^\\S[\\s\\S]*\\S$|^\\S$|^$","minLength":1},{"type":"null"}]},"calculation":{"anyOf":[{"$ref":"#/components/schemas/BenefitCalculationInput"},{"type":"null"}]},"recurrence":{"anyOf":[{"type":"string","enum":["recurring","one_time"]},{"type":"null"}]},"status":{"anyOf":[{"type":"string","enum":["active","terminated"]},{"type":"null"}]},"effectiveEndDate":{"anyOf":[{"anyOf":[{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},{"type":"null"}]},{"type":"null"}]}},"additionalProperties":false,"description":"Update a deduction using its stable id. Omitted fields are unchanged. Uses the existing manual deduction update rules."},"CreateRetirementPlan":{"type":"object","properties":{"type":{"type":"string","enum":["401k","roth_401k","403b","roth_403b","457","roth_457","simple_ira","roth_simple_ira"]},"name":{"type":"string","pattern":"^\\S[\\s\\S]*\\S$|^\\S$|^$","minLength":1},"effectiveStartDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"}},"required":["type","name","effectiveStartDate"],"additionalProperties":false,"description":"Register a retirement plan for a company using manual retirement administration."},"PublicRetirementPlan_1":{"type":"object","properties":{"id":{"type":"string","pattern":"^crpl_","description":"The tag of a company retirement plan.","examples":["crpl_1234"]},"type":{"type":"string","enum":["401k","roth_401k","403b","roth_403b","457","roth_457","simple_ira","roth_simple_ira"],"description":"The retirement plan type."},"name":{"type":"string","description":"The company-facing plan name."},"provider":{"$ref":"#/components/schemas/PublicRetirementPlanProvider"},"effectiveStartDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"effectiveEndDate":{"anyOf":[{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},{"type":"null"}]},"status":{"$ref":"#/components/schemas/PublicRetirementPlanStatus"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"}},"required":["id","type","name","provider","effectiveStartDate","effectiveEndDate","status","createdAt","updatedAt"],"additionalProperties":false,"description":"A company retirement plan available through Warp."},"UpdateRetirementPlan":{"type":"object","properties":{"name":{"anyOf":[{"type":"string","pattern":"^\\S[\\s\\S]*\\S$|^\\S$|^$","minLength":1},{"type":"null"}]},"effectiveStartDate":{"anyOf":[{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},{"type":"null"}]},"effectiveEndDate":{"anyOf":[{"anyOf":[{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},{"type":"null"}]},{"type":"null"}]}},"additionalProperties":false,"description":"Change plan metadata or dates. Omitted fields are unchanged; null clears the end date."},"PublicCompanyAddress":{"type":"object","properties":{"line1":{"type":"string","minLength":1},"line2":{"anyOf":[{"type":"string"},{"type":"null"}]},"city":{"type":"string"},"postalCode":{"type":"string"},"state":{"type":"string","enum":["AL","AK","AZ","AR","CA","CO","CT","DC","DE","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY"]},"country":{"type":"string","enum":["US"]}},"required":["line1","line2","city","postalCode","state","country"],"additionalProperties":false,"description":"A US company address. The second address line is null when not provided."},"PublicCompanyBusinessType":{"type":"string","enum":["c_corporation","s_corporation","llc","sole_proprietorship","partnership"],"description":"The company’s US business type."},"PublicCompany":{"type":"object","properties":{"id":{"type":"string","pattern":"^com_","description":"The tag of the company.","examples":["com_1234"],"allOf":[{"description":"The stable public ID of the company."}]},"ein":{"type":"string","allOf":[{"minLength":9},{"maxLength":9},{"description":"The unmasked nine-digit Employer Identification Number, without a hyphen. Leading zeros are preserved.","examples":["012345678"]}],"pattern":"^\\d+$","description":"An Employer Identification Number (EIN) is assigned to a US corporation by the IRS to identify them for tax purposes"},"displayName":{"type":"string","pattern":"^\\S[\\s\\S]*\\S$|^\\S$|^$","minLength":1,"description":"The company’s display name."},"legalName":{"type":"string","pattern":"^\\S[\\s\\S]*\\S$|^\\S$|^$","minLength":1,"description":"The company’s legal business name."},"website":{"type":"string","pattern":"^(https?:\\/\\/)?([\\da-z.-]+)\\.([a-z.]{2,6})([/\\w .-]*)*\\/?$","allOf":[{"description":"The company website as stored, which may omit the URL scheme."}]},"phone":{"type":"string","allOf":[{"description":"The company’s contact phone number as stored."}]},"contactEmail":{"type":"string","format":"email","title":"Email","description":"An email with a reasonably valid regex (based on RFC 5321 atext characters)","examples":["john@joinwarp.com"],"allOf":[{"description":"The company’s contact email address."}]},"description":{"type":"string","description":"The company’s business description."},"businessAddress":{"allOf":[{"$ref":"#/components/schemas/PublicCompanyAddress"},{"description":"The business address used for local, state, and federal payroll tax filings."}]},"mailingAddress":{"allOf":[{"$ref":"#/components/schemas/PublicCompanyAddress"},{"description":"The company’s mailing address."}]},"businessType":{"$ref":"#/components/schemas/PublicCompanyBusinessType"},"incorporationState":{"type":"string","enum":["AL","AK","AZ","AR","CA","CO","CT","DC","DE","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY"],"allOf":[{"description":"The US state where the company was incorporated."}]},"incorporationDate":{"anyOf":[{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},{"type":"null"}],"allOf":[{"description":"The incorporation date in YYYY-MM-DD format, or null when not recorded."}]}},"required":["id","ein","displayName","legalName","website","phone","contactEmail","description","businessAddress","mailingAddress","businessType","incorporationState","incorporationDate"],"additionalProperties":false,"description":"Basic identity, contact, address, and incorporation information for your company."},"CompanyNotFoundErrorEncoded":{"type":"object","properties":{"_tag":{"type":"string","enum":["CompanyNotFoundError"]},"message":{"type":"string"}},"required":["_tag","message"],"additionalProperties":false},"CustomFieldAlreadyExistsErrorEncoded":{"type":"object","properties":{"_tag":{"type":"string","enum":["CustomFieldAlreadyExistsError"]},"name":{"type":"string"},"message":{"type":"string"}},"required":["_tag","name","message"],"additionalProperties":false},"CustomFieldOptionAlreadyExistsErrorEncoded":{"type":"object","properties":{"_tag":{"type":"string","enum":["CustomFieldOptionAlreadyExistsError"]},"value":{"type":"string"},"message":{"type":"string"}},"required":["_tag","value","message"],"additionalProperties":false},"InvalidCustomFieldOperationErrorEncoded":{"type":"object","properties":{"_tag":{"type":"string","enum":["InvalidCustomFieldOperationError"]},"message":{"type":"string"}},"required":["_tag","message"],"additionalProperties":false},"CustomFieldNotFoundErrorEncoded":{"type":"object","properties":{"_tag":{"type":"string","enum":["CustomFieldNotFoundError"]},"id":{"type":"string","pattern":"^cf_","description":"The tag of a company custom worker field.","examples":["cf_1234"]},"message":{"type":"string"}},"required":["_tag","id","message"],"additionalProperties":false},"CustomFieldOptionNotFoundErrorEncoded":{"type":"object","properties":{"_tag":{"type":"string","enum":["CustomFieldOptionNotFoundError"]},"id":{"type":"string","pattern":"^cfo_","description":"The tag of a company custom worker field option.","examples":["cfo_1234"]},"message":{"type":"string"}},"required":["_tag","id","message"],"additionalProperties":false},"CustomFieldOptionInUseErrorEncoded":{"type":"object","properties":{"_tag":{"type":"string","enum":["CustomFieldOptionInUseError"]},"id":{"type":"string","pattern":"^cfo_","description":"The tag of a company custom worker field option.","examples":["cfo_1234"]},"message":{"type":"string"}},"required":["_tag","id","message"],"additionalProperties":false},"TextCustomFieldValue":{"type":"object","properties":{"type":{"type":"string","enum":["text"]},"value":{"type":"string"}},"required":["type","value"],"additionalProperties":false},"NumberCustomFieldValue":{"type":"object","properties":{"type":{"type":"string","enum":["number"]},"value":{"anyOf":[{"type":"number"},{"type":"string","enum":["Infinity","-Infinity","NaN"]}]}},"required":["type","value"],"additionalProperties":false},"DateCustomFieldValue":{"type":"object","properties":{"type":{"type":"string","enum":["date"]},"value":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"}},"required":["type","value"],"additionalProperties":false},"BooleanCustomFieldValue":{"type":"object","properties":{"type":{"type":"string","enum":["boolean"]},"value":{"type":"boolean"}},"required":["type","value"],"additionalProperties":false},"CurrencyCustomFieldValue":{"type":"object","properties":{"type":{"type":"string","enum":["currency"]},"amount":{"type":"integer","description":"Integer base units of currencyCode (e.g. cents)."},"currencyCode":{"type":"string","enum":["USD","AUD","BGN","BRL","CAD","CHF","CZK","DKK","EUR","GBP","HKD","HUF","IDR","INR","JPY","MYR","NOK","NZD","CNY","PLN","RON","TRY","SEK","SGD","AED","ARS","BDT","BWP","CLP","COP","CRC","EGP","FJD","GEL","GHS","ILS","KES","KRW","LKR","MAD","MXN","NPR","PHP","PKR","THB","UAH","UGX","UYU","VND","ZAR","ZMW","TND","NGN","RSD","TWD","GTQ","HNL","DOP","SAR","XAF","PEN"]}},"required":["type","amount","currencyCode"],"additionalProperties":false},"PercentageCustomFieldValue":{"type":"object","properties":{"type":{"type":"string","enum":["percentage"]},"value":{"anyOf":[{"type":"number"},{"type":"string","enum":["Infinity","-Infinity","NaN"]}]}},"required":["type","value"],"additionalProperties":false},"SelectCustomFieldValue":{"type":"object","properties":{"type":{"type":"string","enum":["select"]},"option":{"type":"object","properties":{"id":{"type":"string","pattern":"^cfo_","description":"The tag of a company custom worker field option.","examples":["cfo_1234"]},"label":{"type":"string"},"value":{"type":"string"},"sortOrder":{"anyOf":[{"type":"number"},{"type":"string","enum":["Infinity","-Infinity","NaN"]}]},"status":{"type":"string","enum":["active","archived"]},"createdAt":{"type":"string"}},"required":["id","label","value","sortOrder","status","createdAt"],"additionalProperties":false}},"required":["type","option"],"additionalProperties":false},"MultiSelectCustomFieldValue":{"type":"object","properties":{"type":{"type":"string","enum":["multi_select"]},"options":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","pattern":"^cfo_","description":"The tag of a company custom worker field option.","examples":["cfo_1234"]},"label":{"type":"string"},"value":{"type":"string"},"sortOrder":{"anyOf":[{"type":"number"},{"type":"string","enum":["Infinity","-Infinity","NaN"]}]},"status":{"type":"string","enum":["active","archived"]},"createdAt":{"type":"string"}},"required":["id","label","value","sortOrder","status","createdAt"],"additionalProperties":false}}},"required":["type","options"],"additionalProperties":false},"PublicCustomFieldValueOutput":{"anyOf":[{"$ref":"#/components/schemas/TextCustomFieldValue"},{"$ref":"#/components/schemas/NumberCustomFieldValue"},{"$ref":"#/components/schemas/DateCustomFieldValue"},{"$ref":"#/components/schemas/BooleanCustomFieldValue"},{"$ref":"#/components/schemas/CurrencyCustomFieldValue"},{"$ref":"#/components/schemas/PercentageCustomFieldValue"},{"$ref":"#/components/schemas/SelectCustomFieldValue"},{"$ref":"#/components/schemas/MultiSelectCustomFieldValue"}]},"CustomFieldWorkerNotFoundErrorEncoded":{"type":"object","properties":{"_tag":{"type":"string","enum":["CustomFieldWorkerNotFoundError"]},"id":{"type":"string","pattern":"^wrk_","description":"The id of the worker.","examples":["wrk_1234"]},"message":{"type":"string"}},"required":["_tag","id","message"],"additionalProperties":false},"InvalidCustomFieldValueErrorEncoded":{"type":"object","properties":{"_tag":{"type":"string","enum":["InvalidCustomFieldValueError"]},"message":{"type":"string"}},"required":["_tag","message"],"additionalProperties":false},"DepartmentAlreadyExistsEncoded":{"type":"object","properties":{"_tag":{"type":"string","enum":["DepartmentAlreadyExists"]},"id":{"anyOf":[{"type":"string","pattern":"^dpt_","description":"The unique public id of the department","examples":["dpt_1234"]},{"type":"null"}]},"name":{"type":"string"},"message":{"type":"string"}},"required":["_tag","name","message"],"additionalProperties":false},"DepartmentNotFoundEncoded":{"type":"object","properties":{"_tag":{"type":"string","enum":["DepartmentNotFound"]},"id":{"type":"string","pattern":"^dpt_","description":"The unique public id of the department","examples":["dpt_1234"]},"message":{"type":"string"}},"required":["_tag","id","message"],"additionalProperties":false},"PublicI9Verification":{"type":"object","properties":{"id":{"type":"string","pattern":"^i9v_","description":"The tag of the i9 verification.","examples":["i9v_1234"],"allOf":[{"description":"The stable ID of this I-9 verification."}]},"worker":{"$ref":"#/components/schemas/PublicWorkerReference"},"status":{"type":"string","enum":["not_started","awaiting_worker","awaiting_admin","verified"],"allOf":[{"description":"The workflow state: not_started, awaiting_worker action, awaiting_admin review, or verified. Verified indicates workflow completion, not present work-authorization validity."}]},"startDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","allOf":[{"description":"The employment start date recorded on this verification."}]},"verifiedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"allOf":[{"description":"The latest recorded verified time of an I-9 workflow."}]},"retentionUntil":{"anyOf":[{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},{"type":"null"}],"allOf":[{"description":"The retention date recorded by Warp. Null means no finite retention date has been assigned; it does not authorize disposal. This is not an automatic deletion schedule."}]},"dueDate":{"anyOf":[{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},{"type":"null"}],"allOf":[{"description":"Completing this verification clears its due date. Verified I-9s created outside Warp and uploaded by the employer may have a due date if the employee’s work authorization has an expiration date."}]}},"required":["id","worker","status","startDate","verifiedAt","retentionUntil","dueDate"],"additionalProperties":false,"description":"I-9 workflow metadata and basic worker information without document contents or file links."},"InvalidI9VerificationQueryEncoded":{"type":"object","properties":{"_tag":{"type":"string","enum":["InvalidI9VerificationQuery"]},"message":{"type":"string"}},"required":["_tag","message"],"additionalProperties":false},"I9VerificationNotFoundEncoded":{"type":"object","properties":{"_tag":{"type":"string","enum":["I9VerificationNotFound"]},"id":{"anyOf":[{"type":"string","pattern":"^i9v_","description":"The tag of the i9 verification.","examples":["i9v_1234"]},{"type":"null"}]},"legacyWorkerId":{"anyOf":[{"type":"string"},{"type":"null"}]},"message":{"type":"string"}},"required":["_tag","message"],"additionalProperties":false},"PublicBankAccount":{"type":"object","properties":{"id":{"type":"string","pattern":"^bank_","description":"The tag of the bank account.","examples":["bank_1234"]},"institutionName":{"anyOf":[{"type":"string"},{"type":"null"}]},"accountType":{"anyOf":[{"type":"string","enum":["checking","savings"]},{"type":"null"}]},"accountNumberLastFour":{"type":"string","allOf":[{"description":"Last four characters of the account number."}]},"worker":{"$ref":"#/components/schemas/PublicWorkerReference"},"status":{"type":"string","enum":["verified","pending_verification","needs_address","unverified","blocked"],"allOf":[{"description":"Verification state"}]},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","institutionName","accountType","accountNumberLastFour","worker","status","createdAt","updatedAt"],"additionalProperties":false,"description":"Stored worker bank account metadata without full account numbers, routing details or provider identifiers."},"InvalidBankAccountQueryEncoded":{"type":"object","properties":{"_tag":{"type":"string","enum":["InvalidBankAccountQuery"]},"message":{"type":"string"}},"required":["_tag","message"],"additionalProperties":false},"BankAccountNotFoundEncoded":{"type":"object","properties":{"_tag":{"type":"string","enum":["BankAccountNotFound"]},"id":{"anyOf":[{"type":"string","pattern":"^bank_","description":"The tag of the bank account.","examples":["bank_1234"]},{"type":"string","description":"A legacy DynamoDB bank account id (bankId uuid)."},{"type":"string"}]},"message":{"type":"string"}},"required":["_tag","id","message"],"additionalProperties":false},"JobLevelsNotEnabledEncoded":{"type":"object","properties":{"_tag":{"type":"string","enum":["JobLevelsNotEnabled"]},"message":{"type":"string"}},"required":["_tag","message"],"additionalProperties":false},"InvalidExpirationTimeErrorEncoded":{"type":"object","properties":{"_tag":{"type":"string","enum":["InvalidExpirationTimeError"]},"message":{"type":"string"}},"required":["_tag","message"],"additionalProperties":false},"OfferBackgroundCheckWorkLocationRequiredEncoded":{"type":"object","properties":{"_tag":{"type":"string","enum":["OfferBackgroundCheckWorkLocationRequired"]},"message":{"type":"string"}},"required":["_tag","message"],"additionalProperties":false},"WorkplaceNotFoundEncoded":{"type":"object","properties":{"_tag":{"type":"string","enum":["WorkplaceNotFound"]},"id":{"type":"string","pattern":"^wkp_","description":"Public workplace identifier","examples":["wkp_1234"]},"message":{"type":"string"}},"required":["_tag","id","message"],"additionalProperties":false},"ManagerNotFoundErrorEncoded":{"type":"object","properties":{"_tag":{"type":"string","enum":["ManagerNotFoundError"]},"id":{"type":"string","pattern":"^wrk_","description":"The id of the worker.","examples":["wrk_1234"]},"message":{"type":"string"}},"required":["_tag","id","message"],"additionalProperties":false},"LevelNotFoundEncoded":{"type":"object","properties":{"_tag":{"type":"string","enum":["LevelNotFound"]},"id":{"type":"string","pattern":"^jlvl_","description":"The unique public id of the job level","examples":["jlvl_1234"]},"message":{"type":"string"}},"required":["_tag","id","message"],"additionalProperties":false},"OfferNotFoundErrorEncoded":{"type":"object","properties":{"_tag":{"type":"string","enum":["OfferNotFoundError"]},"id":{"type":"string","pattern":"^offr_","description":"The tag of the offer.","examples":["offr_1234"]},"message":{"type":"string"}},"required":["_tag","id","message"],"additionalProperties":false},"InvalidOfferStatusErrorEncoded":{"type":"object","properties":{"_tag":{"type":"string","enum":["InvalidOfferStatusError"]},"id":{"type":"string","pattern":"^offr_","description":"The tag of the offer.","examples":["offr_1234"]},"status":{"type":"string","enum":["draft","sent","accepted","void","expired"]},"message":{"type":"string"}},"required":["_tag","id","status","message"],"additionalProperties":false},"PublicPayRateType":{"type":"string","enum":["regular","additional"],"description":"Whether the rate is the worker's regular base compensation or an additional rate such as a bonus, commission, or stipend."},"PublicPayRate":{"type":"object","properties":{"id":{"type":"string","pattern":"^pyr_","description":"The pay rate id.","examples":["pyr_1234"]},"worker":{"$ref":"#/components/schemas/PublicWorkerReference"},"type":{"$ref":"#/components/schemas/PublicPayRateType"},"per":{"$ref":"#/components/schemas/PublicPayRatePer"},"amount":{"type":"integer","description":"minor units — cents, e.g. 2345 for $23.45","allOf":[{"minimum":0,"description":"Amount in the currency base unit, e.g. cents for USD."}]},"currency":{"type":"string","enum":["USD","AUD","BGN","BRL","CAD","CHF","CZK","DKK","EUR","GBP","HKD","HUF","IDR","INR","JPY","MYR","NOK","NZD","CNY","PLN","RON","TRY","SEK","SGD","AED","ARS","BDT","BWP","CLP","COP","CRC","EGP","FJD","GEL","GHS","ILS","KES","KRW","LKR","MAD","MXN","NPR","PHP","PKR","THB","UAH","UGX","UYU","VND","ZAR","ZMW","TND","NGN","RSD","TWD","GTQ","HNL","DOP","SAR","XAF","PEN"]},"display":{"type":"string","description":"The server-formatted pay rate, including its period.","examples":["$150,000.00 / yr","$10,000.00 / month","$50.00 / hr"]},"effectiveStartDate":{"anyOf":[{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},{"type":"null"}],"description":"The first date on which the rate applies. Additional rates may have no start date."},"effectiveEndDate":{"anyOf":[{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},{"type":"null"}],"description":"The first date on which the rate no longer applies, or null when it is open-ended."},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A human-readable label for the pay rate, when one is configured."}},"required":["id","worker","type","per","amount","currency","display","effectiveStartDate","effectiveEndDate","description"],"additionalProperties":false,"description":"A regular or additional pay rate assigned to a worker."},"PayRateNotFoundErrorEncoded":{"type":"object","properties":{"_tag":{"type":"string","enum":["PayRateNotFoundError"]},"id":{"type":"string","pattern":"^pyr_","description":"The tag of the pay rate.","examples":["pyr_1234"]},"message":{"type":"string"}},"required":["_tag","id","message"],"additionalProperties":false},"PublicRegularPayRateType":{"type":"string","enum":["salary","monthly","weekly","hourly","variable"],"description":"How the regular pay rate is measured. Salary represents an annual rate. Variable pay creates a dated boundary without a fixed pay-rate row and returns a null id."},"PublicRegularPayRateCurrency":{"type":"string","enum":["USD","AUD","BGN","BRL","CAD","CHF","CZK","DKK","EUR","GBP","HKD","HUF","IDR","INR","MYR","NOK","NZD","CNY","PLN","RON","TRY","SEK","SGD","AED","ARS","BDT","BWP","COP","CRC","EGP","FJD","GEL","GHS","ILS","KES","LKR","MAD","MXN","NPR","PHP","PKR","THB","UAH","UYU","ZAR","ZMW","NGN","RSD","TWD","GTQ","HNL","DOP","SAR","PEN"],"description":"The two-decimal ISO 4217 payout currency of the pay rate.","examples":["USD"]},"PublicCreateRegularPayRate":{"type":"object","properties":{"workerId":{"type":"string","pattern":"^wrk_","description":"The worker whose regular pay rate will be created.","examples":["wrk_khac8380c2Lm"]},"type":{"$ref":"#/components/schemas/PublicRegularPayRateType"},"amount":{"anyOf":[{"type":"integer","description":"minor units — cents, e.g. 2345 for $23.45","allOf":[{"minimum":0,"description":"The pay rate in integer minor currency units, such as cents for USD. Required unless type is variable.","examples":[12500000,5000]}]},{"type":"null"}]},"currency":{"$ref":"#/components/schemas/PublicRegularPayRateCurrency"},"effectiveDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"requireHoursSubmission":{"anyOf":[{"type":"boolean","description":"Whether the worker must submit hours. Required when type is hourly."},{"type":"null"}]},"description":{"anyOf":[{"type":"string","description":"A human-readable label for the pay rate."},{"type":"null"}]},"notes":{"anyOf":[{"type":"string","description":"Optional internal notes about the pay rate change."},{"type":"null"}]}},"required":["workerId","type","currency","effectiveDate"],"additionalProperties":false,"description":"A new effective-dated regular pay rate. Fixed rates require a nonnegative integer minor-unit amount; hourly rates also require requireHoursSubmission. Variable rates create a boundary without a fixed row."},"PublicCreateRegularPayRateResponse":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","pattern":"^pyr_","description":"The tag of the pay rate.","examples":["pyr_1234"]},{"type":"null"}],"description":"The created pay rate id, or null when variable pay is represented by no active regular rate."}},"required":["id"],"additionalProperties":false},"PublicPayRateWorkerNotFoundErrorEncoded":{"type":"object","properties":{"_tag":{"type":"string","enum":["PublicPayRateWorkerNotFoundError"]},"workerId":{"type":"string","pattern":"^wrk_","description":"The id of the worker.","examples":["wrk_1234"]},"message":{"type":"string"}},"required":["_tag","workerId","message"],"additionalProperties":false},"PayRateFutureRateAlreadyExistsEncoded":{"type":"object","properties":{"_tag":{"type":"string","enum":["PayRateFutureRateAlreadyExists"]},"workerId":{"type":"string","pattern":"^wrk_","description":"The id of the worker.","examples":["wrk_1234"]},"effectiveDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"message":{"type":"string"}},"required":["_tag","workerId","effectiveDate","message"],"additionalProperties":false},"PayRateInactiveEffectiveDateMismatchEncoded":{"type":"object","properties":{"_tag":{"type":"string","enum":["PayRateInactiveEffectiveDateMismatch"]},"workerId":{"type":"string","pattern":"^wrk_","description":"The id of the worker.","examples":["wrk_1234"]},"effectiveDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"message":{"type":"string"},"workerStartDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"}},"required":["_tag","workerId","effectiveDate","message","workerStartDate"],"additionalProperties":false},"PayRateEffectiveDateBeforeStartEncoded":{"type":"object","properties":{"_tag":{"type":"string","enum":["PayRateEffectiveDateBeforeStart"]},"workerId":{"type":"string","pattern":"^wrk_","description":"The id of the worker.","examples":["wrk_1234"]},"effectiveDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"message":{"type":"string"},"workerStartDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"}},"required":["_tag","workerId","effectiveDate","message","workerStartDate"],"additionalProperties":false},"PayRateHoursSubmissionRequiredEncoded":{"type":"object","properties":{"_tag":{"type":"string","enum":["PayRateHoursSubmissionRequired"]},"workerId":{"type":"string","pattern":"^wrk_","description":"The id of the worker.","examples":["wrk_1234"]},"effectiveDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"message":{"type":"string"}},"required":["_tag","workerId","effectiveDate","message"],"additionalProperties":false},"PayRateAmountRequiredEncoded":{"type":"object","properties":{"_tag":{"type":"string","enum":["PayRateAmountRequired"]},"workerId":{"type":"string","pattern":"^wrk_","description":"The id of the worker.","examples":["wrk_1234"]},"effectiveDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"message":{"type":"string"},"payRateType":{"type":"string","enum":["salary","monthly","weekly","hourly","variable"]}},"required":["_tag","workerId","effectiveDate","message","payRateType"],"additionalProperties":false},"PayRateCurrencyChangeEffectiveDateInvalidEncoded":{"type":"object","properties":{"_tag":{"type":"string","enum":["PayRateCurrencyChangeEffectiveDateInvalid"]},"workerId":{"type":"string","pattern":"^wrk_","description":"The id of the worker.","examples":["wrk_1234"]},"effectiveDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"message":{"type":"string"},"workerStartDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"}},"required":["_tag","workerId","effectiveDate","message","workerStartDate"],"additionalProperties":false},"PublicDeleteRegularPayRate":{"type":"object","properties":{"workerId":{"type":"string","pattern":"^wrk_","description":"The worker whose future regular pay rate will be deleted.","examples":["wrk_khac8380c2Lm"]},"effectiveDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"}},"required":["workerId","effectiveDate"],"additionalProperties":false,"description":"Identifies a strictly future regular pay rate or variable-pay boundary by worker and effective date. Deletion reopens the predecessor through the deleted range."},"PublicRegularPayRateNotFoundErrorEncoded":{"type":"object","properties":{"_tag":{"type":"string","enum":["PublicRegularPayRateNotFoundError"]},"workerId":{"type":"string","pattern":"^wrk_","description":"The id of the worker.","examples":["wrk_1234"]},"effectiveDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"message":{"type":"string"}},"required":["_tag","workerId","effectiveDate","message"],"additionalProperties":false},"PayRateDeleteEffectiveDateNotFutureEncoded":{"type":"object","properties":{"_tag":{"type":"string","enum":["PayRateDeleteEffectiveDateNotFuture"]},"workerId":{"type":"string","pattern":"^wrk_","description":"The id of the worker.","examples":["wrk_1234"]},"effectiveDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"message":{"type":"string"}},"required":["_tag","workerId","effectiveDate","message"],"additionalProperties":false},"PublicPaySplitType":{"type":"string","enum":["percentage","amount"]},"PublicPaySplitStatus":{"type":"string","enum":["active","inactive"]},"PublicBankAccountReference":{"type":"object","properties":{"id":{"type":"string","pattern":"^bank_","description":"The tag of the bank account.","examples":["bank_1234"]},"institutionName":{"anyOf":[{"type":"string"},{"type":"null"}]},"accountType":{"anyOf":[{"type":"string","enum":["checking","savings"]},{"type":"null"}]},"accountNumberLastFour":{"type":"string","allOf":[{"description":"Last four characters of the account number."}]}},"required":["id","institutionName","accountType","accountNumberLastFour"],"additionalProperties":false},"PublicPaySplitPercentage":{"type":"object","properties":{"percentage":{"anyOf":[{"type":"number"},{"type":"string","enum":["Infinity","-Infinity","NaN"]}]},"display":{"type":"string"}},"required":["percentage","display"],"additionalProperties":false,"description":"A stored percentage from 0 to 100 with at most four decimal places and its server-formatted display. Values are preserved, not normalized to total 100 or predicted from provider execution.","examples":[{"percentage":25,"display":"25%"}]},"PublicPaySplitPercentageAllocation":{"type":"object","properties":{"bankAccount":{"$ref":"#/components/schemas/PublicBankAccountReference"},"priority":{"type":"integer","minimum":0,"allOf":[{"description":"Stored nonnegative priority. Allocations are returned in ascending priority order; gaps are allowed."}]},"percentage":{"$ref":"#/components/schemas/PublicPaySplitPercentage"}},"required":["bankAccount","priority","percentage"],"additionalProperties":false},"PublicPercentagePaySplit":{"type":"object","properties":{"id":{"type":"string","pattern":"^nps_","description":"The tag of the bank account pay split.","examples":["nps_1234"]},"worker":{"$ref":"#/components/schemas/PublicWorkerReference"},"status":{"allOf":[{"$ref":"#/components/schemas/PublicPaySplitStatus"},{"description":"Whether this is the worker’s currently active stored configuration, not a provider execution status."}]},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"type":{"type":"string","enum":["percentage"]},"allocations":{"type":"array","items":{"$ref":"#/components/schemas/PublicPaySplitPercentageAllocation"},"minItems":1}},"required":["id","worker","status","createdAt","updatedAt","type","allocations"],"additionalProperties":false,"title":"Percentage"},"PublicPaySplitFixedAllocation":{"type":"object","properties":{"type":{"type":"string","enum":["amount"]},"amount":{"type":"integer","description":"minor units — cents, e.g. 2345 for $23.45","allOf":[{"minimum":0,"description":"Amount in the currency base unit, e.g. cents for USD."}]},"currency":{"type":"string","enum":["USD","AUD","BGN","BRL","CAD","CHF","CZK","DKK","EUR","GBP","HKD","HUF","IDR","INR","JPY","MYR","NOK","NZD","CNY","PLN","RON","TRY","SEK","SGD","AED","ARS","BDT","BWP","CLP","COP","CRC","EGP","FJD","GEL","GHS","ILS","KES","KRW","LKR","MAD","MXN","NPR","PHP","PKR","THB","UAH","UGX","UYU","VND","ZAR","ZMW","TND","NGN","RSD","TWD","GTQ","HNL","DOP","SAR","XAF","PEN"]},"display":{"type":"string","description":"The server-formatted display string for the amount in its currency.","examples":["$150,000.00","$85.50"]}},"required":["type","amount","currency","display"],"additionalProperties":false,"title":"Fixed amount"},"PublicPaySplitRemainderAllocation":{"type":"object","properties":{"type":{"type":"string","enum":["remainder"]}},"required":["type"],"additionalProperties":false,"title":"Remainder"},"PublicPaySplitAllocation":{"anyOf":[{"$ref":"#/components/schemas/PublicPaySplitFixedAllocation"},{"$ref":"#/components/schemas/PublicPaySplitRemainderAllocation"}],"description":"A fixed amount, or the net pay remaining after earlier allocations. The final allocation of an amount split always receives the remainder."},"PublicPaySplitAmountAllocation":{"type":"object","properties":{"bankAccount":{"$ref":"#/components/schemas/PublicBankAccountReference"},"priority":{"type":"integer","minimum":0,"allOf":[{"description":"Stored nonnegative priority. Allocations are returned in ascending priority order; gaps are allowed."}]},"allocation":{"$ref":"#/components/schemas/PublicPaySplitAllocation"}},"required":["bankAccount","priority","allocation"],"additionalProperties":false},"PublicAmountPaySplit":{"type":"object","properties":{"id":{"type":"string","pattern":"^nps_","description":"The tag of the bank account pay split.","examples":["nps_1234"]},"worker":{"$ref":"#/components/schemas/PublicWorkerReference"},"status":{"allOf":[{"$ref":"#/components/schemas/PublicPaySplitStatus"},{"description":"Whether this is the worker’s currently active stored configuration, not a provider execution status."}]},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"type":{"type":"string","enum":["amount"]},"allocations":{"type":"array","items":{"$ref":"#/components/schemas/PublicPaySplitAmountAllocation"},"minItems":1}},"required":["id","worker","status","createdAt","updatedAt","type","allocations"],"additionalProperties":false,"title":"Amount"},"PublicPaySplit":{"anyOf":[{"$ref":"#/components/schemas/PublicPercentagePaySplit"},{"$ref":"#/components/schemas/PublicAmountPaySplit"}],"description":"A stored worker pay-split configuration, not a guarantee of executed payroll routing. Fixed amounts are in USD cents, and the final allocation of an amount split receives the remaining net pay. Allocations may reference archived bank accounts."},"InvalidPaySplitQueryEncoded":{"type":"object","properties":{"_tag":{"type":"string","enum":["InvalidPaySplitQuery"]},"message":{"type":"string"}},"required":["_tag","message"],"additionalProperties":false},"PaySplitNotFoundEncoded":{"type":"object","properties":{"_tag":{"type":"string","enum":["PaySplitNotFound"]},"id":{"type":"string","pattern":"^nps_","description":"The tag of the bank account pay split.","examples":["nps_1234"]},"message":{"type":"string"}},"required":["_tag","id","message"],"additionalProperties":false},"PublicPayrollType":{"type":"string","enum":["us","global"],"description":"Whether the payroll or paycheck is calculated through US or global payroll.","examples":["us"]},"PublicPayrollSubtype":{"type":"string","enum":["regular","off_cycle","bonus","invoice","contractor","dismissal","reimbursement","manual"],"description":"The purpose or processing category of the payroll run.","examples":["regular"]},"PublicPayrollStatus":{"type":"string","enum":["preparing","draft","approving","pending","processing","partially_paid","processed","failed","voided"],"description":"The current public lifecycle status of a payroll.","examples":["processing"]},"PublicPayFrequency":{"type":"string","enum":["weekly","biweekly","monthly","semimonthly","quarterly","annually"],"description":"The cadence at which workers are paid.","examples":["semimonthly"]},"PublicPayrollCurrency":{"type":"string","enum":["USD","AUD","BGN","BRL","CAD","CHF","CZK","DKK","EUR","GBP","HKD","HUF","IDR","INR","JPY","MYR","NOK","NZD","CNY","PLN","RON","TRY","SEK","SGD","AED","ARS","BDT","BWP","CLP","COP","CRC","EGP","FJD","GEL","GHS","ILS","KES","KRW","LKR","MAD","MXN","NPR","PHP","PKR","THB","UAH","UGX","UYU","VND","ZAR","ZMW","TND","NGN","RSD","TWD","GTQ","HNL","DOP","SAR","XAF","PEN","BOB"],"description":"An ISO 4217 currency supported by payroll read resources.","examples":["USD"]},"PublicPayPeriod":{"type":"object","properties":{"startDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","allOf":[{"description":"The first calendar date included in the pay period.","examples":["2026-08-16"]}]},"endDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","allOf":[{"description":"The last calendar date included in the pay period.","examples":["2026-08-31"]}]}},"required":["startDate","endDate"],"additionalProperties":false,"description":"The inclusive calendar boundaries of a payroll reporting period.","examples":[{"startDate":"2026-08-16","endDate":"2026-08-31"}]},"PublicCurrencyMoneyAmount":{"type":"object","properties":{"amount":{"type":"integer","description":"minor units — cents, e.g. 2345 for $23.45","allOf":[{"minimum":0,"description":"The amount in ISO 4217 minor units. For USD, 300000 represents $3,000.00.","examples":[300000]}]},"display":{"type":"string","description":"The server-formatted display string for the amount in its currency.","examples":["$150,000.00","$85.50"],"allOf":[{"description":"The amount formatted for display in the currency established by the parent object.","examples":["$3,000.00"]}]}},"required":["amount","display"],"additionalProperties":false,"description":"Gross earnings before worker taxes, deductions, and benefit contributions. Reimbursements are reported separately.","examples":[{"amount":300000,"display":"$3,000.00"}]},"PublicCurrencyMoneyAmount_1":{"type":"object","properties":{"amount":{"type":"integer","description":"minor units — cents, e.g. 2345 for $23.45","allOf":[{"minimum":0,"description":"The amount in ISO 4217 minor units. For USD, 300000 represents $3,000.00.","examples":[300000]}]},"display":{"type":"string","description":"The server-formatted display string for the amount in its currency.","examples":["$150,000.00","$85.50"],"allOf":[{"description":"The amount formatted for display in the currency established by the parent object.","examples":["$3,000.00"]}]}},"required":["amount","display"],"additionalProperties":false,"description":"The provider-calculated amount to send for workers: gross pay plus reimbursements, less worker taxes, deductions, and benefit contributions. It excludes payment execution fees and may differ from recomputed totals because of provider and FX rounding. Null when any paycheck net pay is not yet known.","examples":[{"amount":230000,"display":"$2,300.00"}]},"PublicCurrencyMoneyAmount_2":{"type":"object","properties":{"amount":{"type":"integer","description":"minor units — cents, e.g. 2345 for $23.45","allOf":[{"minimum":0,"description":"The amount in ISO 4217 minor units. For USD, 300000 represents $3,000.00.","examples":[300000]}]},"display":{"type":"string","description":"The server-formatted display string for the amount in its currency.","examples":["$150,000.00","$85.50"],"allOf":[{"description":"The amount formatted for display in the currency established by the parent object.","examples":["$3,000.00"]}]}},"required":["amount","display"],"additionalProperties":false,"description":"Amounts reimbursed to workers in addition to gross pay. Reimbursements increase net pay and employer cost.","examples":[{"amount":15000,"display":"$150.00"}]},"PublicCurrencyMoneyAmount_3":{"type":"object","properties":{"amount":{"type":"integer","description":"minor units — cents, e.g. 2345 for $23.45","allOf":[{"minimum":0,"description":"The amount in ISO 4217 minor units. For USD, 300000 represents $3,000.00.","examples":[300000]}]},"display":{"type":"string","description":"The server-formatted display string for the amount in its currency.","examples":["$150,000.00","$85.50"],"allOf":[{"description":"The amount formatted for display in the currency established by the parent object.","examples":["$3,000.00"]}]}},"required":["amount","display"],"additionalProperties":false,"description":"Payroll taxes withheld from worker pay, reducing net pay.","examples":[{"amount":50000,"display":"$500.00"}]},"PublicCurrencyMoneyAmount_4":{"type":"object","properties":{"amount":{"type":"integer","description":"minor units — cents, e.g. 2345 for $23.45","allOf":[{"minimum":0,"description":"The amount in ISO 4217 minor units. For USD, 300000 represents $3,000.00.","examples":[300000]}]},"display":{"type":"string","description":"The server-formatted display string for the amount in its currency.","examples":["$150,000.00","$85.50"],"allOf":[{"description":"The amount formatted for display in the currency established by the parent object.","examples":["$3,000.00"]}]}},"required":["amount","display"],"additionalProperties":false,"description":"Payroll taxes paid by the employer in addition to gross pay.","examples":[{"amount":25000,"display":"$250.00"}]},"PublicCurrencyMoneyAmount_5":{"type":"object","properties":{"amount":{"type":"integer","description":"minor units — cents, e.g. 2345 for $23.45","allOf":[{"minimum":0,"description":"The amount in ISO 4217 minor units. For USD, 300000 represents $3,000.00.","examples":[300000]}]},"display":{"type":"string","description":"The server-formatted display string for the amount in its currency.","examples":["$150,000.00","$85.50"],"allOf":[{"description":"The amount formatted for display in the currency established by the parent object.","examples":["$3,000.00"]}]}},"required":["amount","display"],"additionalProperties":false,"description":"Non-benefit amounts deducted from worker pay before taxes, reducing taxable pay and net pay.","examples":[{"amount":10000,"display":"$100.00"}]},"PublicCurrencyMoneyAmount_6":{"type":"object","properties":{"amount":{"type":"integer","description":"minor units — cents, e.g. 2345 for $23.45","allOf":[{"minimum":0,"description":"The amount in ISO 4217 minor units. For USD, 300000 represents $3,000.00.","examples":[300000]}]},"display":{"type":"string","description":"The server-formatted display string for the amount in its currency.","examples":["$150,000.00","$85.50"],"allOf":[{"description":"The amount formatted for display in the currency established by the parent object.","examples":["$3,000.00"]}]}},"required":["amount","display"],"additionalProperties":false,"description":"Non-benefit amounts deducted from worker pay after taxes, reducing net pay.","examples":[{"amount":5000,"display":"$50.00"}]},"PublicCurrencyMoneyAmount_7":{"type":"object","properties":{"amount":{"type":"integer","description":"minor units — cents, e.g. 2345 for $23.45","allOf":[{"minimum":0,"description":"The amount in ISO 4217 minor units. For USD, 300000 represents $3,000.00.","examples":[300000]}]},"display":{"type":"string","description":"The server-formatted display string for the amount in its currency.","examples":["$150,000.00","$85.50"],"allOf":[{"description":"The amount formatted for display in the currency established by the parent object.","examples":["$3,000.00"]}]}},"required":["amount","display"],"additionalProperties":false,"description":"Amounts workers pay toward benefits, deducted from their pay.","examples":[{"amount":20000,"display":"$200.00"}]},"PublicCurrencyMoneyAmount_8":{"type":"object","properties":{"amount":{"type":"integer","description":"minor units — cents, e.g. 2345 for $23.45","allOf":[{"minimum":0,"description":"The amount in ISO 4217 minor units. For USD, 300000 represents $3,000.00.","examples":[300000]}]},"display":{"type":"string","description":"The server-formatted display string for the amount in its currency.","examples":["$150,000.00","$85.50"],"allOf":[{"description":"The amount formatted for display in the currency established by the parent object.","examples":["$3,000.00"]}]}},"required":["amount","display"],"additionalProperties":false,"description":"Amounts the employer pays toward worker benefits in addition to gross pay.","examples":[{"amount":15000,"display":"$150.00"}]},"PublicCurrencyMoneyAmount_9":{"type":"object","properties":{"amount":{"type":"integer","description":"minor units — cents, e.g. 2345 for $23.45","allOf":[{"minimum":0,"description":"The amount in ISO 4217 minor units. For USD, 300000 represents $3,000.00.","examples":[300000]}]},"display":{"type":"string","description":"The server-formatted display string for the amount in its currency.","examples":["$150,000.00","$85.50"],"allOf":[{"description":"The amount formatted for display in the currency established by the parent object.","examples":["$3,000.00"]}]}},"required":["amount","display"],"additionalProperties":false,"description":"Banking and transaction fees paid by the employer to fund and pay the payroll.","examples":[{"amount":500,"display":"$5.00"}]},"PublicCurrencyMoneyAmount_10":{"type":"object","properties":{"amount":{"type":"integer","description":"minor units — cents, e.g. 2345 for $23.45","allOf":[{"minimum":0,"description":"The amount in ISO 4217 minor units. For USD, 300000 represents $3,000.00.","examples":[300000]}]},"display":{"type":"string","description":"The server-formatted display string for the amount in its currency.","examples":["$150,000.00","$85.50"],"allOf":[{"description":"The amount formatted for display in the currency established by the parent object.","examples":["$3,000.00"]}]}},"required":["amount","display"],"additionalProperties":false,"description":"The employer's total payroll cost: gross pay, reimbursements, employer taxes, employer benefit contributions, and transaction fees.","examples":[{"amount":355500,"display":"$3,555.00"}]},"PublicFundingPayrollTotals":{"type":"object","properties":{"grossPay":{"$ref":"#/components/schemas/PublicCurrencyMoneyAmount"},"netPay":{"anyOf":[{"$ref":"#/components/schemas/PublicCurrencyMoneyAmount_1"},{"type":"null"}]},"reimbursements":{"$ref":"#/components/schemas/PublicCurrencyMoneyAmount_2"},"workerTaxes":{"$ref":"#/components/schemas/PublicCurrencyMoneyAmount_3"},"employerTaxes":{"$ref":"#/components/schemas/PublicCurrencyMoneyAmount_4"},"preTaxDeductions":{"$ref":"#/components/schemas/PublicCurrencyMoneyAmount_5"},"postTaxDeductions":{"$ref":"#/components/schemas/PublicCurrencyMoneyAmount_6"},"workerBenefitContributions":{"$ref":"#/components/schemas/PublicCurrencyMoneyAmount_7"},"employerBenefitContributions":{"$ref":"#/components/schemas/PublicCurrencyMoneyAmount_8"},"transactionFees":{"$ref":"#/components/schemas/PublicCurrencyMoneyAmount_9"},"totalCost":{"$ref":"#/components/schemas/PublicCurrencyMoneyAmount_10"}},"required":["grossPay","netPay","reimbursements","workerTaxes","employerTaxes","preTaxDeductions","postTaxDeductions","workerBenefitContributions","employerBenefitContributions","transactionFees","totalCost"],"additionalProperties":false,"description":"Payroll totals expressed in the parent payroll funding currency. Line-derived categories are subtotaled per paycheck in calculation currency, converted once per category, rounded to funding-currency minor units, and then summed. Net pay remains provider-authoritative.","examples":[{"grossPay":{"amount":300000,"display":"$3,000.00"},"netPay":{"amount":230000,"display":"$2,300.00"},"reimbursements":{"amount":15000,"display":"$150.00"},"workerTaxes":{"amount":50000,"display":"$500.00"},"employerTaxes":{"amount":25000,"display":"$250.00"},"preTaxDeductions":{"amount":10000,"display":"$100.00"},"postTaxDeductions":{"amount":5000,"display":"$50.00"},"workerBenefitContributions":{"amount":20000,"display":"$200.00"},"employerBenefitContributions":{"amount":15000,"display":"$150.00"},"transactionFees":{"amount":500,"display":"$5.00"},"totalCost":{"amount":355500,"display":"$3,555.00"}}]},"PublicPayrollSummary":{"type":"object","properties":{"id":{"type":"string","pattern":"^pay_","description":"The tag of the payroll.","examples":["pay_1234"],"allOf":[{"description":"The payroll ID.","examples":["pay_1234"]}]},"type":{"allOf":[{"$ref":"#/components/schemas/PublicPayrollType"},{"description":"Whether this payroll is calculated through US or global payroll.","examples":["us"]}]},"subtype":{"allOf":[{"$ref":"#/components/schemas/PublicPayrollSubtype"},{"description":"The business purpose of this payroll.","examples":["regular"]}]},"status":{"allOf":[{"$ref":"#/components/schemas/PublicPayrollStatus"},{"description":"The current processing status of this payroll.","examples":["processing"]}]},"fundingCurrency":{"allOf":[{"$ref":"#/components/schemas/PublicPayrollCurrency"},{"description":"The currency the employer uses to fund the payroll. Every amount in totals uses this currency.","examples":["USD"]}]},"payday":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","allOf":[{"description":"The date payment to workers is scheduled.","examples":["2026-08-31"]}]},"payPeriod":{"allOf":[{"$ref":"#/components/schemas/PublicPayPeriod"},{"description":"The inclusive work period covered by this payroll.","examples":[{"startDate":"2026-08-16","endDate":"2026-08-31"}]}]},"payFrequency":{"anyOf":[{"$ref":"#/components/schemas/PublicPayFrequency"},{"type":"null"}],"allOf":[{"description":"The regular pay cadence for this payroll, or null when no cadence is available.","examples":["semimonthly"]}]},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"allOf":[{"description":"The employer-provided payroll description, when available.","examples":["August 16–31, 2026 semimonthly payroll"]}]},"approvalDeadline":{"anyOf":[{"type":"string","examples":["2026-08-27T17:00:00.000Z"]},{"type":"null"}],"allOf":[{"description":"The deadline to approve this payroll without changing its scheduled payday, when available."}]},"paycheckCount":{"type":"integer","minimum":0,"allOf":[{"description":"The number of worker paychecks included in this payroll.","examples":[1]}]},"totals":{"allOf":[{"$ref":"#/components/schemas/PublicFundingPayrollTotals"},{"description":"Employer-facing payroll totals expressed in fundingCurrency.","examples":[{"grossPay":{"amount":300000,"display":"$3,000.00"},"netPay":{"amount":230000,"display":"$2,300.00"},"reimbursements":{"amount":15000,"display":"$150.00"},"workerTaxes":{"amount":50000,"display":"$500.00"},"employerTaxes":{"amount":25000,"display":"$250.00"},"preTaxDeductions":{"amount":10000,"display":"$100.00"},"postTaxDeductions":{"amount":5000,"display":"$50.00"},"workerBenefitContributions":{"amount":20000,"display":"$200.00"},"employerBenefitContributions":{"amount":15000,"display":"$150.00"},"transactionFees":{"amount":500,"display":"$5.00"},"totalCost":{"amount":355500,"display":"$3,555.00"}}]}]}},"required":["id","type","subtype","status","fundingCurrency","payday","payPeriod","payFrequency","description","approvalDeadline","paycheckCount","totals"],"additionalProperties":false,"description":"A compact payroll run with employer-facing totals expressed in fundingCurrency, the currency used to fund the payroll.","examples":[{"id":"pay_1234","type":"us","subtype":"regular","status":"processing","fundingCurrency":"USD","payday":"2026-08-31","payPeriod":{"startDate":"2026-08-16","endDate":"2026-08-31"},"payFrequency":"semimonthly","description":"August 16–31, 2026 semimonthly payroll","approvalDeadline":"2026-08-27T17:00:00.000Z","paycheckCount":1,"totals":{"grossPay":{"amount":300000,"display":"$3,000.00"},"netPay":{"amount":230000,"display":"$2,300.00"},"reimbursements":{"amount":15000,"display":"$150.00"},"workerTaxes":{"amount":50000,"display":"$500.00"},"employerTaxes":{"amount":25000,"display":"$250.00"},"preTaxDeductions":{"amount":10000,"display":"$100.00"},"postTaxDeductions":{"amount":5000,"display":"$50.00"},"workerBenefitContributions":{"amount":20000,"display":"$200.00"},"employerBenefitContributions":{"amount":15000,"display":"$150.00"},"transactionFees":{"amount":500,"display":"$5.00"},"totalCost":{"amount":355500,"display":"$3,555.00"}}}]},"PublicPayrollListResponse":{"type":"object","properties":{"hasMore":{"type":"boolean","allOf":[{"description":"Whether another page of matching payrolls is available in the requested cursor direction.","examples":[false]}]},"count":{"type":"integer","allOf":[{"description":"The total number of payrolls matching the filters, before cursor pagination.","examples":[1]}]},"data":{"type":"array","items":{"$ref":"#/components/schemas/PublicPayrollSummary"},"examples":[[{"id":"pay_1234","type":"us","subtype":"regular","status":"processing","fundingCurrency":"USD","payday":"2026-08-31","payPeriod":{"startDate":"2026-08-16","endDate":"2026-08-31"},"payFrequency":"semimonthly","description":"August 16–31, 2026 semimonthly payroll","approvalDeadline":"2026-08-27T17:00:00.000Z","paycheckCount":1,"totals":{"grossPay":{"amount":300000,"display":"$3,000.00"},"netPay":{"amount":230000,"display":"$2,300.00"},"reimbursements":{"amount":15000,"display":"$150.00"},"workerTaxes":{"amount":50000,"display":"$500.00"},"employerTaxes":{"amount":25000,"display":"$250.00"},"preTaxDeductions":{"amount":10000,"display":"$100.00"},"postTaxDeductions":{"amount":5000,"display":"$50.00"},"workerBenefitContributions":{"amount":20000,"display":"$200.00"},"employerBenefitContributions":{"amount":15000,"display":"$150.00"},"transactionFees":{"amount":500,"display":"$5.00"},"totalCost":{"amount":355500,"display":"$3,555.00"}}}]],"allOf":[{"description":"The payroll summaries in this page."}]}},"required":["hasMore","count","data"],"additionalProperties":false,"description":"A cursor-paginated page of payroll summaries.","examples":[{"hasMore":false,"count":1,"data":[{"id":"pay_1234","type":"us","subtype":"regular","status":"processing","fundingCurrency":"USD","payday":"2026-08-31","payPeriod":{"startDate":"2026-08-16","endDate":"2026-08-31"},"payFrequency":"semimonthly","description":"August 16–31, 2026 semimonthly payroll","approvalDeadline":"2026-08-27T17:00:00.000Z","paycheckCount":1,"totals":{"grossPay":{"amount":300000,"display":"$3,000.00"},"netPay":{"amount":230000,"display":"$2,300.00"},"reimbursements":{"amount":15000,"display":"$150.00"},"workerTaxes":{"amount":50000,"display":"$500.00"},"employerTaxes":{"amount":25000,"display":"$250.00"},"preTaxDeductions":{"amount":10000,"display":"$100.00"},"postTaxDeductions":{"amount":5000,"display":"$50.00"},"workerBenefitContributions":{"amount":20000,"display":"$200.00"},"employerBenefitContributions":{"amount":15000,"display":"$150.00"},"transactionFees":{"amount":500,"display":"$5.00"},"totalCost":{"amount":355500,"display":"$3,555.00"}}}]}]},"InvalidPayrollQueryErrorEncoded":{"type":"object","properties":{"_tag":{"type":"string","enum":["InvalidPayrollQueryError"]},"message":{"type":"string","allOf":[{"description":"A human-readable explanation of the invalid query.","examples":["paydayBefore must be later than paydayOnOrAfter"]}]}},"required":["_tag","message"],"additionalProperties":false},"PublicCurrencyMoneyAmount_11":{"type":"object","properties":{"amount":{"type":"integer","description":"minor units — cents, e.g. 2345 for $23.45","allOf":[{"minimum":0,"description":"The amount in ISO 4217 minor units. For USD, 300000 represents $3,000.00.","examples":[300000]}]},"display":{"type":"string","description":"The server-formatted display string for the amount in its currency.","examples":["$150,000.00","$85.50"],"allOf":[{"description":"The amount formatted for display in the currency established by the parent object.","examples":["$3,000.00"]}]}},"required":["amount","display"],"additionalProperties":false,"description":"The provider-reported amount the employer must fund for the payroll, when available.","examples":[{"amount":355500,"display":"$3,555.00"}]},"PublicPayrollDetailTotals":{"type":"object","properties":{"cashRequirement":{"anyOf":[{"$ref":"#/components/schemas/PublicCurrencyMoneyAmount_11"},{"type":"null"}]},"grossPay":{"$ref":"#/components/schemas/PublicCurrencyMoneyAmount"},"netPay":{"anyOf":[{"$ref":"#/components/schemas/PublicCurrencyMoneyAmount_1"},{"type":"null"}]},"reimbursements":{"$ref":"#/components/schemas/PublicCurrencyMoneyAmount_2"},"workerTaxes":{"$ref":"#/components/schemas/PublicCurrencyMoneyAmount_3"},"employerTaxes":{"$ref":"#/components/schemas/PublicCurrencyMoneyAmount_4"},"preTaxDeductions":{"$ref":"#/components/schemas/PublicCurrencyMoneyAmount_5"},"postTaxDeductions":{"$ref":"#/components/schemas/PublicCurrencyMoneyAmount_6"},"workerBenefitContributions":{"$ref":"#/components/schemas/PublicCurrencyMoneyAmount_7"},"employerBenefitContributions":{"$ref":"#/components/schemas/PublicCurrencyMoneyAmount_8"},"transactionFees":{"$ref":"#/components/schemas/PublicCurrencyMoneyAmount_9"},"totalCost":{"$ref":"#/components/schemas/PublicCurrencyMoneyAmount_10"}},"required":["cashRequirement","grossPay","netPay","reimbursements","workerTaxes","employerTaxes","preTaxDeductions","postTaxDeductions","workerBenefitContributions","employerBenefitContributions","transactionFees","totalCost"],"additionalProperties":false,"description":"Payroll category totals and provider-authoritative funding requirement.","examples":[{"cashRequirement":{"amount":355500,"display":"$3,555.00"},"grossPay":{"amount":300000,"display":"$3,000.00"},"netPay":{"amount":230000,"display":"$2,300.00"},"reimbursements":{"amount":15000,"display":"$150.00"},"workerTaxes":{"amount":50000,"display":"$500.00"},"employerTaxes":{"amount":25000,"display":"$250.00"},"preTaxDeductions":{"amount":10000,"display":"$100.00"},"postTaxDeductions":{"amount":5000,"display":"$50.00"},"workerBenefitContributions":{"amount":20000,"display":"$200.00"},"employerBenefitContributions":{"amount":15000,"display":"$150.00"},"transactionFees":{"amount":500,"display":"$5.00"},"totalCost":{"amount":355500,"display":"$3,555.00"}}]},"PublicPayrollFundingMethod":{"type":"string","enum":["ach","wire"],"description":"How the company funds the payroll.","examples":["ach"]},"PublicPayrollTimeline":{"type":"object","properties":{"approvedAt":{"anyOf":[{"type":"string","examples":["2026-08-27T16:42:00.000Z"]},{"type":"null"}],"allOf":[{"description":"When the payroll was approved, or null if it has not been approved."}]}},"required":["approvedAt"],"additionalProperties":false,"description":"The approval timestamp for a payroll.","examples":[{"approvedAt":"2026-08-27T16:42:00.000Z"}]},"PublicPayrollDetail":{"type":"object","properties":{"id":{"type":"string","pattern":"^pay_","description":"The tag of the payroll.","examples":["pay_1234"],"allOf":[{"description":"The payroll ID.","examples":["pay_1234"]}]},"type":{"allOf":[{"$ref":"#/components/schemas/PublicPayrollType"},{"description":"Whether this payroll is calculated through US or global payroll.","examples":["us"]}]},"subtype":{"allOf":[{"$ref":"#/components/schemas/PublicPayrollSubtype"},{"description":"The business purpose of this payroll.","examples":["regular"]}]},"status":{"allOf":[{"$ref":"#/components/schemas/PublicPayrollStatus"},{"description":"The current processing status of this payroll.","examples":["processing"]}]},"fundingCurrency":{"allOf":[{"$ref":"#/components/schemas/PublicPayrollCurrency"},{"description":"The currency the employer uses to fund the payroll. Every amount in totals uses this currency.","examples":["USD"]}]},"payday":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","allOf":[{"description":"The date payment to workers is scheduled.","examples":["2026-08-31"]}]},"payPeriod":{"allOf":[{"$ref":"#/components/schemas/PublicPayPeriod"},{"description":"The inclusive work period covered by this payroll.","examples":[{"startDate":"2026-08-16","endDate":"2026-08-31"}]}]},"payFrequency":{"anyOf":[{"$ref":"#/components/schemas/PublicPayFrequency"},{"type":"null"}],"allOf":[{"description":"The regular pay cadence for this payroll, or null when no cadence is available.","examples":["semimonthly"]}]},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"allOf":[{"description":"The employer-provided payroll description, when available.","examples":["August 16–31, 2026 semimonthly payroll"]}]},"approvalDeadline":{"anyOf":[{"type":"string","examples":["2026-08-27T17:00:00.000Z"]},{"type":"null"}],"allOf":[{"description":"The deadline to approve this payroll without changing its scheduled payday, when available."}]},"paycheckCount":{"type":"integer","minimum":0,"allOf":[{"description":"The number of worker paychecks included in this payroll.","examples":[1]}]},"totals":{"allOf":[{"$ref":"#/components/schemas/PublicPayrollDetailTotals"},{"description":"Employer-facing payroll totals and the provider-reported cash requirement.","examples":[{"cashRequirement":{"amount":355500,"display":"$3,555.00"},"grossPay":{"amount":300000,"display":"$3,000.00"},"netPay":{"amount":230000,"display":"$2,300.00"},"reimbursements":{"amount":15000,"display":"$150.00"},"workerTaxes":{"amount":50000,"display":"$500.00"},"employerTaxes":{"amount":25000,"display":"$250.00"},"preTaxDeductions":{"amount":10000,"display":"$100.00"},"postTaxDeductions":{"amount":5000,"display":"$50.00"},"workerBenefitContributions":{"amount":20000,"display":"$200.00"},"employerBenefitContributions":{"amount":15000,"display":"$150.00"},"transactionFees":{"amount":500,"display":"$5.00"},"totalCost":{"amount":355500,"display":"$3,555.00"}}]}]},"fundingMethod":{"allOf":[{"$ref":"#/components/schemas/PublicPayrollFundingMethod"},{"description":"How the employer funds this payroll.","examples":["ach"]}]},"reopenDeadline":{"anyOf":[{"type":"string","examples":["2026-08-28T17:00:00.000Z"]},{"type":"null"}],"allOf":[{"description":"The deadline to reopen this payroll for changes, when available."}]},"timeline":{"allOf":[{"$ref":"#/components/schemas/PublicPayrollTimeline"},{"description":"Approval timing for this payroll."}]}},"required":["id","type","subtype","status","fundingCurrency","payday","payPeriod","payFrequency","description","approvalDeadline","paycheckCount","totals","fundingMethod","reopenDeadline","timeline"],"additionalProperties":false,"description":"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.","examples":[{"id":"pay_1234","type":"us","subtype":"regular","status":"processing","fundingCurrency":"USD","payday":"2026-08-31","payPeriod":{"startDate":"2026-08-16","endDate":"2026-08-31"},"payFrequency":"semimonthly","description":"August 16–31, 2026 semimonthly payroll","approvalDeadline":"2026-08-27T17:00:00.000Z","paycheckCount":1,"totals":{"cashRequirement":{"amount":355500,"display":"$3,555.00"},"grossPay":{"amount":300000,"display":"$3,000.00"},"netPay":{"amount":230000,"display":"$2,300.00"},"reimbursements":{"amount":15000,"display":"$150.00"},"workerTaxes":{"amount":50000,"display":"$500.00"},"employerTaxes":{"amount":25000,"display":"$250.00"},"preTaxDeductions":{"amount":10000,"display":"$100.00"},"postTaxDeductions":{"amount":5000,"display":"$50.00"},"workerBenefitContributions":{"amount":20000,"display":"$200.00"},"employerBenefitContributions":{"amount":15000,"display":"$150.00"},"transactionFees":{"amount":500,"display":"$5.00"},"totalCost":{"amount":355500,"display":"$3,555.00"}},"fundingMethod":"ach","reopenDeadline":"2026-08-28T17:00:00.000Z","timeline":{"approvedAt":"2026-08-27T16:42:00.000Z"}}]},"PayrollNotFoundErrorEncoded":{"type":"object","properties":{"_tag":{"type":"string","enum":["PayrollNotFoundError"]},"id":{"type":"string","pattern":"^pay_","description":"The tag of the payroll.","examples":["pay_1234"],"allOf":[{"description":"The requested payroll ID.","examples":["pay_1234"]}]},"message":{"type":"string","allOf":[{"description":"A human-readable explanation that the payroll was not found.","examples":["Payroll pay_1234 was not found"]}]}},"required":["_tag","id","message"],"additionalProperties":false},"PublicPaycheckStatus":{"type":"string","enum":["draft","pending","processing","debited","credited","partially_paid","processed","failed","voided"],"description":"The current public lifecycle status of a paycheck.","examples":["processing"]},"PublicPaycheckPaymentMethod":{"type":"string","enum":["direct_deposit","manual"],"description":"The payroll instruction for provider direct deposit or employer-managed manual payment. This does not confirm payout execution.","examples":["direct_deposit"]},"PublicPaycheckPayroll":{"type":"object","properties":{"id":{"type":"string","pattern":"^pay_","description":"The tag of the payroll.","examples":["pay_1234"],"allOf":[{"description":"The ID of the payroll containing this paycheck.","examples":["pay_1234"]}]},"type":{"allOf":[{"$ref":"#/components/schemas/PublicPayrollType"},{"description":"Whether this paycheck is calculated through US or global payroll.","examples":["us"]}]},"subtype":{"allOf":[{"$ref":"#/components/schemas/PublicPayrollSubtype"},{"description":"The business purpose of the payroll containing this paycheck.","examples":["regular"]}]},"status":{"allOf":[{"$ref":"#/components/schemas/PublicPayrollStatus"},{"description":"The current status of the parent payroll.","examples":["processing"]}]},"fundingCurrency":{"allOf":[{"$ref":"#/components/schemas/PublicPayrollCurrency"},{"description":"The currency the employer uses to fund the parent payroll.","examples":["USD"]}]},"payPeriod":{"allOf":[{"$ref":"#/components/schemas/PublicPayPeriod"},{"description":"The work period covered by the parent payroll.","examples":[{"startDate":"2026-08-16","endDate":"2026-08-31"}]}]},"payFrequency":{"anyOf":[{"$ref":"#/components/schemas/PublicPayFrequency"},{"type":"null"}],"allOf":[{"description":"The regular pay cadence associated with the parent payroll, when available.","examples":["semimonthly"]}]}},"required":["id","type","subtype","status","fundingCurrency","payPeriod","payFrequency"],"additionalProperties":false,"description":"The parent payroll context for a paycheck.","examples":[{"id":"pay_1234","type":"us","subtype":"regular","status":"processing","fundingCurrency":"USD","payPeriod":{"startDate":"2026-08-16","endDate":"2026-08-31"},"payFrequency":"semimonthly"}]},"PublicPaycheckWorker":{"type":"object","properties":{"id":{"type":"string","pattern":"^wrk_","description":"The worker id.","examples":["wrk_1234"],"allOf":[{"description":"The worker ID.","examples":["wrk_1234"]}]},"firstName":{"type":"string","description":"The worker first name.","allOf":[{"description":"The worker legal first name as of this paycheck.","examples":["John"]}]},"lastName":{"type":"string","description":"The worker last name.","allOf":[{"description":"The worker legal last name as of this paycheck.","examples":["Galt"]}]},"displayName":{"type":"string","allOf":[{"description":"The worker name to display as of this paycheck. Business contractors use their business name; otherwise the worker's preferred name is used when present, followed by their last name.","examples":["Jack Galt"]}]},"workerType":{"type":"string","enum":["us_w2","us_1099","global_contractor","eor_employee"],"allOf":[{"description":"The worker classification in effect for this paycheck.","examples":["us_w2"]}]}},"required":["id","firstName","lastName","displayName","workerType"],"additionalProperties":false,"description":"The worker identity and historical classification associated with a paycheck.","examples":[{"id":"wrk_1234","firstName":"John","lastName":"Galt","displayName":"Jack Galt","workerType":"us_w2"}]},"PublicCurrencyMoneyAmount_12":{"type":"object","properties":{"amount":{"type":"integer","description":"minor units — cents, e.g. 2345 for $23.45","allOf":[{"minimum":0,"description":"The amount in ISO 4217 minor units. For USD, 300000 represents $3,000.00.","examples":[300000]}]},"display":{"type":"string","description":"The server-formatted display string for the amount in its currency.","examples":["$150,000.00","$85.50"],"allOf":[{"description":"The amount formatted for display in the currency established by the parent object.","examples":["$3,000.00"]}]}},"required":["amount","display"],"additionalProperties":false,"description":"Calculated net pay after reimbursements, worker taxes, deductions, and benefit contributions. It excludes payment execution fees and may differ from the amount the worker ultimately receives. Null in both calculation and funding currencies until net pay is known in both.","examples":[{"amount":230000,"display":"$2,300.00"}]},"PublicPaycheckSummaryCurrencyTotals":{"type":"object","properties":{"currency":{"allOf":[{"$ref":"#/components/schemas/PublicPayrollCurrency"},{"description":"The currency shared by every amount in this totals object.","examples":["USD"]}]},"netPay":{"anyOf":[{"$ref":"#/components/schemas/PublicCurrencyMoneyAmount_12"},{"type":"null"}]}},"required":["currency","netPay"],"additionalProperties":false,"description":"Compact paycheck totals in one calculation currency.","examples":[{"currency":"USD","netPay":{"amount":230000,"display":"$2,300.00"}}]},"PublicPaycheckSummaryTotals":{"type":"object","properties":{"byCurrency":{"type":"array","items":{"$ref":"#/components/schemas/PublicPaycheckSummaryCurrencyTotals"},"minItems":1,"allOf":[{"description":"Calculation totals grouped by currency. The current implementation returns one entry, but clients must support multiple currencies.","examples":[[{"currency":"USD","netPay":{"amount":230000,"display":"$2,300.00"}}]]}]},"inFundingCurrency":{"allOf":[{"$ref":"#/components/schemas/PublicPaycheckSummaryCurrencyTotals"},{"description":"Authoritative totals converted to the parent payroll funding currency after per-currency subtotaling and rounding.","examples":[{"currency":"USD","netPay":{"amount":230000,"display":"$2,300.00"}}]}]}},"required":["byCurrency","inFundingCurrency"],"additionalProperties":false,"description":"Compact paycheck totals in calculation and payroll funding currencies.","examples":[{"byCurrency":[{"currency":"USD","netPay":{"amount":230000,"display":"$2,300.00"}}],"inFundingCurrency":{"currency":"USD","netPay":{"amount":230000,"display":"$2,300.00"}}}]},"PublicPaycheckSummary":{"type":"object","properties":{"id":{"type":"string","pattern":"^pyc_","description":"The tag of the paycheck.","examples":["pyc_1234"],"allOf":[{"description":"The paycheck ID.","examples":["pyc_1234"]}]},"payroll":{"allOf":[{"$ref":"#/components/schemas/PublicPaycheckPayroll"},{"description":"The payroll containing this paycheck.","examples":[{"id":"pay_1234","type":"us","subtype":"regular","status":"processing","fundingCurrency":"USD","payPeriod":{"startDate":"2026-08-16","endDate":"2026-08-31"},"payFrequency":"semimonthly"}]}]},"worker":{"allOf":[{"$ref":"#/components/schemas/PublicPaycheckWorker"},{"description":"The worker and classification associated with this paycheck.","examples":[{"id":"wrk_1234","firstName":"John","lastName":"Galt","displayName":"Jack Galt","workerType":"us_w2"}]}]},"status":{"allOf":[{"$ref":"#/components/schemas/PublicPaycheckStatus"},{"description":"The paycheck's current processing status.","examples":["processing"]}]},"payday":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","allOf":[{"description":"The date payment to the worker is scheduled.","examples":["2026-08-31"]}]},"paymentMethod":{"allOf":[{"$ref":"#/components/schemas/PublicPaycheckPaymentMethod"},{"description":"How this paycheck is intended to be delivered.","examples":["direct_deposit"]}]},"totals":{"allOf":[{"$ref":"#/components/schemas/PublicPaycheckSummaryTotals"},{"description":"Net pay grouped by calculation currency and converted to payroll funding currency.","examples":[{"byCurrency":[{"currency":"USD","netPay":{"amount":230000,"display":"$2,300.00"}}],"inFundingCurrency":{"currency":"USD","netPay":{"amount":230000,"display":"$2,300.00"}}}]}]}},"required":["id","payroll","worker","status","payday","paymentMethod","totals"],"additionalProperties":false,"description":"A compact per-worker paycheck within a payroll.","examples":[{"id":"pyc_1234","payroll":{"id":"pay_1234","type":"us","subtype":"regular","status":"processing","fundingCurrency":"USD","payPeriod":{"startDate":"2026-08-16","endDate":"2026-08-31"},"payFrequency":"semimonthly"},"worker":{"id":"wrk_1234","firstName":"John","lastName":"Galt","displayName":"Jack Galt","workerType":"us_w2"},"status":"processing","payday":"2026-08-31","paymentMethod":"direct_deposit","totals":{"byCurrency":[{"currency":"USD","netPay":{"amount":230000,"display":"$2,300.00"}}],"inFundingCurrency":{"currency":"USD","netPay":{"amount":230000,"display":"$2,300.00"}}}}]},"PublicPaycheckListResponse":{"type":"object","properties":{"hasMore":{"type":"boolean","allOf":[{"description":"Whether another page of matching paychecks is available in the requested cursor direction.","examples":[false]}]},"count":{"type":"integer","allOf":[{"description":"The total number of paychecks matching the filters, before cursor pagination.","examples":[1]}]},"data":{"type":"array","items":{"$ref":"#/components/schemas/PublicPaycheckSummary"},"allOf":[{"description":"The paycheck summaries in this page.","examples":[[{"id":"pyc_1234","payroll":{"id":"pay_1234","type":"us","subtype":"regular","status":"processing","fundingCurrency":"USD","payPeriod":{"startDate":"2026-08-16","endDate":"2026-08-31"},"payFrequency":"semimonthly"},"worker":{"id":"wrk_1234","firstName":"John","lastName":"Galt","displayName":"Jack Galt","workerType":"us_w2"},"status":"processing","payday":"2026-08-31","paymentMethod":"direct_deposit","totals":{"byCurrency":[{"currency":"USD","netPay":{"amount":230000,"display":"$2,300.00"}}],"inFundingCurrency":{"currency":"USD","netPay":{"amount":230000,"display":"$2,300.00"}}}}]]}]}},"required":["hasMore","count","data"],"additionalProperties":false,"description":"A cursor-paginated page of paycheck summaries.","examples":[{"hasMore":false,"count":1,"data":[{"id":"pyc_1234","payroll":{"id":"pay_1234","type":"us","subtype":"regular","status":"processing","fundingCurrency":"USD","payPeriod":{"startDate":"2026-08-16","endDate":"2026-08-31"},"payFrequency":"semimonthly"},"worker":{"id":"wrk_1234","firstName":"John","lastName":"Galt","displayName":"Jack Galt","workerType":"us_w2"},"status":"processing","payday":"2026-08-31","paymentMethod":"direct_deposit","totals":{"byCurrency":[{"currency":"USD","netPay":{"amount":230000,"display":"$2,300.00"}}],"inFundingCurrency":{"currency":"USD","netPay":{"amount":230000,"display":"$2,300.00"}}}}]}]},"PublicCurrencyMoneyAmount_13":{"type":"object","properties":{"amount":{"type":"integer","description":"minor units — cents, e.g. 2345 for $23.45","allOf":[{"minimum":0,"description":"The amount in ISO 4217 minor units. For USD, 300000 represents $3,000.00.","examples":[300000]}]},"display":{"type":"string","description":"The server-formatted display string for the amount in its currency.","examples":["$150,000.00","$85.50"],"allOf":[{"description":"The amount formatted for display in the currency established by the parent object.","examples":["$3,000.00"]}]}},"required":["amount","display"],"additionalProperties":false,"description":"Gross earnings before worker taxes, deductions, and benefit contributions. Reimbursements are reported separately.","examples":[{"amount":300000,"display":"$3,000.00"}]},"PublicCurrencyMoneyAmount_14":{"type":"object","properties":{"amount":{"type":"integer","description":"minor units — cents, e.g. 2345 for $23.45","allOf":[{"minimum":0,"description":"The amount in ISO 4217 minor units. For USD, 300000 represents $3,000.00.","examples":[300000]}]},"display":{"type":"string","description":"The server-formatted display string for the amount in its currency.","examples":["$150,000.00","$85.50"],"allOf":[{"description":"The amount formatted for display in the currency established by the parent object.","examples":["$3,000.00"]}]}},"required":["amount","display"],"additionalProperties":false,"description":"Amounts reimbursed to the worker in addition to gross pay. Reimbursements increase net pay and employer cost.","examples":[{"amount":15000,"display":"$150.00"}]},"PublicCurrencyMoneyAmount_15":{"type":"object","properties":{"amount":{"type":"integer","description":"minor units — cents, e.g. 2345 for $23.45","allOf":[{"minimum":0,"description":"The amount in ISO 4217 minor units. For USD, 300000 represents $3,000.00.","examples":[300000]}]},"display":{"type":"string","description":"The server-formatted display string for the amount in its currency.","examples":["$150,000.00","$85.50"],"allOf":[{"description":"The amount formatted for display in the currency established by the parent object.","examples":["$3,000.00"]}]}},"required":["amount","display"],"additionalProperties":false,"description":"Payroll taxes withheld from the worker's pay, reducing net pay.","examples":[{"amount":50000,"display":"$500.00"}]},"PublicCurrencyMoneyAmount_16":{"type":"object","properties":{"amount":{"type":"integer","description":"minor units — cents, e.g. 2345 for $23.45","allOf":[{"minimum":0,"description":"The amount in ISO 4217 minor units. For USD, 300000 represents $3,000.00.","examples":[300000]}]},"display":{"type":"string","description":"The server-formatted display string for the amount in its currency.","examples":["$150,000.00","$85.50"],"allOf":[{"description":"The amount formatted for display in the currency established by the parent object.","examples":["$3,000.00"]}]}},"required":["amount","display"],"additionalProperties":false,"description":"Payroll taxes paid by the employer in addition to gross pay.","examples":[{"amount":25000,"display":"$250.00"}]},"PublicCurrencyMoneyAmount_17":{"type":"object","properties":{"amount":{"type":"integer","description":"minor units — cents, e.g. 2345 for $23.45","allOf":[{"minimum":0,"description":"The amount in ISO 4217 minor units. For USD, 300000 represents $3,000.00.","examples":[300000]}]},"display":{"type":"string","description":"The server-formatted display string for the amount in its currency.","examples":["$150,000.00","$85.50"],"allOf":[{"description":"The amount formatted for display in the currency established by the parent object.","examples":["$3,000.00"]}]}},"required":["amount","display"],"additionalProperties":false,"description":"Non-benefit amounts deducted from the worker's pay before taxes, reducing taxable pay and net pay.","examples":[{"amount":10000,"display":"$100.00"}]},"PublicCurrencyMoneyAmount_18":{"type":"object","properties":{"amount":{"type":"integer","description":"minor units — cents, e.g. 2345 for $23.45","allOf":[{"minimum":0,"description":"The amount in ISO 4217 minor units. For USD, 300000 represents $3,000.00.","examples":[300000]}]},"display":{"type":"string","description":"The server-formatted display string for the amount in its currency.","examples":["$150,000.00","$85.50"],"allOf":[{"description":"The amount formatted for display in the currency established by the parent object.","examples":["$3,000.00"]}]}},"required":["amount","display"],"additionalProperties":false,"description":"Non-benefit amounts deducted from the worker's pay after taxes, reducing net pay.","examples":[{"amount":5000,"display":"$50.00"}]},"PublicCurrencyMoneyAmount_19":{"type":"object","properties":{"amount":{"type":"integer","description":"minor units — cents, e.g. 2345 for $23.45","allOf":[{"minimum":0,"description":"The amount in ISO 4217 minor units. For USD, 300000 represents $3,000.00.","examples":[300000]}]},"display":{"type":"string","description":"The server-formatted display string for the amount in its currency.","examples":["$150,000.00","$85.50"],"allOf":[{"description":"The amount formatted for display in the currency established by the parent object.","examples":["$3,000.00"]}]}},"required":["amount","display"],"additionalProperties":false,"description":"Amounts the worker pays toward benefits, deducted from their pay.","examples":[{"amount":20000,"display":"$200.00"}]},"PublicCurrencyMoneyAmount_20":{"type":"object","properties":{"amount":{"type":"integer","description":"minor units — cents, e.g. 2345 for $23.45","allOf":[{"minimum":0,"description":"The amount in ISO 4217 minor units. For USD, 300000 represents $3,000.00.","examples":[300000]}]},"display":{"type":"string","description":"The server-formatted display string for the amount in its currency.","examples":["$150,000.00","$85.50"],"allOf":[{"description":"The amount formatted for display in the currency established by the parent object.","examples":["$3,000.00"]}]}},"required":["amount","display"],"additionalProperties":false,"description":"Amounts the employer pays toward the worker's benefits in addition to gross pay.","examples":[{"amount":15000,"display":"$150.00"}]},"PublicPaycheckCurrencyTotals":{"type":"object","properties":{"currency":{"allOf":[{"$ref":"#/components/schemas/PublicPayrollCurrency"},{"description":"The currency shared by every amount in this totals object.","examples":["USD"]}]},"grossPay":{"$ref":"#/components/schemas/PublicCurrencyMoneyAmount_13"},"netPay":{"anyOf":[{"$ref":"#/components/schemas/PublicCurrencyMoneyAmount_12"},{"type":"null"}]},"reimbursements":{"$ref":"#/components/schemas/PublicCurrencyMoneyAmount_14"},"workerTaxes":{"$ref":"#/components/schemas/PublicCurrencyMoneyAmount_15"},"employerTaxes":{"$ref":"#/components/schemas/PublicCurrencyMoneyAmount_16"},"preTaxDeductions":{"$ref":"#/components/schemas/PublicCurrencyMoneyAmount_17"},"postTaxDeductions":{"$ref":"#/components/schemas/PublicCurrencyMoneyAmount_18"},"workerBenefitContributions":{"$ref":"#/components/schemas/PublicCurrencyMoneyAmount_19"},"employerBenefitContributions":{"$ref":"#/components/schemas/PublicCurrencyMoneyAmount_20"}},"required":["currency","grossPay","netPay","reimbursements","workerTaxes","employerTaxes","preTaxDeductions","postTaxDeductions","workerBenefitContributions","employerBenefitContributions"],"additionalProperties":false,"description":"Paycheck category totals in one currency. Every category is present, including zero-valued categories; netPay is null until known.","examples":[{"currency":"USD","grossPay":{"amount":300000,"display":"$3,000.00"},"netPay":{"amount":230000,"display":"$2,300.00"},"reimbursements":{"amount":15000,"display":"$150.00"},"workerTaxes":{"amount":50000,"display":"$500.00"},"employerTaxes":{"amount":25000,"display":"$250.00"},"preTaxDeductions":{"amount":10000,"display":"$100.00"},"postTaxDeductions":{"amount":5000,"display":"$50.00"},"workerBenefitContributions":{"amount":20000,"display":"$200.00"},"employerBenefitContributions":{"amount":15000,"display":"$150.00"}}]},"PublicPaycheckDetailTotals":{"type":"object","properties":{"byCurrency":{"type":"array","items":{"$ref":"#/components/schemas/PublicPaycheckCurrencyTotals"},"minItems":1,"allOf":[{"description":"Calculation totals grouped by currency. The current implementation returns one entry, but clients must support multiple currencies.","examples":[[{"currency":"USD","grossPay":{"amount":300000,"display":"$3,000.00"},"netPay":{"amount":230000,"display":"$2,300.00"},"reimbursements":{"amount":15000,"display":"$150.00"},"workerTaxes":{"amount":50000,"display":"$500.00"},"employerTaxes":{"amount":25000,"display":"$250.00"},"preTaxDeductions":{"amount":10000,"display":"$100.00"},"postTaxDeductions":{"amount":5000,"display":"$50.00"},"workerBenefitContributions":{"amount":20000,"display":"$200.00"},"employerBenefitContributions":{"amount":15000,"display":"$150.00"}}]]}]},"inFundingCurrency":{"allOf":[{"$ref":"#/components/schemas/PublicPaycheckCurrencyTotals"},{"description":"Authoritative category totals in the parent payroll funding currency. Each category is subtotaled by calculation currency, converted once, rounded to funding-currency minor units, and then summed.","examples":[{"currency":"USD","grossPay":{"amount":300000,"display":"$3,000.00"},"netPay":{"amount":230000,"display":"$2,300.00"},"reimbursements":{"amount":15000,"display":"$150.00"},"workerTaxes":{"amount":50000,"display":"$500.00"},"employerTaxes":{"amount":25000,"display":"$250.00"},"preTaxDeductions":{"amount":10000,"display":"$100.00"},"postTaxDeductions":{"amount":5000,"display":"$50.00"},"workerBenefitContributions":{"amount":20000,"display":"$200.00"},"employerBenefitContributions":{"amount":15000,"display":"$150.00"}}]}]}},"required":["byCurrency","inFundingCurrency"],"additionalProperties":false,"description":"Detailed paycheck totals in calculation and payroll funding currencies.","examples":[{"byCurrency":[{"currency":"USD","grossPay":{"amount":300000,"display":"$3,000.00"},"netPay":{"amount":230000,"display":"$2,300.00"},"reimbursements":{"amount":15000,"display":"$150.00"},"workerTaxes":{"amount":50000,"display":"$500.00"},"employerTaxes":{"amount":25000,"display":"$250.00"},"preTaxDeductions":{"amount":10000,"display":"$100.00"},"postTaxDeductions":{"amount":5000,"display":"$50.00"},"workerBenefitContributions":{"amount":20000,"display":"$200.00"},"employerBenefitContributions":{"amount":15000,"display":"$150.00"}}],"inFundingCurrency":{"currency":"USD","grossPay":{"amount":300000,"display":"$3,000.00"},"netPay":{"amount":230000,"display":"$2,300.00"},"reimbursements":{"amount":15000,"display":"$150.00"},"workerTaxes":{"amount":50000,"display":"$500.00"},"employerTaxes":{"amount":25000,"display":"$250.00"},"preTaxDeductions":{"amount":10000,"display":"$100.00"},"postTaxDeductions":{"amount":5000,"display":"$50.00"},"workerBenefitContributions":{"amount":20000,"display":"$200.00"},"employerBenefitContributions":{"amount":15000,"display":"$150.00"}}}]},"PublicPaycheckYearToDateMoneyAmount":{"type":"object","properties":{"amount":{"type":"integer","description":"minor units — cents, e.g. 2345 for $23.45","allOf":[{"description":"The signed amount in ISO currency minor units. USD values are cents; negative values preserve refunds and corrections.","examples":[-1250]}]},"currency":{"allOf":[{"$ref":"#/components/schemas/PublicPayrollCurrency"},{"description":"The ISO 4217 currency of this amount.","examples":["USD"]}]},"display":{"type":"string","description":"The server-formatted display string for the amount in its currency.","examples":["$150,000.00","$85.50"],"allOf":[{"description":"The amount formatted for display in its currency.","examples":["$3,000.00"]}]}},"required":["amount","currency","display"],"additionalProperties":false,"description":"Gross earnings year-to-date for the selected paystub.","examples":[{"amount":2400000,"currency":"USD","display":"$24,000.00"}]},"PublicPaycheckYearToDateMoneyAmount_1":{"type":"object","properties":{"amount":{"type":"integer","description":"minor units — cents, e.g. 2345 for $23.45","allOf":[{"description":"The signed amount in ISO currency minor units. USD values are cents; negative values preserve refunds and corrections.","examples":[-1250]}]},"currency":{"allOf":[{"$ref":"#/components/schemas/PublicPayrollCurrency"},{"description":"The ISO 4217 currency of this amount.","examples":["USD"]}]},"display":{"type":"string","description":"The server-formatted display string for the amount in its currency.","examples":["$150,000.00","$85.50"],"allOf":[{"description":"The amount formatted for display in its currency.","examples":["$3,000.00"]}]}},"required":["amount","currency","display"],"additionalProperties":false,"description":"Net pay year-to-date for the selected paystub.","examples":[{"amount":1880000,"currency":"USD","display":"$18,800.00"}]},"PublicPaycheckYearToDateMoneyAmount_2":{"type":"object","properties":{"amount":{"type":"integer","description":"minor units — cents, e.g. 2345 for $23.45","allOf":[{"description":"The signed amount in ISO currency minor units. USD values are cents; negative values preserve refunds and corrections.","examples":[-1250]}]},"currency":{"allOf":[{"$ref":"#/components/schemas/PublicPayrollCurrency"},{"description":"The ISO 4217 currency of this amount.","examples":["USD"]}]},"display":{"type":"string","description":"The server-formatted display string for the amount in its currency.","examples":["$150,000.00","$85.50"],"allOf":[{"description":"The amount formatted for display in its currency.","examples":["$3,000.00"]}]}},"required":["amount","currency","display"],"additionalProperties":false,"description":"Employee taxes withheld year-to-date for the selected paystub.","examples":[{"amount":400000,"currency":"USD","display":"$4,000.00"}]},"PublicPaycheckYearToDateMoneyAmount_3":{"type":"object","properties":{"amount":{"type":"integer","description":"minor units — cents, e.g. 2345 for $23.45","allOf":[{"description":"The signed amount in ISO currency minor units. USD values are cents; negative values preserve refunds and corrections.","examples":[-1250]}]},"currency":{"allOf":[{"$ref":"#/components/schemas/PublicPayrollCurrency"},{"description":"The ISO 4217 currency of this amount.","examples":["USD"]}]},"display":{"type":"string","description":"The server-formatted display string for the amount in its currency.","examples":["$150,000.00","$85.50"],"allOf":[{"description":"The amount formatted for display in its currency.","examples":["$3,000.00"]}]}},"required":["amount","currency","display"],"additionalProperties":false,"description":"Employee benefit contributions year-to-date for the selected paystub.","examples":[{"amount":160000,"currency":"USD","display":"$1,600.00"}]},"PublicPaycheckYearToDateMoneyAmount_4":{"type":"object","properties":{"amount":{"type":"integer","description":"minor units — cents, e.g. 2345 for $23.45","allOf":[{"description":"The signed amount in ISO currency minor units. USD values are cents; negative values preserve refunds and corrections.","examples":[-1250]}]},"currency":{"allOf":[{"$ref":"#/components/schemas/PublicPayrollCurrency"},{"description":"The ISO 4217 currency of this amount.","examples":["USD"]}]},"display":{"type":"string","description":"The server-formatted display string for the amount in its currency.","examples":["$150,000.00","$85.50"],"allOf":[{"description":"The amount formatted for display in its currency.","examples":["$3,000.00"]}]}},"required":["amount","currency","display"],"additionalProperties":false,"description":"Reimbursements year-to-date for the selected paystub.","examples":[{"amount":120000,"currency":"USD","display":"$1,200.00"}]},"PublicPaycheckYearToDateMoneyAmount_5":{"type":"object","properties":{"amount":{"type":"integer","description":"minor units — cents, e.g. 2345 for $23.45","allOf":[{"description":"The signed amount in ISO currency minor units. USD values are cents; negative values preserve refunds and corrections.","examples":[-1250]}]},"currency":{"allOf":[{"$ref":"#/components/schemas/PublicPayrollCurrency"},{"description":"The ISO 4217 currency of this amount.","examples":["USD"]}]},"display":{"type":"string","description":"The server-formatted display string for the amount in its currency.","examples":["$150,000.00","$85.50"],"allOf":[{"description":"The amount formatted for display in its currency.","examples":["$3,000.00"]}]}},"required":["amount","currency","display"],"additionalProperties":false,"description":"Post-tax deductions year-to-date for the selected paystub.","examples":[{"amount":80000,"currency":"USD","display":"$800.00"}]},"PublicPaycheckYearToDateTotals":{"type":"object","properties":{"grossPay":{"$ref":"#/components/schemas/PublicPaycheckYearToDateMoneyAmount"},"netPay":{"$ref":"#/components/schemas/PublicPaycheckYearToDateMoneyAmount_1"},"workerTaxes":{"$ref":"#/components/schemas/PublicPaycheckYearToDateMoneyAmount_2"},"workerBenefitContributions":{"$ref":"#/components/schemas/PublicPaycheckYearToDateMoneyAmount_3"},"reimbursements":{"$ref":"#/components/schemas/PublicPaycheckYearToDateMoneyAmount_4"},"postTaxDeductions":{"$ref":"#/components/schemas/PublicPaycheckYearToDateMoneyAmount_5"}},"required":["grossPay","netPay","workerTaxes","workerBenefitContributions","reimbursements","postTaxDeductions"],"additionalProperties":false,"description":"Provider-reported employee YTD category totals, in signed USD cents.","examples":[{"grossPay":{"amount":2400000,"currency":"USD","display":"$24,000.00"},"netPay":{"amount":1880000,"currency":"USD","display":"$18,800.00"},"workerTaxes":{"amount":400000,"currency":"USD","display":"$4,000.00"},"workerBenefitContributions":{"amount":160000,"currency":"USD","display":"$1,600.00"},"reimbursements":{"amount":120000,"currency":"USD","display":"$1,200.00"},"postTaxDeductions":{"amount":80000,"currency":"USD","display":"$800.00"}}]},"PublicPaycheckYearToDateMoneyAmount_6":{"type":"object","properties":{"amount":{"type":"integer","description":"minor units — cents, e.g. 2345 for $23.45","allOf":[{"description":"The signed amount in ISO currency minor units. USD values are cents; negative values preserve refunds and corrections.","examples":[-1250]}]},"currency":{"allOf":[{"$ref":"#/components/schemas/PublicPayrollCurrency"},{"description":"The ISO 4217 currency of this amount.","examples":["USD"]}]},"display":{"type":"string","description":"The server-formatted display string for the amount in its currency.","examples":["$150,000.00","$85.50"],"allOf":[{"description":"The amount formatted for display in its currency.","examples":["$3,000.00"]}]}},"required":["amount","currency","display"],"additionalProperties":false,"description":"The signed year-to-date amount for this employee group, in USD cents with a display value.","examples":[{"amount":2400000,"currency":"USD","display":"$24,000.00"}]},"PublicPaycheckYearToDateLine":{"type":"object","properties":{"description":{"type":"string","allOf":[{"description":"The paystub group label. Groups do not identify individual calculation lines.","examples":["Regular"]}]},"amount":{"$ref":"#/components/schemas/PublicPaycheckYearToDateMoneyAmount_6"}},"required":["description","amount"],"additionalProperties":false,"description":"An employee year-to-date paystub group.","examples":[{"description":"Regular","amount":{"amount":2400000,"currency":"USD","display":"$24,000.00"}}]},"PublicPaycheckYearToDate":{"type":"object","properties":{"asOfDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","allOf":[{"description":"The selected paystub payday. YTD values are those returned for that paystub and its calendar year.","examples":["2026-08-31"]}]},"totals":{"$ref":"#/components/schemas/PublicPaycheckYearToDateTotals"},"earnings":{"type":"array","items":{"$ref":"#/components/schemas/PublicPaycheckYearToDateLine"},"allOf":[{"description":"YTD earnings grouped by paystub earning type or code, rather than workplace or individual calculation line.","examples":[[{"description":"Regular","amount":{"amount":2400000,"currency":"USD","display":"$24,000.00"}}]]}]},"taxes":{"type":"array","items":{"$ref":"#/components/schemas/PublicPaycheckYearToDateLine"},"allOf":[{"description":"Individual employee tax withholding groups. Employer taxes are excluded.","examples":[[{"description":"Federal Income Tax","amount":{"amount":400000,"currency":"USD","display":"$4,000.00"}}]]}]},"benefits":{"type":"array","items":{"$ref":"#/components/schemas/PublicPaycheckYearToDateLine"},"allOf":[{"description":"Employee benefit contribution groups. Employer contributions are excluded.","examples":[[{"description":"Medical insurance","amount":{"amount":160000,"currency":"USD","display":"$1,600.00"}}]]}]},"reimbursements":{"type":"array","items":{"$ref":"#/components/schemas/PublicPaycheckYearToDateLine"},"allOf":[{"description":"Paystub reimbursement groups, rather than individual expenses.","examples":[[{"description":"Reimbursements","amount":{"amount":120000,"currency":"USD","display":"$1,200.00"}}]]}]},"deductions":{"type":"array","items":{"$ref":"#/components/schemas/PublicPaycheckYearToDateLine"},"allOf":[{"description":"Employee post-tax deduction groups.","examples":[[{"description":"Wage garnishment","amount":{"amount":80000,"currency":"USD","display":"$800.00"}}]]}]}},"required":["asOfDate","totals","earnings","taxes","benefits","reimbursements","deductions"],"additionalProperties":false,"description":"Employee YTD amounts for the selected US W-2 paystub. Groups with a nonzero current or YTD amount are included, including historical-only groups with no amount on this paycheck.","examples":[{"asOfDate":"2026-08-31","totals":{"grossPay":{"amount":2400000,"currency":"USD","display":"$24,000.00"},"netPay":{"amount":1880000,"currency":"USD","display":"$18,800.00"},"workerTaxes":{"amount":400000,"currency":"USD","display":"$4,000.00"},"workerBenefitContributions":{"amount":160000,"currency":"USD","display":"$1,600.00"},"reimbursements":{"amount":120000,"currency":"USD","display":"$1,200.00"},"postTaxDeductions":{"amount":80000,"currency":"USD","display":"$800.00"}},"earnings":[{"description":"Regular","amount":{"amount":2400000,"currency":"USD","display":"$24,000.00"}}],"taxes":[{"description":"Federal Income Tax","amount":{"amount":400000,"currency":"USD","display":"$4,000.00"}}],"benefits":[{"description":"Medical insurance","amount":{"amount":160000,"currency":"USD","display":"$1,600.00"}}],"reimbursements":[{"description":"Reimbursements","amount":{"amount":120000,"currency":"USD","display":"$1,200.00"}}],"deductions":[{"description":"Wage garnishment","amount":{"amount":80000,"currency":"USD","display":"$800.00"}}]}]},"PublicExchangeRateValue":{"type":"string","pattern":"^(?=.*[1-9])(?:0|[1-9]\\d{0,17})(?:\\.\\d{1,18})?$","description":"A positive base-10 decimal string with up to 18 integer and 18 fractional digits. Scientific notation is not accepted.","examples":["1.083741"]},"PublicExchangeRate":{"type":"object","properties":{"fromCurrency":{"allOf":[{"$ref":"#/components/schemas/PublicPayrollCurrency"},{"description":"The currency being converted.","examples":["EUR"]}]},"toCurrency":{"allOf":[{"$ref":"#/components/schemas/PublicPayrollCurrency"},{"description":"The parent payroll's funding currency.","examples":["USD"]}]},"rate":{"allOf":[{"$ref":"#/components/schemas/PublicExchangeRateValue"},{"description":"The multiplier used to convert a major-unit amount from fromCurrency into its toCurrency equivalent.","examples":["1.083741"]}]}},"required":["fromCurrency","toCurrency","rate"],"additionalProperties":false,"description":"A directed exchange rate where a fromCurrency major-unit amount multiplied by rate equals its toCurrency equivalent.","examples":[{"fromCurrency":"EUR","toCurrency":"USD","rate":"1.083741"}]},"PublicPayrollMoneyAmount":{"type":"object","properties":{"amount":{"type":"integer","description":"minor units — cents, e.g. 2345 for $23.45","allOf":[{"minimum":0,"description":"The amount in ISO 4217 minor units. For USD, 300000 represents $3,000.00.","examples":[300000]}]},"currency":{"allOf":[{"$ref":"#/components/schemas/PublicPayrollCurrency"},{"description":"The ISO 4217 currency of this amount.","examples":["USD"]}]},"display":{"type":"string","description":"The server-formatted display string for the amount in its currency.","examples":["$150,000.00","$85.50"],"allOf":[{"description":"The amount formatted for display in its currency.","examples":["$3,000.00"]}]}},"required":["amount","currency","display"],"additionalProperties":false,"description":"The gross earnings attributed to this line in the amount's currency.","examples":[{"amount":300000,"currency":"USD","display":"$3,000.00"}]},"PublicHourlyRateAmount":{"type":"string","pattern":"^(?:0|[1-9]\\d{0,17})(?:\\.\\d{1,18})?$","description":"A non-negative base-10 decimal string with up to 18 integer and 18 fractional digits. Scientific notation is not accepted.","examples":["50.00","75.125"]},"PublicHourlyRate":{"type":"object","properties":{"amount":{"allOf":[{"$ref":"#/components/schemas/PublicHourlyRateAmount"},{"description":"The exact hourly rate in major currency units. This is a decimal string because rates may carry sub-minor-unit precision.","examples":["50.00"]}]},"currency":{"allOf":[{"$ref":"#/components/schemas/PublicPayrollCurrency"},{"description":"The currency of the hourly rate.","examples":["USD"]}]},"per":{"type":"string","enum":["hour"],"allOf":[{"description":"The unit of work the rate applies to.","examples":["hour"]}]}},"required":["amount","currency","per"],"additionalProperties":false,"description":"A non-negative major-unit hourly rate. The earning amount remains authoritative.","examples":[{"amount":"50.00","currency":"USD","per":"hour"}]},"PublicPayrollMoneyAmount_1":{"type":"object","properties":{"amount":{"type":"integer","description":"minor units — cents, e.g. 2345 for $23.45","allOf":[{"minimum":0,"description":"The amount in ISO 4217 minor units. For USD, 300000 represents $3,000.00.","examples":[300000]}]},"currency":{"allOf":[{"$ref":"#/components/schemas/PublicPayrollCurrency"},{"description":"The ISO 4217 currency of this amount.","examples":["USD"]}]},"display":{"type":"string","description":"The server-formatted display string for the amount in its currency.","examples":["$150,000.00","$85.50"],"allOf":[{"description":"The amount formatted for display in its currency.","examples":["$3,000.00"]}]}},"required":["amount","currency","display"],"additionalProperties":false,"description":"An amount in ISO currency minor units with a server-formatted display value.","examples":[{"amount":300000,"currency":"USD","display":"$3,000.00"}]},"PublicPaycheckSourceRate":{"type":"object","properties":{"amount":{"allOf":[{"$ref":"#/components/schemas/PublicPayrollMoneyAmount_1"},{"description":"The compensation rate amount before pay-period proration.","examples":[{"amount":12000000,"currency":"USD","display":"$120,000.00"}]}]},"basis":{"type":"string","enum":["yearly","monthly","weekly","hourly"],"allOf":[{"description":"The time basis of the saved compensation rate.","examples":["yearly"]}]}},"required":["amount","basis"],"additionalProperties":false,"description":"The effective compensation rate captured when the earning was saved, before proration.","examples":[{"amount":{"amount":12000000,"currency":"USD","display":"$120,000.00"},"basis":"yearly"}]},"PublicPaycheckEarning":{"type":"object","properties":{"type":{"type":"string","enum":["hourly","salaried","overtime","double_overtime","paid_holiday","pto","sick","commission","bonus","severance","non_hourly_regular","fixed","group_term_life","other_imputed","2_percent_shareholder_benefits"],"allOf":[{"description":"The earning category used in the paycheck calculation.","examples":["hourly"]}]},"workplaceId":{"anyOf":[{"type":"string","pattern":"^wkp_","description":"Public workplace identifier","examples":["wkp_1234"]},{"type":"null"}],"allOf":[{"description":"The workplace associated with this earning, when available.","examples":["wkp_1234"]}]},"amount":{"$ref":"#/components/schemas/PublicPayrollMoneyAmount"},"hours":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}],"allOf":[{"description":"The hours reported for this earning, or null when hours were not provided.","examples":[60]}]},"hourlyRate":{"anyOf":[{"$ref":"#/components/schemas/PublicHourlyRate"},{"type":"null"}],"allOf":[{"description":"The hourly rate used for this earning, or null when no hourly rate was provided.","examples":[{"amount":"50.00","currency":"USD","per":"hour"}]}]},"sourceRate":{"anyOf":[{"$ref":"#/components/schemas/PublicPaycheckSourceRate"},{"type":"null"}],"allOf":[{"description":"The original source rate and basis, or null when no source rate was captured.","examples":[null]}]},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"allOf":[{"description":"A description of the earning, when available.","examples":["Regular hours"]}]}},"required":["type","workplaceId","amount","hours","hourlyRate","sourceRate","description"],"additionalProperties":false,"description":"One earning calculation line. Lines have no durable public identity.","examples":[{"type":"hourly","workplaceId":"wkp_1234","amount":{"amount":300000,"currency":"USD","display":"$3,000.00"},"hours":60,"hourlyRate":{"amount":"50.00","currency":"USD","per":"hour"},"sourceRate":null,"description":"Regular hours"}]},"PublicPayrollMoneyAmount_2":{"type":"object","properties":{"amount":{"type":"integer","description":"minor units — cents, e.g. 2345 for $23.45","allOf":[{"minimum":0,"description":"The amount in ISO 4217 minor units. For USD, 300000 represents $3,000.00.","examples":[300000]}]},"currency":{"allOf":[{"$ref":"#/components/schemas/PublicPayrollCurrency"},{"description":"The ISO 4217 currency of this amount.","examples":["USD"]}]},"display":{"type":"string","description":"The server-formatted display string for the amount in its currency.","examples":["$150,000.00","$85.50"],"allOf":[{"description":"The amount formatted for display in its currency.","examples":["$3,000.00"]}]}},"required":["amount","currency","display"],"additionalProperties":false,"description":"The amount reimbursed to the worker on this paycheck in the amount's currency. It may differ from the currency of the original expense.","examples":[{"amount":15000,"currency":"USD","display":"$150.00"}]},"PublicPaycheckReimbursement":{"type":"object","properties":{"amount":{"$ref":"#/components/schemas/PublicPayrollMoneyAmount_2"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"allOf":[{"description":"A description of the reimbursement, when available.","examples":["Client travel reimbursement"]}]}},"required":["amount","description"],"additionalProperties":false,"description":"One reimbursement calculation line. Lines have no durable public identity.","examples":[{"amount":{"amount":15000,"currency":"USD","display":"$150.00"},"description":"Client travel reimbursement"}]},"PublicPaycheckDeductionTaxTreatment":{"type":"string","enum":["pre_tax","post_tax"],"description":"Whether the deduction is applied before or after taxes.","examples":["pre_tax"]},"PublicPayrollMoneyAmount_3":{"type":"object","properties":{"amount":{"type":"integer","description":"minor units — cents, e.g. 2345 for $23.45","allOf":[{"minimum":0,"description":"The amount in ISO 4217 minor units. For USD, 300000 represents $3,000.00.","examples":[300000]}]},"currency":{"allOf":[{"$ref":"#/components/schemas/PublicPayrollCurrency"},{"description":"The ISO 4217 currency of this amount.","examples":["USD"]}]},"display":{"type":"string","description":"The server-formatted display string for the amount in its currency.","examples":["$150,000.00","$85.50"],"allOf":[{"description":"The amount formatted for display in its currency.","examples":["$3,000.00"]}]}},"required":["amount","currency","display"],"additionalProperties":false,"description":"The amount deducted from the worker's pay on this line in the amount's currency.","examples":[{"amount":10000,"currency":"USD","display":"$100.00"}]},"PublicPaycheckDeduction":{"type":"object","properties":{"taxTreatment":{"allOf":[{"$ref":"#/components/schemas/PublicPaycheckDeductionTaxTreatment"},{"description":"Whether this deduction is applied before or after taxes.","examples":["pre_tax"]}]},"amount":{"$ref":"#/components/schemas/PublicPayrollMoneyAmount_3"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"allOf":[{"description":"A description of the deduction, when available.","examples":["Pre-tax commuter deduction"]}]}},"required":["taxTreatment","amount","description"],"additionalProperties":false,"description":"One non-benefit deduction calculation line. Lines have no durable public identity.","examples":[{"taxTreatment":"pre_tax","amount":{"amount":10000,"currency":"USD","display":"$100.00"},"description":"Pre-tax commuter deduction"}]},"PublicPayrollMoneyAmount_4":{"type":"object","properties":{"amount":{"type":"integer","description":"minor units — cents, e.g. 2345 for $23.45","allOf":[{"minimum":0,"description":"The amount in ISO 4217 minor units. For USD, 300000 represents $3,000.00.","examples":[300000]}]},"currency":{"allOf":[{"$ref":"#/components/schemas/PublicPayrollCurrency"},{"description":"The ISO 4217 currency of this amount.","examples":["USD"]}]},"display":{"type":"string","description":"The server-formatted display string for the amount in its currency.","examples":["$150,000.00","$85.50"],"allOf":[{"description":"The amount formatted for display in its currency.","examples":["$3,000.00"]}]}},"required":["amount","currency","display"],"additionalProperties":false,"description":"The amount the worker pays toward this benefit on the paycheck in the amount's currency.","examples":[{"amount":20000,"currency":"USD","display":"$200.00"}]},"PublicPayrollMoneyAmount_5":{"type":"object","properties":{"amount":{"type":"integer","description":"minor units — cents, e.g. 2345 for $23.45","allOf":[{"minimum":0,"description":"The amount in ISO 4217 minor units. For USD, 300000 represents $3,000.00.","examples":[300000]}]},"currency":{"allOf":[{"$ref":"#/components/schemas/PublicPayrollCurrency"},{"description":"The ISO 4217 currency of this amount.","examples":["USD"]}]},"display":{"type":"string","description":"The server-formatted display string for the amount in its currency.","examples":["$150,000.00","$85.50"],"allOf":[{"description":"The amount formatted for display in its currency.","examples":["$3,000.00"]}]}},"required":["amount","currency","display"],"additionalProperties":false,"description":"The amount the employer pays toward this benefit on the paycheck in the amount's currency.","examples":[{"amount":15000,"currency":"USD","display":"$150.00"}]},"PublicPaycheckBenefit":{"type":"object","properties":{"name":{"type":"string","allOf":[{"description":"The benefit name shown on the paycheck.","examples":["Medical insurance"]}]},"benefitDeductionId":{"anyOf":[{"type":"string","pattern":"^pbdg_","description":"The version-group tag of a payroll benefit deduction. Stable across edits.","examples":["pbdg_1234"]},{"type":"null"}],"allOf":[{"description":"The ID of the associated benefit deduction, when available.","examples":["pbdg_1234"]}]},"category":{"anyOf":[{"type":"string","enum":["health","retirement","health_savings","commuter","voluntary","post_tax","other"]},{"type":"null"}],"allOf":[{"description":"The broad benefit category, when available.","examples":["health"]}]},"type":{"anyOf":[{"type":"string","enum":["medical","dental","vision","life","short_term_disability","long_term_disability","401k","roth_401k","403b","roth_403b","457","roth_457","hsa","fsa_medical","fsa_dependent_care","transit","parking","accident","cancer","critical_illness","hospital","medical_other","simple_ira","roth_simple_ira","nqdc","nontaxable_fringe","pucc","voluntary","post_tax","other"]},{"type":"null"}],"allOf":[{"description":"The specific benefit type, when available.","examples":["medical"]}]},"workerContribution":{"$ref":"#/components/schemas/PublicPayrollMoneyAmount_4"},"employerContribution":{"$ref":"#/components/schemas/PublicPayrollMoneyAmount_5"}},"required":["name","benefitDeductionId","category","type","workerContribution","employerContribution"],"additionalProperties":false,"description":"One benefit contribution calculation line. Lines have no durable public identity.","examples":[{"name":"Medical insurance","benefitDeductionId":"pbdg_1234","category":"health","type":"medical","workerContribution":{"amount":20000,"currency":"USD","display":"$200.00"},"employerContribution":{"amount":15000,"currency":"USD","display":"$150.00"}}]},"PublicTaxPayer":{"type":"string","enum":["worker","employer"],"description":"The party responsible for the tax.","examples":["worker"]},"PublicPayrollMoneyAmount_6":{"type":"object","properties":{"amount":{"type":"integer","description":"minor units — cents, e.g. 2345 for $23.45","allOf":[{"minimum":0,"description":"The amount in ISO 4217 minor units. For USD, 300000 represents $3,000.00.","examples":[300000]}]},"currency":{"allOf":[{"$ref":"#/components/schemas/PublicPayrollCurrency"},{"description":"The ISO 4217 currency of this amount.","examples":["USD"]}]},"display":{"type":"string","description":"The server-formatted display string for the amount in its currency.","examples":["$150,000.00","$85.50"],"allOf":[{"description":"The amount formatted for display in its currency.","examples":["$3,000.00"]}]}},"required":["amount","currency","display"],"additionalProperties":false,"description":"The tax amount attributed to the party identified by payer, expressed in the amount's currency.","examples":[{"amount":50000,"currency":"USD","display":"$500.00"}]},"PublicPaycheckTax":{"type":"object","properties":{"payer":{"allOf":[{"$ref":"#/components/schemas/PublicTaxPayer"},{"description":"The party responsible for this tax amount.","examples":["worker"]}]},"amount":{"$ref":"#/components/schemas/PublicPayrollMoneyAmount_6"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"allOf":[{"description":"A description of the tax, when available.","examples":["Federal income tax withholding"]}]}},"required":["payer","amount","description"],"additionalProperties":false,"description":"One tax calculation line. Lines have no durable public identity.","examples":[{"payer":"worker","amount":{"amount":50000,"currency":"USD","display":"$500.00"},"description":"Federal income tax withholding"}]},"PublicPaycheckDetail":{"type":"object","properties":{"id":{"type":"string","pattern":"^pyc_","description":"The tag of the paycheck.","examples":["pyc_1234"],"allOf":[{"description":"The paycheck ID.","examples":["pyc_1234"]}]},"payroll":{"allOf":[{"$ref":"#/components/schemas/PublicPaycheckPayroll"},{"description":"The payroll containing this paycheck.","examples":[{"id":"pay_1234","type":"us","subtype":"regular","status":"processing","fundingCurrency":"USD","payPeriod":{"startDate":"2026-08-16","endDate":"2026-08-31"},"payFrequency":"semimonthly"}]}]},"worker":{"allOf":[{"$ref":"#/components/schemas/PublicPaycheckWorker"},{"description":"The worker and classification associated with this paycheck.","examples":[{"id":"wrk_1234","firstName":"John","lastName":"Galt","displayName":"Jack Galt","workerType":"us_w2"}]}]},"status":{"allOf":[{"$ref":"#/components/schemas/PublicPaycheckStatus"},{"description":"The paycheck's current processing status.","examples":["processing"]}]},"payday":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","allOf":[{"description":"The date payment to the worker is scheduled.","examples":["2026-08-31"]}]},"paymentMethod":{"allOf":[{"$ref":"#/components/schemas/PublicPaycheckPaymentMethod"},{"description":"How this paycheck is intended to be delivered.","examples":["direct_deposit"]}]},"totals":{"allOf":[{"$ref":"#/components/schemas/PublicPaycheckDetailTotals"},{"description":"Category totals grouped by calculation currency and converted to payroll funding currency.","examples":[{"byCurrency":[{"currency":"USD","grossPay":{"amount":300000,"display":"$3,000.00"},"netPay":{"amount":230000,"display":"$2,300.00"},"reimbursements":{"amount":15000,"display":"$150.00"},"workerTaxes":{"amount":50000,"display":"$500.00"},"employerTaxes":{"amount":25000,"display":"$250.00"},"preTaxDeductions":{"amount":10000,"display":"$100.00"},"postTaxDeductions":{"amount":5000,"display":"$50.00"},"workerBenefitContributions":{"amount":20000,"display":"$200.00"},"employerBenefitContributions":{"amount":15000,"display":"$150.00"}}],"inFundingCurrency":{"currency":"USD","grossPay":{"amount":300000,"display":"$3,000.00"},"netPay":{"amount":230000,"display":"$2,300.00"},"reimbursements":{"amount":15000,"display":"$150.00"},"workerTaxes":{"amount":50000,"display":"$500.00"},"employerTaxes":{"amount":25000,"display":"$250.00"},"preTaxDeductions":{"amount":10000,"display":"$100.00"},"postTaxDeductions":{"amount":5000,"display":"$50.00"},"workerBenefitContributions":{"amount":20000,"display":"$200.00"},"employerBenefitContributions":{"amount":15000,"display":"$150.00"}}}]}]},"yearToDate":{"anyOf":[{"$ref":"#/components/schemas/PublicPaycheckYearToDate"},{"type":"null"}],"allOf":[{"description":"Included by default for available US W-2 paystubs. Null for draft, unsupported, unlinked, or missing paystubs. Provider failures fail the detail request. Existing top-level arrays remain current-paycheck calculation lines.","examples":[{"asOfDate":"2026-08-31","totals":{"grossPay":{"amount":2400000,"currency":"USD","display":"$24,000.00"},"netPay":{"amount":1880000,"currency":"USD","display":"$18,800.00"},"workerTaxes":{"amount":400000,"currency":"USD","display":"$4,000.00"},"workerBenefitContributions":{"amount":160000,"currency":"USD","display":"$1,600.00"},"reimbursements":{"amount":120000,"currency":"USD","display":"$1,200.00"},"postTaxDeductions":{"amount":80000,"currency":"USD","display":"$800.00"}},"earnings":[{"description":"Regular","amount":{"amount":2400000,"currency":"USD","display":"$24,000.00"}}],"taxes":[{"description":"Federal Income Tax","amount":{"amount":400000,"currency":"USD","display":"$4,000.00"}}],"benefits":[{"description":"Medical insurance","amount":{"amount":160000,"currency":"USD","display":"$1,600.00"}}],"reimbursements":[{"description":"Reimbursements","amount":{"amount":120000,"currency":"USD","display":"$1,200.00"}}],"deductions":[{"description":"Wage garnishment","amount":{"amount":80000,"currency":"USD","display":"$800.00"}}]}]}]},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"allOf":[{"description":"A description of the paycheck, when available.","examples":["Semimonthly pay for August 16–31, 2026"]}]},"exchangeRates":{"type":"array","items":{"$ref":"#/components/schemas/PublicExchangeRate"},"allOf":[{"description":"Direct exchange rates used to convert calculation currencies to the parent payroll funding currency. The list is empty when no currency conversion is required.","examples":[[{"fromCurrency":"EUR","toCurrency":"USD","rate":"1.083741"}]]}]},"reportedHours":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}],"allOf":[{"description":"The sum of hours explicitly reported on earning lines, or null when no earning line reports hours. Scheduled hours are never inferred.","examples":[60]}]},"earnings":{"type":"array","items":{"$ref":"#/components/schemas/PublicPaycheckEarning"},"allOf":[{"description":"Earnings included in the paycheck calculation.","examples":[[{"type":"hourly","workplaceId":"wkp_1234","amount":{"amount":300000,"currency":"USD","display":"$3,000.00"},"hours":60,"hourlyRate":{"amount":"50.00","currency":"USD","per":"hour"},"sourceRate":null,"description":"Regular hours"}]]}]},"reimbursements":{"type":"array","items":{"$ref":"#/components/schemas/PublicPaycheckReimbursement"},"allOf":[{"description":"Reimbursements included in the paycheck calculation.","examples":[[{"amount":{"amount":15000,"currency":"USD","display":"$150.00"},"description":"Client travel reimbursement"}]]}]},"deductions":{"type":"array","items":{"$ref":"#/components/schemas/PublicPaycheckDeduction"},"allOf":[{"description":"Non-benefit deductions included in the paycheck calculation.","examples":[[{"taxTreatment":"pre_tax","amount":{"amount":10000,"currency":"USD","display":"$100.00"},"description":"Pre-tax commuter deduction"},{"taxTreatment":"post_tax","amount":{"amount":5000,"currency":"USD","display":"$50.00"},"description":"Wage garnishment"}]]}]},"benefits":{"type":"array","items":{"$ref":"#/components/schemas/PublicPaycheckBenefit"},"allOf":[{"description":"Worker and employer benefit contributions included in the paycheck calculation.","examples":[[{"name":"Medical insurance","benefitDeductionId":"pbdg_1234","category":"health","type":"medical","workerContribution":{"amount":20000,"currency":"USD","display":"$200.00"},"employerContribution":{"amount":15000,"currency":"USD","display":"$150.00"}}]]}]},"taxes":{"type":"array","items":{"$ref":"#/components/schemas/PublicPaycheckTax"},"allOf":[{"description":"Worker and employer taxes included in the paycheck calculation.","examples":[[{"payer":"worker","amount":{"amount":50000,"currency":"USD","display":"$500.00"},"description":"Federal income tax withholding"},{"payer":"employer","amount":{"amount":25000,"currency":"USD","display":"$250.00"},"description":"Employer payroll tax"}]]}]}},"required":["id","payroll","worker","status","payday","paymentMethod","totals","yearToDate","description","exchangeRates","reportedHours","earnings","reimbursements","deductions","benefits","taxes"],"additionalProperties":false,"description":"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.","examples":[{"id":"pyc_1234","payroll":{"id":"pay_1234","type":"us","subtype":"regular","status":"processing","fundingCurrency":"USD","payPeriod":{"startDate":"2026-08-16","endDate":"2026-08-31"},"payFrequency":"semimonthly"},"worker":{"id":"wrk_1234","firstName":"John","lastName":"Galt","displayName":"Jack Galt","workerType":"us_w2"},"status":"processing","payday":"2026-08-31","paymentMethod":"direct_deposit","totals":{"byCurrency":[{"currency":"USD","grossPay":{"amount":300000,"display":"$3,000.00"},"netPay":{"amount":230000,"display":"$2,300.00"},"reimbursements":{"amount":15000,"display":"$150.00"},"workerTaxes":{"amount":50000,"display":"$500.00"},"employerTaxes":{"amount":25000,"display":"$250.00"},"preTaxDeductions":{"amount":10000,"display":"$100.00"},"postTaxDeductions":{"amount":5000,"display":"$50.00"},"workerBenefitContributions":{"amount":20000,"display":"$200.00"},"employerBenefitContributions":{"amount":15000,"display":"$150.00"}}],"inFundingCurrency":{"currency":"USD","grossPay":{"amount":300000,"display":"$3,000.00"},"netPay":{"amount":230000,"display":"$2,300.00"},"reimbursements":{"amount":15000,"display":"$150.00"},"workerTaxes":{"amount":50000,"display":"$500.00"},"employerTaxes":{"amount":25000,"display":"$250.00"},"preTaxDeductions":{"amount":10000,"display":"$100.00"},"postTaxDeductions":{"amount":5000,"display":"$50.00"},"workerBenefitContributions":{"amount":20000,"display":"$200.00"},"employerBenefitContributions":{"amount":15000,"display":"$150.00"}}},"description":"Semimonthly pay for August 16–31, 2026","exchangeRates":[],"reportedHours":60,"earnings":[{"type":"hourly","workplaceId":"wkp_1234","amount":{"amount":300000,"currency":"USD","display":"$3,000.00"},"hours":60,"hourlyRate":{"amount":"50.00","currency":"USD","per":"hour"},"sourceRate":null,"description":"Regular hours"}],"reimbursements":[{"amount":{"amount":15000,"currency":"USD","display":"$150.00"},"description":"Client travel reimbursement"}],"deductions":[{"taxTreatment":"pre_tax","amount":{"amount":10000,"currency":"USD","display":"$100.00"},"description":"Pre-tax commuter deduction"},{"taxTreatment":"post_tax","amount":{"amount":5000,"currency":"USD","display":"$50.00"},"description":"Wage garnishment"}],"benefits":[{"name":"Medical insurance","benefitDeductionId":"pbdg_1234","category":"health","type":"medical","workerContribution":{"amount":20000,"currency":"USD","display":"$200.00"},"employerContribution":{"amount":15000,"currency":"USD","display":"$150.00"}}],"taxes":[{"payer":"worker","amount":{"amount":50000,"currency":"USD","display":"$500.00"},"description":"Federal income tax withholding"},{"payer":"employer","amount":{"amount":25000,"currency":"USD","display":"$250.00"},"description":"Employer payroll tax"}],"yearToDate":{"asOfDate":"2026-08-31","totals":{"grossPay":{"amount":2400000,"currency":"USD","display":"$24,000.00"},"netPay":{"amount":1880000,"currency":"USD","display":"$18,800.00"},"workerTaxes":{"amount":400000,"currency":"USD","display":"$4,000.00"},"workerBenefitContributions":{"amount":160000,"currency":"USD","display":"$1,600.00"},"reimbursements":{"amount":120000,"currency":"USD","display":"$1,200.00"},"postTaxDeductions":{"amount":80000,"currency":"USD","display":"$800.00"}},"earnings":[{"description":"Regular","amount":{"amount":2400000,"currency":"USD","display":"$24,000.00"}}],"taxes":[{"description":"Federal Income Tax","amount":{"amount":400000,"currency":"USD","display":"$4,000.00"}}],"benefits":[{"description":"Medical insurance","amount":{"amount":160000,"currency":"USD","display":"$1,600.00"}}],"reimbursements":[{"description":"Reimbursements","amount":{"amount":120000,"currency":"USD","display":"$1,200.00"}}],"deductions":[{"description":"Wage garnishment","amount":{"amount":80000,"currency":"USD","display":"$800.00"}}]}}]},"PaycheckNotFoundErrorEncoded":{"type":"object","properties":{"_tag":{"type":"string","enum":["PaycheckNotFoundError"]},"id":{"type":"string","pattern":"^pyc_","description":"The tag of the paycheck.","examples":["pyc_1234"],"allOf":[{"description":"The requested paycheck ID.","examples":["pyc_1234"]}]},"message":{"type":"string","allOf":[{"description":"A human-readable explanation that the paycheck was not found.","examples":["Paycheck pyc_1234 was not found"]}]}},"required":["_tag","id","message"],"additionalProperties":false},"TimeOffPolicyNotFoundEncoded":{"type":"object","properties":{"_tag":{"type":"string","enum":["TimeOffPolicyNotFound"]},"id":{"anyOf":[{"type":"string","pattern":"^top_","examples":["top_1234"]},{"anyOf":[{"type":"number"},{"type":"string","enum":["Infinity","-Infinity","NaN"]}]}]},"message":{"type":"string"}},"required":["_tag","id","message"],"additionalProperties":false},"TimeOffRequestNotFoundErrorEncoded":{"type":"object","properties":{"_tag":{"type":"string","enum":["TimeOffRequestNotFoundError"]},"id":{"anyOf":[{"type":"string"},{"anyOf":[{"type":"number"},{"type":"string","enum":["Infinity","-Infinity","NaN"]}]}]},"message":{"type":"string"}},"required":["_tag","id","message"],"additionalProperties":false},"UpdateWorker":{"type":"object","properties":{"firstName":{"type":"string","pattern":"^\\S[\\s\\S]*\\S$|^\\S$|^$","minLength":1},"lastName":{"type":"string","pattern":"^\\S[\\s\\S]*\\S$|^\\S$|^$","minLength":1},"preferredName":{"anyOf":[{"type":"string","pattern":"^\\S[\\s\\S]*\\S$|^\\S$|^$"},{"type":"null"}]},"tShirtSize":{"anyOf":[{"type":"string","enum":["XS","S","M","L","XL","XXL","XXXL"]},{"type":"null"}],"allOf":[{"description":"The worker's T-shirt size. Null clears it; omission leaves it unchanged.","examples":["M",null]}]},"email":{"type":"string","format":"email","title":"Email","description":"An email with a reasonably valid regex (based on RFC 5321 atext characters)","examples":["john@joinwarp.com"],"allOf":[{"description":"Contact email. Changes are allowed only for draft or invited workers; this does not switch login accounts."}]},"workEmail":{"anyOf":[{"type":"string","format":"email","title":"Email","description":"An email with a reasonably valid regex (based on RFC 5321 atext characters)","examples":["john@joinwarp.com"]},{"type":"null"}],"allOf":[{"description":"Work email, independent of the login email. Null clears it."}]},"phone":{"type":"string","allOf":[{"description":"Also updates the linked account phone. A changed account number resets phone verification and SMS MFA."}]},"timeZone":{"type":"string","allOf":[{"description":"The worker's time zone as an IANA time zone identifier.","examples":["America/New_York"]}]},"dateOfBirth":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","allOf":[{"description":"The worker's date of birth.","examples":["1990-06-15"]}]},"maritalStatus":{"type":"string","enum":["married","not_married"]},"biologicalSex":{"type":"string","enum":["male","female"]},"address":{"type":"object","properties":{"line1":{"type":"string","minLength":1},"line2":{"anyOf":[{"type":"string"},{"type":"null"}]},"city":{"type":"string"},"state":{"type":"string"},"postalCode":{"type":"string"},"country":{"type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]}},"required":["line1","city","state","postalCode","country"],"additionalProperties":false,"allOf":[{"description":"Complete home address. Updating it alone preserves an office workplace and its work jurisdiction. For a remote W-2 worker, changing the address also replaces the remote workplace and updates the work jurisdiction. If the move opens a new state jurisdiction for the company, include workplaceId: null and stateRegistration in the same request."}]},"position":{"type":"string","pattern":"^\\S[\\s\\S]*\\S$|^\\S$|^$","minLength":1},"departmentId":{"anyOf":[{"type":"string","pattern":"^dpt_","description":"The unique public id of the department","examples":["dpt_1234"]},{"type":"null"}],"allOf":[{"description":"Department to assign. Null unassigns."}]},"managerId":{"anyOf":[{"type":"string","pattern":"^wrk_","description":"The id of the worker.","examples":["wrk_1234"]},{"type":"null"}],"allOf":[{"description":"Manager to assign. Null unassigns."}]},"levelId":{"anyOf":[{"type":"string","pattern":"^jlvl_","description":"The unique public id of the job level","examples":["jlvl_1234"]},{"type":"null"}],"allOf":[{"description":"Active job level to assign. Null unassigns. Requires job levels to be enabled."}]},"startDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","allOf":[{"description":"Hire date. Changing it reissues the applicable existing base pay rate at the new start date."}]},"workplaceId":{"anyOf":[{"type":"string","pattern":"^wkp_","description":"Public workplace identifier","examples":["wkp_1234"]},{"type":"null"}],"allOf":[{"description":"Primary workplace assignment for W-2 employees, returned as primaryWorkplace. Null assigns a remote workplace using the submitted or saved US home address."}]},"stateRegistration":{"type":"string","enum":["self_managed","warp_managed"],"allOf":[{"description":"How state tax registration is handled for the employee's work state. Only with workplaceId. Required when the move opens a new state: use 'self_managed' if you've already registered in this state, or 'warp_managed' for Warp to handle registration on your behalf. An existing state's filing owner remains unchanged."}]}},"additionalProperties":false},"WorkerNotFoundEncoded":{"type":"object","properties":{"_tag":{"type":"string","enum":["WorkerNotFound"]},"workerId":{"type":"string"},"message":{"type":"string"}},"required":["_tag","workerId","message"],"additionalProperties":false},"ManagerNotFoundEncoded":{"type":"object","properties":{"_tag":{"type":"string","enum":["ManagerNotFound"]},"id":{"type":"string","pattern":"^wrk_","description":"The id of the worker.","examples":["wrk_1234"]},"message":{"type":"string"}},"required":["_tag","id","message"],"additionalProperties":false},"InvalidInputEncoded":{"type":"object","properties":{"_tag":{"type":"string","enum":["InvalidInput"]},"message":{"type":"string"}},"required":["_tag","message"],"additionalProperties":false},"InvalidManagerEncoded":{"type":"object","properties":{"_tag":{"type":"string","enum":["InvalidManager"]},"id":{"type":"string","pattern":"^wrk_","description":"The id of the worker.","examples":["wrk_1234"]},"message":{"type":"string"}},"required":["_tag","id","message"],"additionalProperties":false},"AddressInvalidEncoded":{"type":"object","properties":{"_tag":{"type":"string","enum":["AddressInvalid"]},"suggestedAlternative":{"anyOf":[{"type":"object","properties":{"line1":{"type":"string","minLength":1},"line2":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"null"}]},{"type":"null"}]},"city":{"type":"string"},"state":{"type":"string"},"postalCode":{"type":"string"},"country":{"type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]}},"required":["line1","city","state","postalCode","country"],"additionalProperties":false},{"type":"null"}]},"message":{"type":"string"}},"required":["_tag","suggestedAlternative","message"],"additionalProperties":false},"SubscriptionLimitErrorEncoded":{"type":"object","properties":{"_tag":{"type":"string","enum":["SubscriptionLimitError"]},"message":{"type":"string"},"requiredFeatures":{"anyOf":[{"type":"object","properties":{"allowedUSStates":{"anyOf":[{"anyOf":[{"type":"number"},{"type":"string","enum":["Infinity","-Infinity","NaN"]}]},{"type":"null"}]},"hasGlobalPayrollAccess":{"anyOf":[{"type":"boolean"},{"type":"null"}]}},"additionalProperties":false},{"type":"null"}]}},"required":["_tag","message"],"additionalProperties":false},"EmailChangeRequiresAuthSwitchEncoded":{"type":"object","properties":{"_tag":{"type":"string","enum":["EmailChangeRequiresAuthSwitch"]},"message":{"type":"string"}},"required":["_tag","message"],"additionalProperties":false},"WorkerAlreadyExistsErrorEncoded":{"type":"object","properties":{"_tag":{"type":"string","enum":["WorkerAlreadyExistsError"]},"message":{"type":"string"}},"required":["_tag","message"],"additionalProperties":false},"WorkerNotActiveEncoded":{"type":"object","properties":{"_tag":{"type":"string","enum":["WorkerNotActive"]},"id":{"type":"string","pattern":"^wrk_","description":"The id of the worker.","examples":["wrk_1234"]},"status":{"type":"string","enum":["draft","invited","onboarding","active","offboarding","inactive"]},"message":{"type":"string"}},"required":["_tag","id","status","message"],"additionalProperties":false},"WorkerNotOffboardedEncoded":{"type":"object","properties":{"_tag":{"type":"string","enum":["WorkerNotOffboarded"]},"id":{"type":"string","pattern":"^wrk_","description":"The id of the worker.","examples":["wrk_1234"]},"status":{"type":"string","enum":["draft","invited","onboarding","active","offboarding","inactive"]},"message":{"type":"string"}},"required":["_tag","id","status","message"],"additionalProperties":false},"WorkerHomeAddressRequiredEncoded":{"type":"object","properties":{"_tag":{"type":"string","enum":["WorkerHomeAddressRequired"]},"message":{"type":"string"}},"required":["_tag","message"],"additionalProperties":false},"PayrollSetupIncompleteEncoded":{"type":"object","properties":{"_tag":{"type":"string","enum":["PayrollSetupIncomplete"]},"message":{"type":"string"}},"required":["_tag","message"],"additionalProperties":false},"WorkplaceAlreadyExistsEncoded":{"type":"object","properties":{"_tag":{"type":"string","enum":["WorkplaceAlreadyExists"]},"id":{"anyOf":[{"type":"string","pattern":"^wkp_","description":"Public workplace identifier","examples":["wkp_1234"]},{"type":"null"}]},"name":{"type":"string"},"message":{"type":"string"}},"required":["_tag","name","message"],"additionalProperties":false},"WorkerUpdateConflictEncoded":{"type":"object","properties":{"_tag":{"type":"string","enum":["WorkerUpdateConflict"]},"workerId":{"type":"string","pattern":"^wrk_","description":"The id of the worker.","examples":["wrk_1234"]},"message":{"type":"string"}},"required":["_tag","workerId","message"],"additionalProperties":false},"PublicWorkerSsn":{"type":"object","properties":{"id":{"type":"string","pattern":"^wrk_","description":"The id of the worker.","examples":["wrk_1234"],"allOf":[{"description":"The worker ID supplied in the request.","examples":["wrk_khac8380c2Lm"]}]},"ssn":{"anyOf":[{"type":"string","allOf":[{"minLength":9},{"maxLength":9}],"pattern":"^\\d+$"},{"type":"null"}],"description":"The nine-digit Social Security number, or null when the worker has no SSN on file.","examples":["000123456",null]}},"required":["id","ssn"],"additionalProperties":false,"description":"A worker's decrypted Social Security number.","examples":[{"id":"wrk_khac8380c2Lm","ssn":"000123456"},{"id":"wrk_q7Vm2pR9xK4c","ssn":null}]},"OfficeWorkLocation":{"type":"object","properties":{"type":{"type":"string","enum":["office"]},"workplaceId":{"type":"string","pattern":"^wkp_","description":"Public workplace identifier","examples":["wkp_1234"]}},"required":["type","workplaceId"],"additionalProperties":false,"description":"Employee works from a company workplace."},"RemoteWorkLocation":{"type":"object","properties":{"type":{"type":"string","enum":["remote"]},"state":{"type":"string","enum":["AL","AK","AZ","AR","CA","CO","CT","DC","DE","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY"],"description":"The US state where the remote employee works. Required for tax purposes."}},"required":["type","state"],"additionalProperties":false,"description":"Employee works remotely from a US state."},"PayScheduleNotConfiguredEncoded":{"type":"object","properties":{"_tag":{"type":"string","enum":["PayScheduleNotConfigured"]},"paySchedule":{"type":"string","enum":["weekly","biweekly","monthly","semimonthly","quarterly","annually"]},"message":{"type":"string"}},"required":["_tag","paySchedule","message"],"additionalProperties":false},"StateRegistrationRequiredEncoded":{"type":"object","properties":{"_tag":{"type":"string","enum":["StateRegistrationRequired"]},"state":{"type":"string"},"message":{"type":"string"}},"required":["_tag","state","message"],"additionalProperties":false},"PublicPayRatePer_1":{"type":"string","enum":["year","month","week","hour"],"description":"The pay period for the compensation amount."},"InvalidWorkerStatusErrorEncoded":{"type":"object","properties":{"_tag":{"type":"string","enum":["InvalidWorkerStatusError"]},"id":{"type":"string","pattern":"^wrk_","description":"The id of the worker.","examples":["wrk_1234"]},"message":{"type":"string"}},"required":["_tag","id","message"],"additionalProperties":false},"CannotDeleteWorkerEncoded":{"type":"object","properties":{"_tag":{"type":"string","enum":["CannotDeleteWorker"]},"id":{"type":"string","pattern":"^wrk_","description":"The id of the worker.","examples":["wrk_1234"]},"message":{"type":"string"}},"required":["_tag","id","message"],"additionalProperties":false}},"securitySchemes":{"apiKey":{"type":"apiKey","name":"x-api-key","in":"header"}}},"security":[{"apiKey":[]}],"tags":[{"name":"Benefits","description":"Health plan reads and retirement plan and payroll benefit deduction management."},{"name":"Company","description":"Read basic information about the company associated with your API key."},{"name":"Custom Fields","description":"Company-defined custom fields for workers. Field definitions are administered with the workers:custom_fields permission; each field belongs to a worker-data category whose read/write grants govern its values."},{"name":"Departments","description":"Endpoints for department management. Create, list, and update departments within your company."},{"name":"I-9 Verifications","description":"Read company I-9 verification metadata, including retained forms, without exposing form contents."},{"name":"Bank Accounts","description":"Read masked worker bank account metadata. No banking instructions or account changes are supported."},{"name":"Levels","description":"Endpoints for reading the job-level framework configured for your company."},{"name":"Offers","description":"Endpoints for managing candidate offers. Create and send offers, list existing offers, and manage their lifecycle."},{"name":"Pay Rates","description":"Read worker pay rates and create or delete effective-dated regular pay rates. No public pay-rate update operation is exposed."},{"name":"Pay Splits","description":"Read stored pay-split configurations without changing banking instructions or guaranteeing payroll execution."},{"name":"Payroll","description":"Read-only payrolls and worker-level payroll calculations. Paycheck endpoints use one consistent resource for every worker type; payment execution is outside this API."},{"name":"Time Off","description":"Endpoints for worker time off management. See time off requests, which workers are assigned to which policies, or worker remaining balances."},{"name":"Workers","description":"Endpoints for worker management. \"Workers\" include anyone employed by your company, whether US or international, full-time employees or contractors."},{"name":"Workplaces","description":"Endpoints for workplace management. Create, list, and update workplaces within your company."}],"servers":[{"url":"https://api.joinwarp.com","description":"Production"}],"webhooks":{"time_off.request.created":{"post":{"tags":["Time Off"],"summary":"Time Off Request Created","description":"Sent when a worker submits a new time off request.","parameters":[{"name":"webhook-id","in":"header","required":true,"description":"Unique identifier for this message. Stable across retries and manual resends — use it as your idempotency key.","schema":{"type":"string","examples":["tor_abc123:550e8400-e29b-41d4-a716-446655440000"]}},{"name":"webhook-timestamp","in":"header","required":true,"description":"Unix timestamp in seconds for this delivery attempt. Recomputed on every attempt — reject deliveries whose timestamp is outside your tolerance window to guard against replay.","schema":{"type":"string","examples":["1752580800"]}},{"name":"webhook-signature","in":"header","required":true,"description":"Space-separated list of signatures over `{webhook-id}.{webhook-timestamp}.{body}`, each formatted `v1,<base64>` where `v1` is HMAC-SHA256 with your signing secret. During a secret rotation the list carries one signature per live secret; a match on any one is valid.","schema":{"type":"string","examples":["v1,g0hM9SsE+OTPJTGt/tmIKtSyZlE3uFJELVlNIOLJ1OE="]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Unique event identifier (format: `<objectTag>:<uuid>`). Stable across retries.","examples":["tor_abc123:550e8400-e29b-41d4-a716-446655440000"]},"type":{"type":"string","enum":["time_off.request.created"],"description":"The event type."},"timestamp":{"type":"string","description":"ISO 8601 timestamp of when the event occurred. Unchanged across retries.","examples":["2026-07-15T12:00:00.000Z"]},"data":{"type":"object","properties":{"id":{"type":"string"},"timeOffPolicyId":{"type":"string","pattern":"^top_","examples":["top_1234"]},"workerId":{"type":"string","pattern":"^wrk_","description":"The id of the worker.","examples":["wrk_1234"]},"status":{"type":"string","enum":["pending","approved","denied"]},"startAt":{"type":"string"},"startRangeType":{"type":"string","enum":["date","datetime"]},"endAt":{"type":"string"},"endRangeType":{"type":"string","enum":["date","datetime"]},"reason":{"anyOf":[{"type":"string"},{"type":"null"}]},"createdAt":{"type":"string"},"requestedMinutes":{"anyOf":[{"type":"number"},{"type":"string","enum":["Infinity","-Infinity","NaN"]}]},"timeZone":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The time zone that the worker is requesting time off in.","examples":["America/New_York"]}},"required":["id","timeOffPolicyId","workerId","status","startAt","startRangeType","endAt","endRangeType","reason","createdAt","requestedMinutes","timeZone"],"additionalProperties":false}},"required":["id","type","timestamp","data"],"additionalProperties":false}}}},"responses":{"200":{"description":"Return any 2xx status code to acknowledge receipt. Non-2xx responses or timeouts are retried with exponential backoff."}}}},"time_off.request.reviewed":{"post":{"tags":["Time Off"],"summary":"Time Off Request Reviewed","description":"Sent when a time off request is approved or denied.","parameters":[{"name":"webhook-id","in":"header","required":true,"description":"Unique identifier for this message. Stable across retries and manual resends — use it as your idempotency key.","schema":{"type":"string","examples":["tor_abc123:550e8400-e29b-41d4-a716-446655440000"]}},{"name":"webhook-timestamp","in":"header","required":true,"description":"Unix timestamp in seconds for this delivery attempt. Recomputed on every attempt — reject deliveries whose timestamp is outside your tolerance window to guard against replay.","schema":{"type":"string","examples":["1752580800"]}},{"name":"webhook-signature","in":"header","required":true,"description":"Space-separated list of signatures over `{webhook-id}.{webhook-timestamp}.{body}`, each formatted `v1,<base64>` where `v1` is HMAC-SHA256 with your signing secret. During a secret rotation the list carries one signature per live secret; a match on any one is valid.","schema":{"type":"string","examples":["v1,g0hM9SsE+OTPJTGt/tmIKtSyZlE3uFJELVlNIOLJ1OE="]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Unique event identifier (format: `<objectTag>:<uuid>`). Stable across retries.","examples":["tor_abc123:550e8400-e29b-41d4-a716-446655440000"]},"type":{"type":"string","enum":["time_off.request.reviewed"],"description":"The event type."},"timestamp":{"type":"string","description":"ISO 8601 timestamp of when the event occurred. Unchanged across retries.","examples":["2026-07-15T12:00:00.000Z"]},"data":{"type":"object","properties":{"id":{"type":"string"},"timeOffPolicyId":{"type":"string","pattern":"^top_","examples":["top_1234"]},"workerId":{"type":"string","pattern":"^wrk_","description":"The id of the worker.","examples":["wrk_1234"]},"status":{"type":"string","enum":["pending","approved","denied"]},"startAt":{"type":"string"},"startRangeType":{"type":"string","enum":["date","datetime"]},"endAt":{"type":"string"},"endRangeType":{"type":"string","enum":["date","datetime"]},"reason":{"anyOf":[{"type":"string"},{"type":"null"}]},"createdAt":{"type":"string"},"requestedMinutes":{"anyOf":[{"type":"number"},{"type":"string","enum":["Infinity","-Infinity","NaN"]}]},"timeZone":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The time zone that the worker is requesting time off in.","examples":["America/New_York"]}},"required":["id","timeOffPolicyId","workerId","status","startAt","startRangeType","endAt","endRangeType","reason","createdAt","requestedMinutes","timeZone"],"additionalProperties":false}},"required":["id","type","timestamp","data"],"additionalProperties":false}}}},"responses":{"200":{"description":"Return any 2xx status code to acknowledge receipt. Non-2xx responses or timeouts are retried with exponential backoff."}}}},"time_off.request.deleted":{"post":{"tags":["Time Off"],"summary":"Time Off Request Deleted","description":"Sent when a time off request is deleted. Carries a snapshot of the request as it existed before deletion.","parameters":[{"name":"webhook-id","in":"header","required":true,"description":"Unique identifier for this message. Stable across retries and manual resends — use it as your idempotency key.","schema":{"type":"string","examples":["tor_abc123:550e8400-e29b-41d4-a716-446655440000"]}},{"name":"webhook-timestamp","in":"header","required":true,"description":"Unix timestamp in seconds for this delivery attempt. Recomputed on every attempt — reject deliveries whose timestamp is outside your tolerance window to guard against replay.","schema":{"type":"string","examples":["1752580800"]}},{"name":"webhook-signature","in":"header","required":true,"description":"Space-separated list of signatures over `{webhook-id}.{webhook-timestamp}.{body}`, each formatted `v1,<base64>` where `v1` is HMAC-SHA256 with your signing secret. During a secret rotation the list carries one signature per live secret; a match on any one is valid.","schema":{"type":"string","examples":["v1,g0hM9SsE+OTPJTGt/tmIKtSyZlE3uFJELVlNIOLJ1OE="]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Unique event identifier (format: `<objectTag>:<uuid>`). Stable across retries.","examples":["tor_abc123:550e8400-e29b-41d4-a716-446655440000"]},"type":{"type":"string","enum":["time_off.request.deleted"],"description":"The event type."},"timestamp":{"type":"string","description":"ISO 8601 timestamp of when the event occurred. Unchanged across retries.","examples":["2026-07-15T12:00:00.000Z"]},"data":{"type":"object","properties":{"id":{"type":"string"},"timeOffPolicyId":{"type":"string","pattern":"^top_","examples":["top_1234"]},"workerId":{"type":"string","pattern":"^wrk_","description":"The id of the worker.","examples":["wrk_1234"]},"status":{"type":"string","enum":["pending","approved","denied"]},"startAt":{"type":"string"},"startRangeType":{"type":"string","enum":["date","datetime"]},"endAt":{"type":"string"},"endRangeType":{"type":"string","enum":["date","datetime"]},"reason":{"anyOf":[{"type":"string"},{"type":"null"}]},"createdAt":{"type":"string"},"requestedMinutes":{"anyOf":[{"type":"number"},{"type":"string","enum":["Infinity","-Infinity","NaN"]}]},"timeZone":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The time zone that the worker is requesting time off in.","examples":["America/New_York"]}},"required":["id","timeOffPolicyId","workerId","status","startAt","startRangeType","endAt","endRangeType","reason","createdAt","requestedMinutes","timeZone"],"additionalProperties":false}},"required":["id","type","timestamp","data"],"additionalProperties":false}}}},"responses":{"200":{"description":"Return any 2xx status code to acknowledge receipt. Non-2xx responses or timeouts are retried with exponential backoff."}}}},"time_off.balance.adjusted":{"post":{"tags":["Time Off"],"summary":"Time Off Balance Adjusted","description":"Sent when a worker's time off balance is adjusted.","parameters":[{"name":"webhook-id","in":"header","required":true,"description":"Unique identifier for this message. Stable across retries and manual resends — use it as your idempotency key.","schema":{"type":"string","examples":["tor_abc123:550e8400-e29b-41d4-a716-446655440000"]}},{"name":"webhook-timestamp","in":"header","required":true,"description":"Unix timestamp in seconds for this delivery attempt. Recomputed on every attempt — reject deliveries whose timestamp is outside your tolerance window to guard against replay.","schema":{"type":"string","examples":["1752580800"]}},{"name":"webhook-signature","in":"header","required":true,"description":"Space-separated list of signatures over `{webhook-id}.{webhook-timestamp}.{body}`, each formatted `v1,<base64>` where `v1` is HMAC-SHA256 with your signing secret. During a secret rotation the list carries one signature per live secret; a match on any one is valid.","schema":{"type":"string","examples":["v1,g0hM9SsE+OTPJTGt/tmIKtSyZlE3uFJELVlNIOLJ1OE="]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Unique event identifier (format: `<objectTag>:<uuid>`). Stable across retries.","examples":["tor_abc123:550e8400-e29b-41d4-a716-446655440000"]},"type":{"type":"string","enum":["time_off.balance.adjusted"],"description":"The event type."},"timestamp":{"type":"string","description":"ISO 8601 timestamp of when the event occurred. Unchanged across retries.","examples":["2026-07-15T12:00:00.000Z"]},"data":{"type":"object","properties":{"workerId":{"type":"string","pattern":"^wrk_","description":"The id of the worker.","examples":["wrk_1234"]},"policyId":{"type":"string","pattern":"^top_","examples":["top_1234"]},"adjustmentMinutes":{"anyOf":[{"anyOf":[{"type":"number"},{"type":"string","enum":["Infinity","-Infinity","NaN"]}]},{"type":"null"}],"description":"Signed adjustment applied to the balance, in minutes. Omitted when no balance snapshot was captured.","examples":[480]},"effectiveDate":{"anyOf":[{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},{"type":"null"}],"description":"The date the adjustment takes effect. Omitted when no balance snapshot was captured."},"previousBalance":{"anyOf":[{"type":"object","properties":{"accruedUnlocked":{"anyOf":[{"type":"number"},{"type":"string","enum":["Infinity","-Infinity","NaN"]}]},"accruedLocked":{"anyOf":[{"type":"number"},{"type":"string","enum":["Infinity","-Infinity","NaN"]}]},"used":{"anyOf":[{"type":"number"},{"type":"string","enum":["Infinity","-Infinity","NaN"]}]},"holds":{"anyOf":[{"type":"number"},{"type":"string","enum":["Infinity","-Infinity","NaN"]}]},"available":{"anyOf":[{"type":"number"},{"type":"string","enum":["Infinity","-Infinity","NaN"]}]}},"required":["accruedUnlocked","accruedLocked","used","holds","available"],"additionalProperties":false},{"type":"null"}]},"newBalance":{"anyOf":[{"type":"object","properties":{"accruedUnlocked":{"anyOf":[{"type":"number"},{"type":"string","enum":["Infinity","-Infinity","NaN"]}]},"accruedLocked":{"anyOf":[{"type":"number"},{"type":"string","enum":["Infinity","-Infinity","NaN"]}]},"used":{"anyOf":[{"type":"number"},{"type":"string","enum":["Infinity","-Infinity","NaN"]}]},"holds":{"anyOf":[{"type":"number"},{"type":"string","enum":["Infinity","-Infinity","NaN"]}]},"available":{"anyOf":[{"type":"number"},{"type":"string","enum":["Infinity","-Infinity","NaN"]}]}},"required":["accruedUnlocked","accruedLocked","used","holds","available"],"additionalProperties":false},{"type":"null"}]}},"required":["workerId","policyId"],"allOf":[{"type":"object","additionalProperties":{}}]}},"required":["id","type","timestamp","data"],"additionalProperties":false}}}},"responses":{"200":{"description":"Return any 2xx status code to acknowledge receipt. Non-2xx responses or timeouts are retried with exponential backoff."}}}},"worker.created":{"post":{"tags":["Workers"],"summary":"Worker Created","description":"Sent when a new worker is created.","parameters":[{"name":"webhook-id","in":"header","required":true,"description":"Unique identifier for this message. Stable across retries and manual resends — use it as your idempotency key.","schema":{"type":"string","examples":["tor_abc123:550e8400-e29b-41d4-a716-446655440000"]}},{"name":"webhook-timestamp","in":"header","required":true,"description":"Unix timestamp in seconds for this delivery attempt. Recomputed on every attempt — reject deliveries whose timestamp is outside your tolerance window to guard against replay.","schema":{"type":"string","examples":["1752580800"]}},{"name":"webhook-signature","in":"header","required":true,"description":"Space-separated list of signatures over `{webhook-id}.{webhook-timestamp}.{body}`, each formatted `v1,<base64>` where `v1` is HMAC-SHA256 with your signing secret. During a secret rotation the list carries one signature per live secret; a match on any one is valid.","schema":{"type":"string","examples":["v1,g0hM9SsE+OTPJTGt/tmIKtSyZlE3uFJELVlNIOLJ1OE="]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Unique event identifier (format: `<objectTag>:<uuid>`). Stable across retries.","examples":["tor_abc123:550e8400-e29b-41d4-a716-446655440000"]},"type":{"type":"string","enum":["worker.created"],"description":"The event type."},"timestamp":{"type":"string","description":"ISO 8601 timestamp of when the event occurred. Unchanged across retries.","examples":["2026-07-15T12:00:00.000Z"]},"data":{"type":"object","properties":{"id":{"type":"string","pattern":"^wrk_","description":"The id of the worker.","examples":["wrk_1234"]},"position":{"type":"string","examples":["Research Engineer"]},"type":{"type":"string","enum":["employee","contractor"]},"status":{"type":"string","enum":["draft","invited","onboarding","active","offboarding","inactive"]},"benefitEligible":{"type":"boolean","allOf":[{"description":"The worker's stored benefits eligibility flag.","examples":[true,false]}]},"startDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","allOf":[{"description":"The worker's employment start date. Reactivation after an offboarding is reported separately in latestRehireDate.","examples":["2022-04-11"]}]},"endDate":{"anyOf":[{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},{"type":"null"}],"allOf":[{"description":"The worker's final day of employment, or null when employment is ongoing.","examples":["2026-08-15",null]}]},"isBusiness":{"anyOf":[{"type":"boolean"},{"type":"null"}],"examples":[false]},"businessName":{"anyOf":[{"type":"string"},{"type":"null"}],"examples":[null,"Galt Enterprises, LLC"]},"firstName":{"type":"string","examples":["Jonathan","Melissa"]},"lastName":{"type":"string","examples":["Galt","Jones"]},"email":{"type":"string","format":"email","title":"Email","description":"An email with a reasonably valid regex (based on RFC 5321 atext characters)","examples":["john@joinwarp.com"]},"workEmail":{"anyOf":[{"type":"string","format":"email","title":"Email","description":"An email with a reasonably valid regex (based on RFC 5321 atext characters)","examples":["john@joinwarp.com"]},{"type":"null"}]},"preferredName":{"anyOf":[{"type":"string","examples":["John"]},{"type":"null"}]},"biologicalSex":{"anyOf":[{"type":"string","enum":["male","female"]},{"type":"null"}],"description":"The worker's biological sex, or null when unavailable.","examples":["female"]},"maritalStatus":{"anyOf":[{"type":"string","enum":["married","not_married"]},{"type":"null"}],"description":"The worker's marital status, or null when unavailable.","examples":["married"]},"dateOfBirth":{"anyOf":[{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},{"type":"null"}],"description":"The worker's date of birth, or null when unavailable.","examples":["1990-06-15"]},"phone":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The worker's personal phone number, or null when unavailable.","examples":["+12025550143"]},"address":{"anyOf":[{"$ref":"#/components/schemas/PublicWorkerAddress"},{"type":"null"}],"description":"The worker's home address, or null when unavailable.","examples":[{"line1":"123 Example Street","line2":"Suite 400","city":"New York","state":"NY","postalCode":"10001","country":"US"}]},"displayName":{"type":"string","description":"The \"ui\" name of a worker. If it's a business contractor business name is used. Otherwise we default to preferred name, then first-last.","examples":["Jack Galt"]},"manager":{"anyOf":[{"$ref":"#/components/schemas/PublicWorkerManager"},{"type":"null"}],"description":"The worker's manager, or null if unassigned.","examples":[{"id":"wrk_3Fna7qP2mL8z","firstName":"Hank","lastName":"Rearden","displayName":"Hank Rearden"},null]},"timeZone":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The IANA timezone of the worker (e.g., America/New_York).","examples":["America/New_York"]},"tShirtSize":{"anyOf":[{"type":"string","enum":["XS","S","M","L","XL","XXL","XXXL"]},{"type":"null"}],"description":"The worker's stored T-shirt size, or null when unset or unavailable.","examples":["M",null]},"department":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","pattern":"^dpt_","description":"The unique public id of the department","examples":["dpt_1234"]},"name":{"type":"string"}},"required":["id","name"],"additionalProperties":false},{"type":"null"}],"description":"The department the worker belongs to, or null if unassigned.","examples":[{"id":"dpt_7Rqa2mP9xK4c","name":"Engineering"},null]},"primaryWorkplace":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","pattern":"^wkp_","description":"Public workplace identifier","examples":["wkp_1234"]},"name":{"type":"string"},"type":{"type":"string","enum":["remote","office"]}},"required":["id","name","type"],"additionalProperties":false},{"type":"null"}],"description":"The primary workplace the worker is assigned to, or null if unassigned.","examples":[{"id":"wkp_4Nva8qT2mL7z","name":"New York Office","type":"office"},null]},"latestRehireDate":{"anyOf":[{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},{"type":"null"}],"description":"The date the worker was most recently reactivated after an offboarding. This is distinct from startDate and is null if the worker has not been rehired.","examples":["2024-02-05",null]},"terminationReason":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The reason the worker was terminated, or null when no termination reason is recorded.","examples":["Position eliminated",null]},"updatedAt":{"type":"string","examples":["2026-08-20T14:30:00.000Z"]},"level":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","pattern":"^jlvl_","description":"The unique public id of the job level","examples":["jlvl_1234"]},"code":{"type":"string"},"name":{"type":"string"},"track":{"type":"string","enum":["ic","manager","executive"]}},"required":["id","code","name","track"],"additionalProperties":false},{"type":"null"}],"description":"The worker's assigned job level, or null if unassigned. Omitted when job levels are not enabled."},"compensation":{"anyOf":[{"$ref":"#/components/schemas/PublicWorkerCompensation"},{"type":"null"}],"description":"The worker's current regular compensation, or the rate effective on a future start date. Null when the worker has no applicable regular pay rate or the API key lacks the corresponding compensation read scope.","examples":[{"payRateId":"pyr_9Cka3pR8vM2x","per":"year","amount":15000000,"currency":"USD","display":"$150,000.00 / yr"},null]},"customFields":{"anyOf":[{"type":"array","items":{"$ref":"#/components/schemas/PublicWorkerCustomField"},"description":"The worker's custom field values. Every active company custom field appears; fields outside this API key's permission scopes are redacted (value null, redacted true) rather than omitted, so the list is identical across keys. Empty when the company has no custom fields.","examples":[[]]},{"type":"null"}]}},"required":["id","position","type","status","benefitEligible","startDate","endDate","isBusiness","businessName","firstName","lastName","email","workEmail","preferredName","biologicalSex","maritalStatus","dateOfBirth","phone","address","displayName","timeZone","department","primaryWorkplace","latestRehireDate","terminationReason","updatedAt","compensation"],"additionalProperties":false,"description":"A worker profile, including lifecycle, workplace, profile, and compensation fields.","examples":[{"id":"wrk_khac8380c2Lm","position":"Research Engineer","type":"employee","status":"active","benefitEligible":true,"startDate":"2022-04-11","endDate":null,"isBusiness":null,"businessName":null,"firstName":"Jane","lastName":"Doe","email":"jane.doe@example.com","workEmail":"jane.doe@acme.example","preferredName":"Jane","biologicalSex":"female","maritalStatus":"married","dateOfBirth":"1990-06-15","phone":"+12025550143","address":{"line1":"123 Example Street","line2":"Suite 400","city":"New York","state":"NY","postalCode":"10001","country":"US"},"displayName":"Jane Doe","manager":{"id":"wrk_3Fna7qP2mL8z","firstName":"Hank","lastName":"Rearden","displayName":"Hank Rearden"},"timeZone":"America/New_York","tShirtSize":"M","department":{"id":"dpt_7Rqa2mP9xK4c","name":"Engineering"},"primaryWorkplace":{"id":"wkp_4Nva8qT2mL7z","name":"New York Office","type":"office"},"latestRehireDate":"2024-02-05","terminationReason":null,"updatedAt":"2026-08-20T14:30:00.000Z","compensation":{"payRateId":"pyr_9Cka3pR8vM2x","per":"year","amount":15000000,"currency":"USD","display":"$150,000.00 / yr"},"customFields":[]}]}},"required":["id","type","timestamp","data"],"additionalProperties":false}}}},"responses":{"200":{"description":"Return any 2xx status code to acknowledge receipt. Non-2xx responses or timeouts are retried with exponential backoff."}}}},"worker.updated":{"post":{"tags":["Workers"],"summary":"Worker Updated","description":"Sent when a worker's details change.","parameters":[{"name":"webhook-id","in":"header","required":true,"description":"Unique identifier for this message. Stable across retries and manual resends — use it as your idempotency key.","schema":{"type":"string","examples":["tor_abc123:550e8400-e29b-41d4-a716-446655440000"]}},{"name":"webhook-timestamp","in":"header","required":true,"description":"Unix timestamp in seconds for this delivery attempt. Recomputed on every attempt — reject deliveries whose timestamp is outside your tolerance window to guard against replay.","schema":{"type":"string","examples":["1752580800"]}},{"name":"webhook-signature","in":"header","required":true,"description":"Space-separated list of signatures over `{webhook-id}.{webhook-timestamp}.{body}`, each formatted `v1,<base64>` where `v1` is HMAC-SHA256 with your signing secret. During a secret rotation the list carries one signature per live secret; a match on any one is valid.","schema":{"type":"string","examples":["v1,g0hM9SsE+OTPJTGt/tmIKtSyZlE3uFJELVlNIOLJ1OE="]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Unique event identifier (format: `<objectTag>:<uuid>`). Stable across retries.","examples":["tor_abc123:550e8400-e29b-41d4-a716-446655440000"]},"type":{"type":"string","enum":["worker.updated"],"description":"The event type."},"timestamp":{"type":"string","description":"ISO 8601 timestamp of when the event occurred. Unchanged across retries.","examples":["2026-07-15T12:00:00.000Z"]},"data":{"type":"object","properties":{"id":{"type":"string","pattern":"^wrk_","description":"The id of the worker.","examples":["wrk_1234"]},"position":{"type":"string","examples":["Research Engineer"]},"type":{"type":"string","enum":["employee","contractor"]},"status":{"type":"string","enum":["draft","invited","onboarding","active","offboarding","inactive"]},"benefitEligible":{"type":"boolean","allOf":[{"description":"The worker's stored benefits eligibility flag.","examples":[true,false]}]},"startDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","allOf":[{"description":"The worker's employment start date. Reactivation after an offboarding is reported separately in latestRehireDate.","examples":["2022-04-11"]}]},"endDate":{"anyOf":[{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},{"type":"null"}],"allOf":[{"description":"The worker's final day of employment, or null when employment is ongoing.","examples":["2026-08-15",null]}]},"isBusiness":{"anyOf":[{"type":"boolean"},{"type":"null"}],"examples":[false]},"businessName":{"anyOf":[{"type":"string"},{"type":"null"}],"examples":[null,"Galt Enterprises, LLC"]},"firstName":{"type":"string","examples":["Jonathan","Melissa"]},"lastName":{"type":"string","examples":["Galt","Jones"]},"email":{"type":"string","format":"email","title":"Email","description":"An email with a reasonably valid regex (based on RFC 5321 atext characters)","examples":["john@joinwarp.com"]},"workEmail":{"anyOf":[{"type":"string","format":"email","title":"Email","description":"An email with a reasonably valid regex (based on RFC 5321 atext characters)","examples":["john@joinwarp.com"]},{"type":"null"}]},"preferredName":{"anyOf":[{"type":"string","examples":["John"]},{"type":"null"}]},"biologicalSex":{"anyOf":[{"type":"string","enum":["male","female"]},{"type":"null"}],"description":"The worker's biological sex, or null when unavailable.","examples":["female"]},"maritalStatus":{"anyOf":[{"type":"string","enum":["married","not_married"]},{"type":"null"}],"description":"The worker's marital status, or null when unavailable.","examples":["married"]},"dateOfBirth":{"anyOf":[{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},{"type":"null"}],"description":"The worker's date of birth, or null when unavailable.","examples":["1990-06-15"]},"phone":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The worker's personal phone number, or null when unavailable.","examples":["+12025550143"]},"address":{"anyOf":[{"$ref":"#/components/schemas/PublicWorkerAddress"},{"type":"null"}],"description":"The worker's home address, or null when unavailable.","examples":[{"line1":"123 Example Street","line2":"Suite 400","city":"New York","state":"NY","postalCode":"10001","country":"US"}]},"displayName":{"type":"string","description":"The \"ui\" name of a worker. If it's a business contractor business name is used. Otherwise we default to preferred name, then first-last.","examples":["Jack Galt"]},"manager":{"anyOf":[{"$ref":"#/components/schemas/PublicWorkerManager"},{"type":"null"}],"description":"The worker's manager, or null if unassigned.","examples":[{"id":"wrk_3Fna7qP2mL8z","firstName":"Hank","lastName":"Rearden","displayName":"Hank Rearden"},null]},"timeZone":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The IANA timezone of the worker (e.g., America/New_York).","examples":["America/New_York"]},"tShirtSize":{"anyOf":[{"type":"string","enum":["XS","S","M","L","XL","XXL","XXXL"]},{"type":"null"}],"description":"The worker's stored T-shirt size, or null when unset or unavailable.","examples":["M",null]},"department":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","pattern":"^dpt_","description":"The unique public id of the department","examples":["dpt_1234"]},"name":{"type":"string"}},"required":["id","name"],"additionalProperties":false},{"type":"null"}],"description":"The department the worker belongs to, or null if unassigned.","examples":[{"id":"dpt_7Rqa2mP9xK4c","name":"Engineering"},null]},"primaryWorkplace":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","pattern":"^wkp_","description":"Public workplace identifier","examples":["wkp_1234"]},"name":{"type":"string"},"type":{"type":"string","enum":["remote","office"]}},"required":["id","name","type"],"additionalProperties":false},{"type":"null"}],"description":"The primary workplace the worker is assigned to, or null if unassigned.","examples":[{"id":"wkp_4Nva8qT2mL7z","name":"New York Office","type":"office"},null]},"latestRehireDate":{"anyOf":[{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},{"type":"null"}],"description":"The date the worker was most recently reactivated after an offboarding. This is distinct from startDate and is null if the worker has not been rehired.","examples":["2024-02-05",null]},"terminationReason":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The reason the worker was terminated, or null when no termination reason is recorded.","examples":["Position eliminated",null]},"updatedAt":{"type":"string","examples":["2026-08-20T14:30:00.000Z"]},"level":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","pattern":"^jlvl_","description":"The unique public id of the job level","examples":["jlvl_1234"]},"code":{"type":"string"},"name":{"type":"string"},"track":{"type":"string","enum":["ic","manager","executive"]}},"required":["id","code","name","track"],"additionalProperties":false},{"type":"null"}],"description":"The worker's assigned job level, or null if unassigned. Omitted when job levels are not enabled."},"compensation":{"anyOf":[{"$ref":"#/components/schemas/PublicWorkerCompensation"},{"type":"null"}],"description":"The worker's current regular compensation, or the rate effective on a future start date. Null when the worker has no applicable regular pay rate or the API key lacks the corresponding compensation read scope.","examples":[{"payRateId":"pyr_9Cka3pR8vM2x","per":"year","amount":15000000,"currency":"USD","display":"$150,000.00 / yr"},null]},"customFields":{"anyOf":[{"type":"array","items":{"$ref":"#/components/schemas/PublicWorkerCustomField"},"description":"The worker's custom field values. Every active company custom field appears; fields outside this API key's permission scopes are redacted (value null, redacted true) rather than omitted, so the list is identical across keys. Empty when the company has no custom fields.","examples":[[]]},{"type":"null"}]}},"required":["id","position","type","status","benefitEligible","startDate","endDate","isBusiness","businessName","firstName","lastName","email","workEmail","preferredName","biologicalSex","maritalStatus","dateOfBirth","phone","address","displayName","timeZone","department","primaryWorkplace","latestRehireDate","terminationReason","updatedAt","compensation"],"additionalProperties":false,"description":"A worker profile, including lifecycle, workplace, profile, and compensation fields.","examples":[{"id":"wrk_khac8380c2Lm","position":"Research Engineer","type":"employee","status":"active","benefitEligible":true,"startDate":"2022-04-11","endDate":null,"isBusiness":null,"businessName":null,"firstName":"Jane","lastName":"Doe","email":"jane.doe@example.com","workEmail":"jane.doe@acme.example","preferredName":"Jane","biologicalSex":"female","maritalStatus":"married","dateOfBirth":"1990-06-15","phone":"+12025550143","address":{"line1":"123 Example Street","line2":"Suite 400","city":"New York","state":"NY","postalCode":"10001","country":"US"},"displayName":"Jane Doe","manager":{"id":"wrk_3Fna7qP2mL8z","firstName":"Hank","lastName":"Rearden","displayName":"Hank Rearden"},"timeZone":"America/New_York","tShirtSize":"M","department":{"id":"dpt_7Rqa2mP9xK4c","name":"Engineering"},"primaryWorkplace":{"id":"wkp_4Nva8qT2mL7z","name":"New York Office","type":"office"},"latestRehireDate":"2024-02-05","terminationReason":null,"updatedAt":"2026-08-20T14:30:00.000Z","compensation":{"payRateId":"pyr_9Cka3pR8vM2x","per":"year","amount":15000000,"currency":"USD","display":"$150,000.00 / yr"},"customFields":[]}]}},"required":["id","type","timestamp","data"],"additionalProperties":false}}}},"responses":{"200":{"description":"Return any 2xx status code to acknowledge receipt. Non-2xx responses or timeouts are retried with exponential backoff."}}}},"worker.deleted":{"post":{"tags":["Workers"],"summary":"Worker Deleted","description":"Sent when a worker is deleted.","parameters":[{"name":"webhook-id","in":"header","required":true,"description":"Unique identifier for this message. Stable across retries and manual resends — use it as your idempotency key.","schema":{"type":"string","examples":["tor_abc123:550e8400-e29b-41d4-a716-446655440000"]}},{"name":"webhook-timestamp","in":"header","required":true,"description":"Unix timestamp in seconds for this delivery attempt. Recomputed on every attempt — reject deliveries whose timestamp is outside your tolerance window to guard against replay.","schema":{"type":"string","examples":["1752580800"]}},{"name":"webhook-signature","in":"header","required":true,"description":"Space-separated list of signatures over `{webhook-id}.{webhook-timestamp}.{body}`, each formatted `v1,<base64>` where `v1` is HMAC-SHA256 with your signing secret. During a secret rotation the list carries one signature per live secret; a match on any one is valid.","schema":{"type":"string","examples":["v1,g0hM9SsE+OTPJTGt/tmIKtSyZlE3uFJELVlNIOLJ1OE="]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Unique event identifier (format: `<objectTag>:<uuid>`). Stable across retries.","examples":["tor_abc123:550e8400-e29b-41d4-a716-446655440000"]},"type":{"type":"string","enum":["worker.deleted"],"description":"The event type."},"timestamp":{"type":"string","description":"ISO 8601 timestamp of when the event occurred. Unchanged across retries.","examples":["2026-07-15T12:00:00.000Z"]},"data":{"type":"object","properties":{"id":{"type":"string","pattern":"^wrk_","description":"The id of the worker.","examples":["wrk_1234"]},"position":{"type":"string","examples":["Research Engineer"]},"type":{"type":"string","enum":["employee","contractor"]},"status":{"type":"string","enum":["draft","invited","onboarding","active","offboarding","inactive"]},"benefitEligible":{"type":"boolean","allOf":[{"description":"The worker's stored benefits eligibility flag.","examples":[true,false]}]},"startDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","allOf":[{"description":"The worker's employment start date. Reactivation after an offboarding is reported separately in latestRehireDate.","examples":["2022-04-11"]}]},"endDate":{"anyOf":[{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},{"type":"null"}],"allOf":[{"description":"The worker's final day of employment, or null when employment is ongoing.","examples":["2026-08-15",null]}]},"isBusiness":{"anyOf":[{"type":"boolean"},{"type":"null"}],"examples":[false]},"businessName":{"anyOf":[{"type":"string"},{"type":"null"}],"examples":[null,"Galt Enterprises, LLC"]},"firstName":{"type":"string","examples":["Jonathan","Melissa"]},"lastName":{"type":"string","examples":["Galt","Jones"]},"email":{"type":"string","format":"email","title":"Email","description":"An email with a reasonably valid regex (based on RFC 5321 atext characters)","examples":["john@joinwarp.com"]},"workEmail":{"anyOf":[{"type":"string","format":"email","title":"Email","description":"An email with a reasonably valid regex (based on RFC 5321 atext characters)","examples":["john@joinwarp.com"]},{"type":"null"}]},"preferredName":{"anyOf":[{"type":"string","examples":["John"]},{"type":"null"}]},"biologicalSex":{"anyOf":[{"type":"string","enum":["male","female"]},{"type":"null"}],"description":"The worker's biological sex, or null when unavailable.","examples":["female"]},"maritalStatus":{"anyOf":[{"type":"string","enum":["married","not_married"]},{"type":"null"}],"description":"The worker's marital status, or null when unavailable.","examples":["married"]},"dateOfBirth":{"anyOf":[{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},{"type":"null"}],"description":"The worker's date of birth, or null when unavailable.","examples":["1990-06-15"]},"phone":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The worker's personal phone number, or null when unavailable.","examples":["+12025550143"]},"address":{"anyOf":[{"$ref":"#/components/schemas/PublicWorkerAddress"},{"type":"null"}],"description":"The worker's home address, or null when unavailable.","examples":[{"line1":"123 Example Street","line2":"Suite 400","city":"New York","state":"NY","postalCode":"10001","country":"US"}]},"displayName":{"type":"string","description":"The \"ui\" name of a worker. If it's a business contractor business name is used. Otherwise we default to preferred name, then first-last.","examples":["Jack Galt"]},"manager":{"anyOf":[{"$ref":"#/components/schemas/PublicWorkerManager"},{"type":"null"}],"description":"The worker's manager, or null if unassigned.","examples":[{"id":"wrk_3Fna7qP2mL8z","firstName":"Hank","lastName":"Rearden","displayName":"Hank Rearden"},null]},"timeZone":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The IANA timezone of the worker (e.g., America/New_York).","examples":["America/New_York"]},"tShirtSize":{"anyOf":[{"type":"string","enum":["XS","S","M","L","XL","XXL","XXXL"]},{"type":"null"}],"description":"The worker's stored T-shirt size, or null when unset or unavailable.","examples":["M",null]},"department":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","pattern":"^dpt_","description":"The unique public id of the department","examples":["dpt_1234"]},"name":{"type":"string"}},"required":["id","name"],"additionalProperties":false},{"type":"null"}],"description":"The department the worker belongs to, or null if unassigned.","examples":[{"id":"dpt_7Rqa2mP9xK4c","name":"Engineering"},null]},"primaryWorkplace":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","pattern":"^wkp_","description":"Public workplace identifier","examples":["wkp_1234"]},"name":{"type":"string"},"type":{"type":"string","enum":["remote","office"]}},"required":["id","name","type"],"additionalProperties":false},{"type":"null"}],"description":"The primary workplace the worker is assigned to, or null if unassigned.","examples":[{"id":"wkp_4Nva8qT2mL7z","name":"New York Office","type":"office"},null]},"latestRehireDate":{"anyOf":[{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},{"type":"null"}],"description":"The date the worker was most recently reactivated after an offboarding. This is distinct from startDate and is null if the worker has not been rehired.","examples":["2024-02-05",null]},"terminationReason":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The reason the worker was terminated, or null when no termination reason is recorded.","examples":["Position eliminated",null]},"updatedAt":{"type":"string","examples":["2026-08-20T14:30:00.000Z"]},"level":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","pattern":"^jlvl_","description":"The unique public id of the job level","examples":["jlvl_1234"]},"code":{"type":"string"},"name":{"type":"string"},"track":{"type":"string","enum":["ic","manager","executive"]}},"required":["id","code","name","track"],"additionalProperties":false},{"type":"null"}],"description":"The worker's assigned job level, or null if unassigned. Omitted when job levels are not enabled."},"compensation":{"anyOf":[{"$ref":"#/components/schemas/PublicWorkerCompensation"},{"type":"null"}],"description":"The worker's current regular compensation, or the rate effective on a future start date. Null when the worker has no applicable regular pay rate or the API key lacks the corresponding compensation read scope.","examples":[{"payRateId":"pyr_9Cka3pR8vM2x","per":"year","amount":15000000,"currency":"USD","display":"$150,000.00 / yr"},null]},"customFields":{"anyOf":[{"type":"array","items":{"$ref":"#/components/schemas/PublicWorkerCustomField"},"description":"The worker's custom field values. Every active company custom field appears; fields outside this API key's permission scopes are redacted (value null, redacted true) rather than omitted, so the list is identical across keys. Empty when the company has no custom fields.","examples":[[]]},{"type":"null"}]}},"required":["id","position","type","status","benefitEligible","startDate","endDate","isBusiness","businessName","firstName","lastName","email","workEmail","preferredName","biologicalSex","maritalStatus","dateOfBirth","phone","address","displayName","timeZone","department","primaryWorkplace","latestRehireDate","terminationReason","updatedAt","compensation"],"additionalProperties":false,"description":"A worker profile, including lifecycle, workplace, profile, and compensation fields.","examples":[{"id":"wrk_khac8380c2Lm","position":"Research Engineer","type":"employee","status":"active","benefitEligible":true,"startDate":"2022-04-11","endDate":null,"isBusiness":null,"businessName":null,"firstName":"Jane","lastName":"Doe","email":"jane.doe@example.com","workEmail":"jane.doe@acme.example","preferredName":"Jane","biologicalSex":"female","maritalStatus":"married","dateOfBirth":"1990-06-15","phone":"+12025550143","address":{"line1":"123 Example Street","line2":"Suite 400","city":"New York","state":"NY","postalCode":"10001","country":"US"},"displayName":"Jane Doe","manager":{"id":"wrk_3Fna7qP2mL8z","firstName":"Hank","lastName":"Rearden","displayName":"Hank Rearden"},"timeZone":"America/New_York","tShirtSize":"M","department":{"id":"dpt_7Rqa2mP9xK4c","name":"Engineering"},"primaryWorkplace":{"id":"wkp_4Nva8qT2mL7z","name":"New York Office","type":"office"},"latestRehireDate":"2024-02-05","terminationReason":null,"updatedAt":"2026-08-20T14:30:00.000Z","compensation":{"payRateId":"pyr_9Cka3pR8vM2x","per":"year","amount":15000000,"currency":"USD","display":"$150,000.00 / yr"},"customFields":[]}]}},"required":["id","type","timestamp","data"],"additionalProperties":false}}}},"responses":{"200":{"description":"Return any 2xx status code to acknowledge receipt. Non-2xx responses or timeouts are retried with exponential backoff."}}}},"worker.invite_sent":{"post":{"tags":["Workers"],"summary":"Worker Invite Sent","description":"Sent when a worker is invited to the platform.","parameters":[{"name":"webhook-id","in":"header","required":true,"description":"Unique identifier for this message. Stable across retries and manual resends — use it as your idempotency key.","schema":{"type":"string","examples":["tor_abc123:550e8400-e29b-41d4-a716-446655440000"]}},{"name":"webhook-timestamp","in":"header","required":true,"description":"Unix timestamp in seconds for this delivery attempt. Recomputed on every attempt — reject deliveries whose timestamp is outside your tolerance window to guard against replay.","schema":{"type":"string","examples":["1752580800"]}},{"name":"webhook-signature","in":"header","required":true,"description":"Space-separated list of signatures over `{webhook-id}.{webhook-timestamp}.{body}`, each formatted `v1,<base64>` where `v1` is HMAC-SHA256 with your signing secret. During a secret rotation the list carries one signature per live secret; a match on any one is valid.","schema":{"type":"string","examples":["v1,g0hM9SsE+OTPJTGt/tmIKtSyZlE3uFJELVlNIOLJ1OE="]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Unique event identifier (format: `<objectTag>:<uuid>`). Stable across retries.","examples":["tor_abc123:550e8400-e29b-41d4-a716-446655440000"]},"type":{"type":"string","enum":["worker.invite_sent"],"description":"The event type."},"timestamp":{"type":"string","description":"ISO 8601 timestamp of when the event occurred. Unchanged across retries.","examples":["2026-07-15T12:00:00.000Z"]},"data":{"type":"object","properties":{"id":{"type":"string","pattern":"^wrk_","description":"The id of the worker.","examples":["wrk_1234"]},"position":{"type":"string","examples":["Research Engineer"]},"type":{"type":"string","enum":["employee","contractor"]},"status":{"type":"string","enum":["draft","invited","onboarding","active","offboarding","inactive"]},"benefitEligible":{"type":"boolean","allOf":[{"description":"The worker's stored benefits eligibility flag.","examples":[true,false]}]},"startDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","allOf":[{"description":"The worker's employment start date. Reactivation after an offboarding is reported separately in latestRehireDate.","examples":["2022-04-11"]}]},"endDate":{"anyOf":[{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},{"type":"null"}],"allOf":[{"description":"The worker's final day of employment, or null when employment is ongoing.","examples":["2026-08-15",null]}]},"isBusiness":{"anyOf":[{"type":"boolean"},{"type":"null"}],"examples":[false]},"businessName":{"anyOf":[{"type":"string"},{"type":"null"}],"examples":[null,"Galt Enterprises, LLC"]},"firstName":{"type":"string","examples":["Jonathan","Melissa"]},"lastName":{"type":"string","examples":["Galt","Jones"]},"email":{"type":"string","format":"email","title":"Email","description":"An email with a reasonably valid regex (based on RFC 5321 atext characters)","examples":["john@joinwarp.com"]},"workEmail":{"anyOf":[{"type":"string","format":"email","title":"Email","description":"An email with a reasonably valid regex (based on RFC 5321 atext characters)","examples":["john@joinwarp.com"]},{"type":"null"}]},"preferredName":{"anyOf":[{"type":"string","examples":["John"]},{"type":"null"}]},"biologicalSex":{"anyOf":[{"type":"string","enum":["male","female"]},{"type":"null"}],"description":"The worker's biological sex, or null when unavailable.","examples":["female"]},"maritalStatus":{"anyOf":[{"type":"string","enum":["married","not_married"]},{"type":"null"}],"description":"The worker's marital status, or null when unavailable.","examples":["married"]},"dateOfBirth":{"anyOf":[{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},{"type":"null"}],"description":"The worker's date of birth, or null when unavailable.","examples":["1990-06-15"]},"phone":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The worker's personal phone number, or null when unavailable.","examples":["+12025550143"]},"address":{"anyOf":[{"$ref":"#/components/schemas/PublicWorkerAddress"},{"type":"null"}],"description":"The worker's home address, or null when unavailable.","examples":[{"line1":"123 Example Street","line2":"Suite 400","city":"New York","state":"NY","postalCode":"10001","country":"US"}]},"displayName":{"type":"string","description":"The \"ui\" name of a worker. If it's a business contractor business name is used. Otherwise we default to preferred name, then first-last.","examples":["Jack Galt"]},"manager":{"anyOf":[{"$ref":"#/components/schemas/PublicWorkerManager"},{"type":"null"}],"description":"The worker's manager, or null if unassigned.","examples":[{"id":"wrk_3Fna7qP2mL8z","firstName":"Hank","lastName":"Rearden","displayName":"Hank Rearden"},null]},"timeZone":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The IANA timezone of the worker (e.g., America/New_York).","examples":["America/New_York"]},"tShirtSize":{"anyOf":[{"type":"string","enum":["XS","S","M","L","XL","XXL","XXXL"]},{"type":"null"}],"description":"The worker's stored T-shirt size, or null when unset or unavailable.","examples":["M",null]},"department":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","pattern":"^dpt_","description":"The unique public id of the department","examples":["dpt_1234"]},"name":{"type":"string"}},"required":["id","name"],"additionalProperties":false},{"type":"null"}],"description":"The department the worker belongs to, or null if unassigned.","examples":[{"id":"dpt_7Rqa2mP9xK4c","name":"Engineering"},null]},"primaryWorkplace":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","pattern":"^wkp_","description":"Public workplace identifier","examples":["wkp_1234"]},"name":{"type":"string"},"type":{"type":"string","enum":["remote","office"]}},"required":["id","name","type"],"additionalProperties":false},{"type":"null"}],"description":"The primary workplace the worker is assigned to, or null if unassigned.","examples":[{"id":"wkp_4Nva8qT2mL7z","name":"New York Office","type":"office"},null]},"latestRehireDate":{"anyOf":[{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},{"type":"null"}],"description":"The date the worker was most recently reactivated after an offboarding. This is distinct from startDate and is null if the worker has not been rehired.","examples":["2024-02-05",null]},"terminationReason":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The reason the worker was terminated, or null when no termination reason is recorded.","examples":["Position eliminated",null]},"updatedAt":{"type":"string","examples":["2026-08-20T14:30:00.000Z"]},"level":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","pattern":"^jlvl_","description":"The unique public id of the job level","examples":["jlvl_1234"]},"code":{"type":"string"},"name":{"type":"string"},"track":{"type":"string","enum":["ic","manager","executive"]}},"required":["id","code","name","track"],"additionalProperties":false},{"type":"null"}],"description":"The worker's assigned job level, or null if unassigned. Omitted when job levels are not enabled."},"compensation":{"anyOf":[{"$ref":"#/components/schemas/PublicWorkerCompensation"},{"type":"null"}],"description":"The worker's current regular compensation, or the rate effective on a future start date. Null when the worker has no applicable regular pay rate or the API key lacks the corresponding compensation read scope.","examples":[{"payRateId":"pyr_9Cka3pR8vM2x","per":"year","amount":15000000,"currency":"USD","display":"$150,000.00 / yr"},null]},"customFields":{"anyOf":[{"type":"array","items":{"$ref":"#/components/schemas/PublicWorkerCustomField"},"description":"The worker's custom field values. Every active company custom field appears; fields outside this API key's permission scopes are redacted (value null, redacted true) rather than omitted, so the list is identical across keys. Empty when the company has no custom fields.","examples":[[]]},{"type":"null"}]}},"required":["id","position","type","status","benefitEligible","startDate","endDate","isBusiness","businessName","firstName","lastName","email","workEmail","preferredName","biologicalSex","maritalStatus","dateOfBirth","phone","address","displayName","timeZone","department","primaryWorkplace","latestRehireDate","terminationReason","updatedAt","compensation"],"additionalProperties":false,"description":"A worker profile, including lifecycle, workplace, profile, and compensation fields.","examples":[{"id":"wrk_khac8380c2Lm","position":"Research Engineer","type":"employee","status":"active","benefitEligible":true,"startDate":"2022-04-11","endDate":null,"isBusiness":null,"businessName":null,"firstName":"Jane","lastName":"Doe","email":"jane.doe@example.com","workEmail":"jane.doe@acme.example","preferredName":"Jane","biologicalSex":"female","maritalStatus":"married","dateOfBirth":"1990-06-15","phone":"+12025550143","address":{"line1":"123 Example Street","line2":"Suite 400","city":"New York","state":"NY","postalCode":"10001","country":"US"},"displayName":"Jane Doe","manager":{"id":"wrk_3Fna7qP2mL8z","firstName":"Hank","lastName":"Rearden","displayName":"Hank Rearden"},"timeZone":"America/New_York","tShirtSize":"M","department":{"id":"dpt_7Rqa2mP9xK4c","name":"Engineering"},"primaryWorkplace":{"id":"wkp_4Nva8qT2mL7z","name":"New York Office","type":"office"},"latestRehireDate":"2024-02-05","terminationReason":null,"updatedAt":"2026-08-20T14:30:00.000Z","compensation":{"payRateId":"pyr_9Cka3pR8vM2x","per":"year","amount":15000000,"currency":"USD","display":"$150,000.00 / yr"},"customFields":[]}]}},"required":["id","type","timestamp","data"],"additionalProperties":false}}}},"responses":{"200":{"description":"Return any 2xx status code to acknowledge receipt. Non-2xx responses or timeouts are retried with exponential backoff."}}}},"worker.invite_accepted":{"post":{"tags":["Workers"],"summary":"Worker Invite Accepted","description":"Sent when a worker accepts their invitation.","parameters":[{"name":"webhook-id","in":"header","required":true,"description":"Unique identifier for this message. Stable across retries and manual resends — use it as your idempotency key.","schema":{"type":"string","examples":["tor_abc123:550e8400-e29b-41d4-a716-446655440000"]}},{"name":"webhook-timestamp","in":"header","required":true,"description":"Unix timestamp in seconds for this delivery attempt. Recomputed on every attempt — reject deliveries whose timestamp is outside your tolerance window to guard against replay.","schema":{"type":"string","examples":["1752580800"]}},{"name":"webhook-signature","in":"header","required":true,"description":"Space-separated list of signatures over `{webhook-id}.{webhook-timestamp}.{body}`, each formatted `v1,<base64>` where `v1` is HMAC-SHA256 with your signing secret. During a secret rotation the list carries one signature per live secret; a match on any one is valid.","schema":{"type":"string","examples":["v1,g0hM9SsE+OTPJTGt/tmIKtSyZlE3uFJELVlNIOLJ1OE="]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Unique event identifier (format: `<objectTag>:<uuid>`). Stable across retries.","examples":["tor_abc123:550e8400-e29b-41d4-a716-446655440000"]},"type":{"type":"string","enum":["worker.invite_accepted"],"description":"The event type."},"timestamp":{"type":"string","description":"ISO 8601 timestamp of when the event occurred. Unchanged across retries.","examples":["2026-07-15T12:00:00.000Z"]},"data":{"type":"object","properties":{"id":{"type":"string","pattern":"^wrk_","description":"The id of the worker.","examples":["wrk_1234"]},"position":{"type":"string","examples":["Research Engineer"]},"type":{"type":"string","enum":["employee","contractor"]},"status":{"type":"string","enum":["draft","invited","onboarding","active","offboarding","inactive"]},"benefitEligible":{"type":"boolean","allOf":[{"description":"The worker's stored benefits eligibility flag.","examples":[true,false]}]},"startDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","allOf":[{"description":"The worker's employment start date. Reactivation after an offboarding is reported separately in latestRehireDate.","examples":["2022-04-11"]}]},"endDate":{"anyOf":[{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},{"type":"null"}],"allOf":[{"description":"The worker's final day of employment, or null when employment is ongoing.","examples":["2026-08-15",null]}]},"isBusiness":{"anyOf":[{"type":"boolean"},{"type":"null"}],"examples":[false]},"businessName":{"anyOf":[{"type":"string"},{"type":"null"}],"examples":[null,"Galt Enterprises, LLC"]},"firstName":{"type":"string","examples":["Jonathan","Melissa"]},"lastName":{"type":"string","examples":["Galt","Jones"]},"email":{"type":"string","format":"email","title":"Email","description":"An email with a reasonably valid regex (based on RFC 5321 atext characters)","examples":["john@joinwarp.com"]},"workEmail":{"anyOf":[{"type":"string","format":"email","title":"Email","description":"An email with a reasonably valid regex (based on RFC 5321 atext characters)","examples":["john@joinwarp.com"]},{"type":"null"}]},"preferredName":{"anyOf":[{"type":"string","examples":["John"]},{"type":"null"}]},"biologicalSex":{"anyOf":[{"type":"string","enum":["male","female"]},{"type":"null"}],"description":"The worker's biological sex, or null when unavailable.","examples":["female"]},"maritalStatus":{"anyOf":[{"type":"string","enum":["married","not_married"]},{"type":"null"}],"description":"The worker's marital status, or null when unavailable.","examples":["married"]},"dateOfBirth":{"anyOf":[{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},{"type":"null"}],"description":"The worker's date of birth, or null when unavailable.","examples":["1990-06-15"]},"phone":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The worker's personal phone number, or null when unavailable.","examples":["+12025550143"]},"address":{"anyOf":[{"$ref":"#/components/schemas/PublicWorkerAddress"},{"type":"null"}],"description":"The worker's home address, or null when unavailable.","examples":[{"line1":"123 Example Street","line2":"Suite 400","city":"New York","state":"NY","postalCode":"10001","country":"US"}]},"displayName":{"type":"string","description":"The \"ui\" name of a worker. If it's a business contractor business name is used. Otherwise we default to preferred name, then first-last.","examples":["Jack Galt"]},"manager":{"anyOf":[{"$ref":"#/components/schemas/PublicWorkerManager"},{"type":"null"}],"description":"The worker's manager, or null if unassigned.","examples":[{"id":"wrk_3Fna7qP2mL8z","firstName":"Hank","lastName":"Rearden","displayName":"Hank Rearden"},null]},"timeZone":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The IANA timezone of the worker (e.g., America/New_York).","examples":["America/New_York"]},"tShirtSize":{"anyOf":[{"type":"string","enum":["XS","S","M","L","XL","XXL","XXXL"]},{"type":"null"}],"description":"The worker's stored T-shirt size, or null when unset or unavailable.","examples":["M",null]},"department":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","pattern":"^dpt_","description":"The unique public id of the department","examples":["dpt_1234"]},"name":{"type":"string"}},"required":["id","name"],"additionalProperties":false},{"type":"null"}],"description":"The department the worker belongs to, or null if unassigned.","examples":[{"id":"dpt_7Rqa2mP9xK4c","name":"Engineering"},null]},"primaryWorkplace":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","pattern":"^wkp_","description":"Public workplace identifier","examples":["wkp_1234"]},"name":{"type":"string"},"type":{"type":"string","enum":["remote","office"]}},"required":["id","name","type"],"additionalProperties":false},{"type":"null"}],"description":"The primary workplace the worker is assigned to, or null if unassigned.","examples":[{"id":"wkp_4Nva8qT2mL7z","name":"New York Office","type":"office"},null]},"latestRehireDate":{"anyOf":[{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},{"type":"null"}],"description":"The date the worker was most recently reactivated after an offboarding. This is distinct from startDate and is null if the worker has not been rehired.","examples":["2024-02-05",null]},"terminationReason":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The reason the worker was terminated, or null when no termination reason is recorded.","examples":["Position eliminated",null]},"updatedAt":{"type":"string","examples":["2026-08-20T14:30:00.000Z"]},"level":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","pattern":"^jlvl_","description":"The unique public id of the job level","examples":["jlvl_1234"]},"code":{"type":"string"},"name":{"type":"string"},"track":{"type":"string","enum":["ic","manager","executive"]}},"required":["id","code","name","track"],"additionalProperties":false},{"type":"null"}],"description":"The worker's assigned job level, or null if unassigned. Omitted when job levels are not enabled."},"compensation":{"anyOf":[{"$ref":"#/components/schemas/PublicWorkerCompensation"},{"type":"null"}],"description":"The worker's current regular compensation, or the rate effective on a future start date. Null when the worker has no applicable regular pay rate or the API key lacks the corresponding compensation read scope.","examples":[{"payRateId":"pyr_9Cka3pR8vM2x","per":"year","amount":15000000,"currency":"USD","display":"$150,000.00 / yr"},null]},"customFields":{"anyOf":[{"type":"array","items":{"$ref":"#/components/schemas/PublicWorkerCustomField"},"description":"The worker's custom field values. Every active company custom field appears; fields outside this API key's permission scopes are redacted (value null, redacted true) rather than omitted, so the list is identical across keys. Empty when the company has no custom fields.","examples":[[]]},{"type":"null"}]}},"required":["id","position","type","status","benefitEligible","startDate","endDate","isBusiness","businessName","firstName","lastName","email","workEmail","preferredName","biologicalSex","maritalStatus","dateOfBirth","phone","address","displayName","timeZone","department","primaryWorkplace","latestRehireDate","terminationReason","updatedAt","compensation"],"additionalProperties":false,"description":"A worker profile, including lifecycle, workplace, profile, and compensation fields.","examples":[{"id":"wrk_khac8380c2Lm","position":"Research Engineer","type":"employee","status":"active","benefitEligible":true,"startDate":"2022-04-11","endDate":null,"isBusiness":null,"businessName":null,"firstName":"Jane","lastName":"Doe","email":"jane.doe@example.com","workEmail":"jane.doe@acme.example","preferredName":"Jane","biologicalSex":"female","maritalStatus":"married","dateOfBirth":"1990-06-15","phone":"+12025550143","address":{"line1":"123 Example Street","line2":"Suite 400","city":"New York","state":"NY","postalCode":"10001","country":"US"},"displayName":"Jane Doe","manager":{"id":"wrk_3Fna7qP2mL8z","firstName":"Hank","lastName":"Rearden","displayName":"Hank Rearden"},"timeZone":"America/New_York","tShirtSize":"M","department":{"id":"dpt_7Rqa2mP9xK4c","name":"Engineering"},"primaryWorkplace":{"id":"wkp_4Nva8qT2mL7z","name":"New York Office","type":"office"},"latestRehireDate":"2024-02-05","terminationReason":null,"updatedAt":"2026-08-20T14:30:00.000Z","compensation":{"payRateId":"pyr_9Cka3pR8vM2x","per":"year","amount":15000000,"currency":"USD","display":"$150,000.00 / yr"},"customFields":[]}]}},"required":["id","type","timestamp","data"],"additionalProperties":false}}}},"responses":{"200":{"description":"Return any 2xx status code to acknowledge receipt. Non-2xx responses or timeouts are retried with exponential backoff."}}}},"worker.onboarding_completed":{"post":{"tags":["Workers"],"summary":"Worker Onboarding Completed","description":"Sent when a worker completes onboarding.","parameters":[{"name":"webhook-id","in":"header","required":true,"description":"Unique identifier for this message. Stable across retries and manual resends — use it as your idempotency key.","schema":{"type":"string","examples":["tor_abc123:550e8400-e29b-41d4-a716-446655440000"]}},{"name":"webhook-timestamp","in":"header","required":true,"description":"Unix timestamp in seconds for this delivery attempt. Recomputed on every attempt — reject deliveries whose timestamp is outside your tolerance window to guard against replay.","schema":{"type":"string","examples":["1752580800"]}},{"name":"webhook-signature","in":"header","required":true,"description":"Space-separated list of signatures over `{webhook-id}.{webhook-timestamp}.{body}`, each formatted `v1,<base64>` where `v1` is HMAC-SHA256 with your signing secret. During a secret rotation the list carries one signature per live secret; a match on any one is valid.","schema":{"type":"string","examples":["v1,g0hM9SsE+OTPJTGt/tmIKtSyZlE3uFJELVlNIOLJ1OE="]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Unique event identifier (format: `<objectTag>:<uuid>`). Stable across retries.","examples":["tor_abc123:550e8400-e29b-41d4-a716-446655440000"]},"type":{"type":"string","enum":["worker.onboarding_completed"],"description":"The event type."},"timestamp":{"type":"string","description":"ISO 8601 timestamp of when the event occurred. Unchanged across retries.","examples":["2026-07-15T12:00:00.000Z"]},"data":{"type":"object","properties":{"id":{"type":"string","pattern":"^wrk_","description":"The id of the worker.","examples":["wrk_1234"]},"position":{"type":"string","examples":["Research Engineer"]},"type":{"type":"string","enum":["employee","contractor"]},"status":{"type":"string","enum":["draft","invited","onboarding","active","offboarding","inactive"]},"benefitEligible":{"type":"boolean","allOf":[{"description":"The worker's stored benefits eligibility flag.","examples":[true,false]}]},"startDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","allOf":[{"description":"The worker's employment start date. Reactivation after an offboarding is reported separately in latestRehireDate.","examples":["2022-04-11"]}]},"endDate":{"anyOf":[{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},{"type":"null"}],"allOf":[{"description":"The worker's final day of employment, or null when employment is ongoing.","examples":["2026-08-15",null]}]},"isBusiness":{"anyOf":[{"type":"boolean"},{"type":"null"}],"examples":[false]},"businessName":{"anyOf":[{"type":"string"},{"type":"null"}],"examples":[null,"Galt Enterprises, LLC"]},"firstName":{"type":"string","examples":["Jonathan","Melissa"]},"lastName":{"type":"string","examples":["Galt","Jones"]},"email":{"type":"string","format":"email","title":"Email","description":"An email with a reasonably valid regex (based on RFC 5321 atext characters)","examples":["john@joinwarp.com"]},"workEmail":{"anyOf":[{"type":"string","format":"email","title":"Email","description":"An email with a reasonably valid regex (based on RFC 5321 atext characters)","examples":["john@joinwarp.com"]},{"type":"null"}]},"preferredName":{"anyOf":[{"type":"string","examples":["John"]},{"type":"null"}]},"biologicalSex":{"anyOf":[{"type":"string","enum":["male","female"]},{"type":"null"}],"description":"The worker's biological sex, or null when unavailable.","examples":["female"]},"maritalStatus":{"anyOf":[{"type":"string","enum":["married","not_married"]},{"type":"null"}],"description":"The worker's marital status, or null when unavailable.","examples":["married"]},"dateOfBirth":{"anyOf":[{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},{"type":"null"}],"description":"The worker's date of birth, or null when unavailable.","examples":["1990-06-15"]},"phone":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The worker's personal phone number, or null when unavailable.","examples":["+12025550143"]},"address":{"anyOf":[{"$ref":"#/components/schemas/PublicWorkerAddress"},{"type":"null"}],"description":"The worker's home address, or null when unavailable.","examples":[{"line1":"123 Example Street","line2":"Suite 400","city":"New York","state":"NY","postalCode":"10001","country":"US"}]},"displayName":{"type":"string","description":"The \"ui\" name of a worker. If it's a business contractor business name is used. Otherwise we default to preferred name, then first-last.","examples":["Jack Galt"]},"manager":{"anyOf":[{"$ref":"#/components/schemas/PublicWorkerManager"},{"type":"null"}],"description":"The worker's manager, or null if unassigned.","examples":[{"id":"wrk_3Fna7qP2mL8z","firstName":"Hank","lastName":"Rearden","displayName":"Hank Rearden"},null]},"timeZone":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The IANA timezone of the worker (e.g., America/New_York).","examples":["America/New_York"]},"tShirtSize":{"anyOf":[{"type":"string","enum":["XS","S","M","L","XL","XXL","XXXL"]},{"type":"null"}],"description":"The worker's stored T-shirt size, or null when unset or unavailable.","examples":["M",null]},"department":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","pattern":"^dpt_","description":"The unique public id of the department","examples":["dpt_1234"]},"name":{"type":"string"}},"required":["id","name"],"additionalProperties":false},{"type":"null"}],"description":"The department the worker belongs to, or null if unassigned.","examples":[{"id":"dpt_7Rqa2mP9xK4c","name":"Engineering"},null]},"primaryWorkplace":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","pattern":"^wkp_","description":"Public workplace identifier","examples":["wkp_1234"]},"name":{"type":"string"},"type":{"type":"string","enum":["remote","office"]}},"required":["id","name","type"],"additionalProperties":false},{"type":"null"}],"description":"The primary workplace the worker is assigned to, or null if unassigned.","examples":[{"id":"wkp_4Nva8qT2mL7z","name":"New York Office","type":"office"},null]},"latestRehireDate":{"anyOf":[{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},{"type":"null"}],"description":"The date the worker was most recently reactivated after an offboarding. This is distinct from startDate and is null if the worker has not been rehired.","examples":["2024-02-05",null]},"terminationReason":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The reason the worker was terminated, or null when no termination reason is recorded.","examples":["Position eliminated",null]},"updatedAt":{"type":"string","examples":["2026-08-20T14:30:00.000Z"]},"level":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","pattern":"^jlvl_","description":"The unique public id of the job level","examples":["jlvl_1234"]},"code":{"type":"string"},"name":{"type":"string"},"track":{"type":"string","enum":["ic","manager","executive"]}},"required":["id","code","name","track"],"additionalProperties":false},{"type":"null"}],"description":"The worker's assigned job level, or null if unassigned. Omitted when job levels are not enabled."},"compensation":{"anyOf":[{"$ref":"#/components/schemas/PublicWorkerCompensation"},{"type":"null"}],"description":"The worker's current regular compensation, or the rate effective on a future start date. Null when the worker has no applicable regular pay rate or the API key lacks the corresponding compensation read scope.","examples":[{"payRateId":"pyr_9Cka3pR8vM2x","per":"year","amount":15000000,"currency":"USD","display":"$150,000.00 / yr"},null]},"customFields":{"anyOf":[{"type":"array","items":{"$ref":"#/components/schemas/PublicWorkerCustomField"},"description":"The worker's custom field values. Every active company custom field appears; fields outside this API key's permission scopes are redacted (value null, redacted true) rather than omitted, so the list is identical across keys. Empty when the company has no custom fields.","examples":[[]]},{"type":"null"}]}},"required":["id","position","type","status","benefitEligible","startDate","endDate","isBusiness","businessName","firstName","lastName","email","workEmail","preferredName","biologicalSex","maritalStatus","dateOfBirth","phone","address","displayName","timeZone","department","primaryWorkplace","latestRehireDate","terminationReason","updatedAt","compensation"],"additionalProperties":false,"description":"A worker profile, including lifecycle, workplace, profile, and compensation fields.","examples":[{"id":"wrk_khac8380c2Lm","position":"Research Engineer","type":"employee","status":"active","benefitEligible":true,"startDate":"2022-04-11","endDate":null,"isBusiness":null,"businessName":null,"firstName":"Jane","lastName":"Doe","email":"jane.doe@example.com","workEmail":"jane.doe@acme.example","preferredName":"Jane","biologicalSex":"female","maritalStatus":"married","dateOfBirth":"1990-06-15","phone":"+12025550143","address":{"line1":"123 Example Street","line2":"Suite 400","city":"New York","state":"NY","postalCode":"10001","country":"US"},"displayName":"Jane Doe","manager":{"id":"wrk_3Fna7qP2mL8z","firstName":"Hank","lastName":"Rearden","displayName":"Hank Rearden"},"timeZone":"America/New_York","tShirtSize":"M","department":{"id":"dpt_7Rqa2mP9xK4c","name":"Engineering"},"primaryWorkplace":{"id":"wkp_4Nva8qT2mL7z","name":"New York Office","type":"office"},"latestRehireDate":"2024-02-05","terminationReason":null,"updatedAt":"2026-08-20T14:30:00.000Z","compensation":{"payRateId":"pyr_9Cka3pR8vM2x","per":"year","amount":15000000,"currency":"USD","display":"$150,000.00 / yr"},"customFields":[]}]}},"required":["id","type","timestamp","data"],"additionalProperties":false}}}},"responses":{"200":{"description":"Return any 2xx status code to acknowledge receipt. Non-2xx responses or timeouts are retried with exponential backoff."}}}},"worker.offboarding_started":{"post":{"tags":["Workers"],"summary":"Worker Offboarding Started","description":"Sent when offboarding begins for a worker.","parameters":[{"name":"webhook-id","in":"header","required":true,"description":"Unique identifier for this message. Stable across retries and manual resends — use it as your idempotency key.","schema":{"type":"string","examples":["tor_abc123:550e8400-e29b-41d4-a716-446655440000"]}},{"name":"webhook-timestamp","in":"header","required":true,"description":"Unix timestamp in seconds for this delivery attempt. Recomputed on every attempt — reject deliveries whose timestamp is outside your tolerance window to guard against replay.","schema":{"type":"string","examples":["1752580800"]}},{"name":"webhook-signature","in":"header","required":true,"description":"Space-separated list of signatures over `{webhook-id}.{webhook-timestamp}.{body}`, each formatted `v1,<base64>` where `v1` is HMAC-SHA256 with your signing secret. During a secret rotation the list carries one signature per live secret; a match on any one is valid.","schema":{"type":"string","examples":["v1,g0hM9SsE+OTPJTGt/tmIKtSyZlE3uFJELVlNIOLJ1OE="]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Unique event identifier (format: `<objectTag>:<uuid>`). Stable across retries.","examples":["tor_abc123:550e8400-e29b-41d4-a716-446655440000"]},"type":{"type":"string","enum":["worker.offboarding_started"],"description":"The event type."},"timestamp":{"type":"string","description":"ISO 8601 timestamp of when the event occurred. Unchanged across retries.","examples":["2026-07-15T12:00:00.000Z"]},"data":{"type":"object","properties":{"id":{"type":"string","pattern":"^wrk_","description":"The id of the worker.","examples":["wrk_1234"]},"position":{"type":"string","examples":["Research Engineer"]},"type":{"type":"string","enum":["employee","contractor"]},"status":{"type":"string","enum":["draft","invited","onboarding","active","offboarding","inactive"]},"benefitEligible":{"type":"boolean","allOf":[{"description":"The worker's stored benefits eligibility flag.","examples":[true,false]}]},"startDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","allOf":[{"description":"The worker's employment start date. Reactivation after an offboarding is reported separately in latestRehireDate.","examples":["2022-04-11"]}]},"endDate":{"anyOf":[{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},{"type":"null"}],"allOf":[{"description":"The worker's final day of employment, or null when employment is ongoing.","examples":["2026-08-15",null]}]},"isBusiness":{"anyOf":[{"type":"boolean"},{"type":"null"}],"examples":[false]},"businessName":{"anyOf":[{"type":"string"},{"type":"null"}],"examples":[null,"Galt Enterprises, LLC"]},"firstName":{"type":"string","examples":["Jonathan","Melissa"]},"lastName":{"type":"string","examples":["Galt","Jones"]},"email":{"type":"string","format":"email","title":"Email","description":"An email with a reasonably valid regex (based on RFC 5321 atext characters)","examples":["john@joinwarp.com"]},"workEmail":{"anyOf":[{"type":"string","format":"email","title":"Email","description":"An email with a reasonably valid regex (based on RFC 5321 atext characters)","examples":["john@joinwarp.com"]},{"type":"null"}]},"preferredName":{"anyOf":[{"type":"string","examples":["John"]},{"type":"null"}]},"biologicalSex":{"anyOf":[{"type":"string","enum":["male","female"]},{"type":"null"}],"description":"The worker's biological sex, or null when unavailable.","examples":["female"]},"maritalStatus":{"anyOf":[{"type":"string","enum":["married","not_married"]},{"type":"null"}],"description":"The worker's marital status, or null when unavailable.","examples":["married"]},"dateOfBirth":{"anyOf":[{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},{"type":"null"}],"description":"The worker's date of birth, or null when unavailable.","examples":["1990-06-15"]},"phone":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The worker's personal phone number, or null when unavailable.","examples":["+12025550143"]},"address":{"anyOf":[{"$ref":"#/components/schemas/PublicWorkerAddress"},{"type":"null"}],"description":"The worker's home address, or null when unavailable.","examples":[{"line1":"123 Example Street","line2":"Suite 400","city":"New York","state":"NY","postalCode":"10001","country":"US"}]},"displayName":{"type":"string","description":"The \"ui\" name of a worker. If it's a business contractor business name is used. Otherwise we default to preferred name, then first-last.","examples":["Jack Galt"]},"manager":{"anyOf":[{"$ref":"#/components/schemas/PublicWorkerManager"},{"type":"null"}],"description":"The worker's manager, or null if unassigned.","examples":[{"id":"wrk_3Fna7qP2mL8z","firstName":"Hank","lastName":"Rearden","displayName":"Hank Rearden"},null]},"timeZone":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The IANA timezone of the worker (e.g., America/New_York).","examples":["America/New_York"]},"tShirtSize":{"anyOf":[{"type":"string","enum":["XS","S","M","L","XL","XXL","XXXL"]},{"type":"null"}],"description":"The worker's stored T-shirt size, or null when unset or unavailable.","examples":["M",null]},"department":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","pattern":"^dpt_","description":"The unique public id of the department","examples":["dpt_1234"]},"name":{"type":"string"}},"required":["id","name"],"additionalProperties":false},{"type":"null"}],"description":"The department the worker belongs to, or null if unassigned.","examples":[{"id":"dpt_7Rqa2mP9xK4c","name":"Engineering"},null]},"primaryWorkplace":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","pattern":"^wkp_","description":"Public workplace identifier","examples":["wkp_1234"]},"name":{"type":"string"},"type":{"type":"string","enum":["remote","office"]}},"required":["id","name","type"],"additionalProperties":false},{"type":"null"}],"description":"The primary workplace the worker is assigned to, or null if unassigned.","examples":[{"id":"wkp_4Nva8qT2mL7z","name":"New York Office","type":"office"},null]},"latestRehireDate":{"anyOf":[{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},{"type":"null"}],"description":"The date the worker was most recently reactivated after an offboarding. This is distinct from startDate and is null if the worker has not been rehired.","examples":["2024-02-05",null]},"terminationReason":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The reason the worker was terminated, or null when no termination reason is recorded.","examples":["Position eliminated",null]},"updatedAt":{"type":"string","examples":["2026-08-20T14:30:00.000Z"]},"level":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","pattern":"^jlvl_","description":"The unique public id of the job level","examples":["jlvl_1234"]},"code":{"type":"string"},"name":{"type":"string"},"track":{"type":"string","enum":["ic","manager","executive"]}},"required":["id","code","name","track"],"additionalProperties":false},{"type":"null"}],"description":"The worker's assigned job level, or null if unassigned. Omitted when job levels are not enabled."},"compensation":{"anyOf":[{"$ref":"#/components/schemas/PublicWorkerCompensation"},{"type":"null"}],"description":"The worker's current regular compensation, or the rate effective on a future start date. Null when the worker has no applicable regular pay rate or the API key lacks the corresponding compensation read scope.","examples":[{"payRateId":"pyr_9Cka3pR8vM2x","per":"year","amount":15000000,"currency":"USD","display":"$150,000.00 / yr"},null]},"customFields":{"anyOf":[{"type":"array","items":{"$ref":"#/components/schemas/PublicWorkerCustomField"},"description":"The worker's custom field values. Every active company custom field appears; fields outside this API key's permission scopes are redacted (value null, redacted true) rather than omitted, so the list is identical across keys. Empty when the company has no custom fields.","examples":[[]]},{"type":"null"}]}},"required":["id","position","type","status","benefitEligible","startDate","endDate","isBusiness","businessName","firstName","lastName","email","workEmail","preferredName","biologicalSex","maritalStatus","dateOfBirth","phone","address","displayName","timeZone","department","primaryWorkplace","latestRehireDate","terminationReason","updatedAt","compensation"],"additionalProperties":false,"description":"A worker profile, including lifecycle, workplace, profile, and compensation fields.","examples":[{"id":"wrk_khac8380c2Lm","position":"Research Engineer","type":"employee","status":"active","benefitEligible":true,"startDate":"2022-04-11","endDate":null,"isBusiness":null,"businessName":null,"firstName":"Jane","lastName":"Doe","email":"jane.doe@example.com","workEmail":"jane.doe@acme.example","preferredName":"Jane","biologicalSex":"female","maritalStatus":"married","dateOfBirth":"1990-06-15","phone":"+12025550143","address":{"line1":"123 Example Street","line2":"Suite 400","city":"New York","state":"NY","postalCode":"10001","country":"US"},"displayName":"Jane Doe","manager":{"id":"wrk_3Fna7qP2mL8z","firstName":"Hank","lastName":"Rearden","displayName":"Hank Rearden"},"timeZone":"America/New_York","tShirtSize":"M","department":{"id":"dpt_7Rqa2mP9xK4c","name":"Engineering"},"primaryWorkplace":{"id":"wkp_4Nva8qT2mL7z","name":"New York Office","type":"office"},"latestRehireDate":"2024-02-05","terminationReason":null,"updatedAt":"2026-08-20T14:30:00.000Z","compensation":{"payRateId":"pyr_9Cka3pR8vM2x","per":"year","amount":15000000,"currency":"USD","display":"$150,000.00 / yr"},"customFields":[]}]}},"required":["id","type","timestamp","data"],"additionalProperties":false}}}},"responses":{"200":{"description":"Return any 2xx status code to acknowledge receipt. Non-2xx responses or timeouts are retried with exponential backoff."}}}},"worker.offboarded":{"post":{"tags":["Workers"],"summary":"Worker Offboarded","description":"Sent when a worker has been offboarded.","parameters":[{"name":"webhook-id","in":"header","required":true,"description":"Unique identifier for this message. Stable across retries and manual resends — use it as your idempotency key.","schema":{"type":"string","examples":["tor_abc123:550e8400-e29b-41d4-a716-446655440000"]}},{"name":"webhook-timestamp","in":"header","required":true,"description":"Unix timestamp in seconds for this delivery attempt. Recomputed on every attempt — reject deliveries whose timestamp is outside your tolerance window to guard against replay.","schema":{"type":"string","examples":["1752580800"]}},{"name":"webhook-signature","in":"header","required":true,"description":"Space-separated list of signatures over `{webhook-id}.{webhook-timestamp}.{body}`, each formatted `v1,<base64>` where `v1` is HMAC-SHA256 with your signing secret. During a secret rotation the list carries one signature per live secret; a match on any one is valid.","schema":{"type":"string","examples":["v1,g0hM9SsE+OTPJTGt/tmIKtSyZlE3uFJELVlNIOLJ1OE="]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Unique event identifier (format: `<objectTag>:<uuid>`). Stable across retries.","examples":["tor_abc123:550e8400-e29b-41d4-a716-446655440000"]},"type":{"type":"string","enum":["worker.offboarded"],"description":"The event type."},"timestamp":{"type":"string","description":"ISO 8601 timestamp of when the event occurred. Unchanged across retries.","examples":["2026-07-15T12:00:00.000Z"]},"data":{"type":"object","properties":{"id":{"type":"string","pattern":"^wrk_","description":"The id of the worker.","examples":["wrk_1234"]},"position":{"type":"string","examples":["Research Engineer"]},"type":{"type":"string","enum":["employee","contractor"]},"status":{"type":"string","enum":["draft","invited","onboarding","active","offboarding","inactive"]},"benefitEligible":{"type":"boolean","allOf":[{"description":"The worker's stored benefits eligibility flag.","examples":[true,false]}]},"startDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","allOf":[{"description":"The worker's employment start date. Reactivation after an offboarding is reported separately in latestRehireDate.","examples":["2022-04-11"]}]},"endDate":{"anyOf":[{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},{"type":"null"}],"allOf":[{"description":"The worker's final day of employment, or null when employment is ongoing.","examples":["2026-08-15",null]}]},"isBusiness":{"anyOf":[{"type":"boolean"},{"type":"null"}],"examples":[false]},"businessName":{"anyOf":[{"type":"string"},{"type":"null"}],"examples":[null,"Galt Enterprises, LLC"]},"firstName":{"type":"string","examples":["Jonathan","Melissa"]},"lastName":{"type":"string","examples":["Galt","Jones"]},"email":{"type":"string","format":"email","title":"Email","description":"An email with a reasonably valid regex (based on RFC 5321 atext characters)","examples":["john@joinwarp.com"]},"workEmail":{"anyOf":[{"type":"string","format":"email","title":"Email","description":"An email with a reasonably valid regex (based on RFC 5321 atext characters)","examples":["john@joinwarp.com"]},{"type":"null"}]},"preferredName":{"anyOf":[{"type":"string","examples":["John"]},{"type":"null"}]},"biologicalSex":{"anyOf":[{"type":"string","enum":["male","female"]},{"type":"null"}],"description":"The worker's biological sex, or null when unavailable.","examples":["female"]},"maritalStatus":{"anyOf":[{"type":"string","enum":["married","not_married"]},{"type":"null"}],"description":"The worker's marital status, or null when unavailable.","examples":["married"]},"dateOfBirth":{"anyOf":[{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},{"type":"null"}],"description":"The worker's date of birth, or null when unavailable.","examples":["1990-06-15"]},"phone":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The worker's personal phone number, or null when unavailable.","examples":["+12025550143"]},"address":{"anyOf":[{"$ref":"#/components/schemas/PublicWorkerAddress"},{"type":"null"}],"description":"The worker's home address, or null when unavailable.","examples":[{"line1":"123 Example Street","line2":"Suite 400","city":"New York","state":"NY","postalCode":"10001","country":"US"}]},"displayName":{"type":"string","description":"The \"ui\" name of a worker. If it's a business contractor business name is used. Otherwise we default to preferred name, then first-last.","examples":["Jack Galt"]},"manager":{"anyOf":[{"$ref":"#/components/schemas/PublicWorkerManager"},{"type":"null"}],"description":"The worker's manager, or null if unassigned.","examples":[{"id":"wrk_3Fna7qP2mL8z","firstName":"Hank","lastName":"Rearden","displayName":"Hank Rearden"},null]},"timeZone":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The IANA timezone of the worker (e.g., America/New_York).","examples":["America/New_York"]},"tShirtSize":{"anyOf":[{"type":"string","enum":["XS","S","M","L","XL","XXL","XXXL"]},{"type":"null"}],"description":"The worker's stored T-shirt size, or null when unset or unavailable.","examples":["M",null]},"department":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","pattern":"^dpt_","description":"The unique public id of the department","examples":["dpt_1234"]},"name":{"type":"string"}},"required":["id","name"],"additionalProperties":false},{"type":"null"}],"description":"The department the worker belongs to, or null if unassigned.","examples":[{"id":"dpt_7Rqa2mP9xK4c","name":"Engineering"},null]},"primaryWorkplace":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","pattern":"^wkp_","description":"Public workplace identifier","examples":["wkp_1234"]},"name":{"type":"string"},"type":{"type":"string","enum":["remote","office"]}},"required":["id","name","type"],"additionalProperties":false},{"type":"null"}],"description":"The primary workplace the worker is assigned to, or null if unassigned.","examples":[{"id":"wkp_4Nva8qT2mL7z","name":"New York Office","type":"office"},null]},"latestRehireDate":{"anyOf":[{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},{"type":"null"}],"description":"The date the worker was most recently reactivated after an offboarding. This is distinct from startDate and is null if the worker has not been rehired.","examples":["2024-02-05",null]},"terminationReason":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The reason the worker was terminated, or null when no termination reason is recorded.","examples":["Position eliminated",null]},"updatedAt":{"type":"string","examples":["2026-08-20T14:30:00.000Z"]},"level":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","pattern":"^jlvl_","description":"The unique public id of the job level","examples":["jlvl_1234"]},"code":{"type":"string"},"name":{"type":"string"},"track":{"type":"string","enum":["ic","manager","executive"]}},"required":["id","code","name","track"],"additionalProperties":false},{"type":"null"}],"description":"The worker's assigned job level, or null if unassigned. Omitted when job levels are not enabled."},"compensation":{"anyOf":[{"$ref":"#/components/schemas/PublicWorkerCompensation"},{"type":"null"}],"description":"The worker's current regular compensation, or the rate effective on a future start date. Null when the worker has no applicable regular pay rate or the API key lacks the corresponding compensation read scope.","examples":[{"payRateId":"pyr_9Cka3pR8vM2x","per":"year","amount":15000000,"currency":"USD","display":"$150,000.00 / yr"},null]},"customFields":{"anyOf":[{"type":"array","items":{"$ref":"#/components/schemas/PublicWorkerCustomField"},"description":"The worker's custom field values. Every active company custom field appears; fields outside this API key's permission scopes are redacted (value null, redacted true) rather than omitted, so the list is identical across keys. Empty when the company has no custom fields.","examples":[[]]},{"type":"null"}]}},"required":["id","position","type","status","benefitEligible","startDate","endDate","isBusiness","businessName","firstName","lastName","email","workEmail","preferredName","biologicalSex","maritalStatus","dateOfBirth","phone","address","displayName","timeZone","department","primaryWorkplace","latestRehireDate","terminationReason","updatedAt","compensation"],"additionalProperties":false,"description":"A worker profile, including lifecycle, workplace, profile, and compensation fields.","examples":[{"id":"wrk_khac8380c2Lm","position":"Research Engineer","type":"employee","status":"active","benefitEligible":true,"startDate":"2022-04-11","endDate":null,"isBusiness":null,"businessName":null,"firstName":"Jane","lastName":"Doe","email":"jane.doe@example.com","workEmail":"jane.doe@acme.example","preferredName":"Jane","biologicalSex":"female","maritalStatus":"married","dateOfBirth":"1990-06-15","phone":"+12025550143","address":{"line1":"123 Example Street","line2":"Suite 400","city":"New York","state":"NY","postalCode":"10001","country":"US"},"displayName":"Jane Doe","manager":{"id":"wrk_3Fna7qP2mL8z","firstName":"Hank","lastName":"Rearden","displayName":"Hank Rearden"},"timeZone":"America/New_York","tShirtSize":"M","department":{"id":"dpt_7Rqa2mP9xK4c","name":"Engineering"},"primaryWorkplace":{"id":"wkp_4Nva8qT2mL7z","name":"New York Office","type":"office"},"latestRehireDate":"2024-02-05","terminationReason":null,"updatedAt":"2026-08-20T14:30:00.000Z","compensation":{"payRateId":"pyr_9Cka3pR8vM2x","per":"year","amount":15000000,"currency":"USD","display":"$150,000.00 / yr"},"customFields":[]}]}},"required":["id","type","timestamp","data"],"additionalProperties":false}}}},"responses":{"200":{"description":"Return any 2xx status code to acknowledge receipt. Non-2xx responses or timeouts are retried with exponential backoff."}}}},"worker.reactivated":{"post":{"tags":["Workers"],"summary":"Worker Reactivated","description":"Sent when a previously offboarded worker is reactivated.","parameters":[{"name":"webhook-id","in":"header","required":true,"description":"Unique identifier for this message. Stable across retries and manual resends — use it as your idempotency key.","schema":{"type":"string","examples":["tor_abc123:550e8400-e29b-41d4-a716-446655440000"]}},{"name":"webhook-timestamp","in":"header","required":true,"description":"Unix timestamp in seconds for this delivery attempt. Recomputed on every attempt — reject deliveries whose timestamp is outside your tolerance window to guard against replay.","schema":{"type":"string","examples":["1752580800"]}},{"name":"webhook-signature","in":"header","required":true,"description":"Space-separated list of signatures over `{webhook-id}.{webhook-timestamp}.{body}`, each formatted `v1,<base64>` where `v1` is HMAC-SHA256 with your signing secret. During a secret rotation the list carries one signature per live secret; a match on any one is valid.","schema":{"type":"string","examples":["v1,g0hM9SsE+OTPJTGt/tmIKtSyZlE3uFJELVlNIOLJ1OE="]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Unique event identifier (format: `<objectTag>:<uuid>`). Stable across retries.","examples":["tor_abc123:550e8400-e29b-41d4-a716-446655440000"]},"type":{"type":"string","enum":["worker.reactivated"],"description":"The event type."},"timestamp":{"type":"string","description":"ISO 8601 timestamp of when the event occurred. Unchanged across retries.","examples":["2026-07-15T12:00:00.000Z"]},"data":{"type":"object","properties":{"id":{"type":"string","pattern":"^wrk_","description":"The id of the worker.","examples":["wrk_1234"]},"position":{"type":"string","examples":["Research Engineer"]},"type":{"type":"string","enum":["employee","contractor"]},"status":{"type":"string","enum":["draft","invited","onboarding","active","offboarding","inactive"]},"benefitEligible":{"type":"boolean","allOf":[{"description":"The worker's stored benefits eligibility flag.","examples":[true,false]}]},"startDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","allOf":[{"description":"The worker's employment start date. Reactivation after an offboarding is reported separately in latestRehireDate.","examples":["2022-04-11"]}]},"endDate":{"anyOf":[{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},{"type":"null"}],"allOf":[{"description":"The worker's final day of employment, or null when employment is ongoing.","examples":["2026-08-15",null]}]},"isBusiness":{"anyOf":[{"type":"boolean"},{"type":"null"}],"examples":[false]},"businessName":{"anyOf":[{"type":"string"},{"type":"null"}],"examples":[null,"Galt Enterprises, LLC"]},"firstName":{"type":"string","examples":["Jonathan","Melissa"]},"lastName":{"type":"string","examples":["Galt","Jones"]},"email":{"type":"string","format":"email","title":"Email","description":"An email with a reasonably valid regex (based on RFC 5321 atext characters)","examples":["john@joinwarp.com"]},"workEmail":{"anyOf":[{"type":"string","format":"email","title":"Email","description":"An email with a reasonably valid regex (based on RFC 5321 atext characters)","examples":["john@joinwarp.com"]},{"type":"null"}]},"preferredName":{"anyOf":[{"type":"string","examples":["John"]},{"type":"null"}]},"biologicalSex":{"anyOf":[{"type":"string","enum":["male","female"]},{"type":"null"}],"description":"The worker's biological sex, or null when unavailable.","examples":["female"]},"maritalStatus":{"anyOf":[{"type":"string","enum":["married","not_married"]},{"type":"null"}],"description":"The worker's marital status, or null when unavailable.","examples":["married"]},"dateOfBirth":{"anyOf":[{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},{"type":"null"}],"description":"The worker's date of birth, or null when unavailable.","examples":["1990-06-15"]},"phone":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The worker's personal phone number, or null when unavailable.","examples":["+12025550143"]},"address":{"anyOf":[{"$ref":"#/components/schemas/PublicWorkerAddress"},{"type":"null"}],"description":"The worker's home address, or null when unavailable.","examples":[{"line1":"123 Example Street","line2":"Suite 400","city":"New York","state":"NY","postalCode":"10001","country":"US"}]},"displayName":{"type":"string","description":"The \"ui\" name of a worker. If it's a business contractor business name is used. Otherwise we default to preferred name, then first-last.","examples":["Jack Galt"]},"manager":{"anyOf":[{"$ref":"#/components/schemas/PublicWorkerManager"},{"type":"null"}],"description":"The worker's manager, or null if unassigned.","examples":[{"id":"wrk_3Fna7qP2mL8z","firstName":"Hank","lastName":"Rearden","displayName":"Hank Rearden"},null]},"timeZone":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The IANA timezone of the worker (e.g., America/New_York).","examples":["America/New_York"]},"tShirtSize":{"anyOf":[{"type":"string","enum":["XS","S","M","L","XL","XXL","XXXL"]},{"type":"null"}],"description":"The worker's stored T-shirt size, or null when unset or unavailable.","examples":["M",null]},"department":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","pattern":"^dpt_","description":"The unique public id of the department","examples":["dpt_1234"]},"name":{"type":"string"}},"required":["id","name"],"additionalProperties":false},{"type":"null"}],"description":"The department the worker belongs to, or null if unassigned.","examples":[{"id":"dpt_7Rqa2mP9xK4c","name":"Engineering"},null]},"primaryWorkplace":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","pattern":"^wkp_","description":"Public workplace identifier","examples":["wkp_1234"]},"name":{"type":"string"},"type":{"type":"string","enum":["remote","office"]}},"required":["id","name","type"],"additionalProperties":false},{"type":"null"}],"description":"The primary workplace the worker is assigned to, or null if unassigned.","examples":[{"id":"wkp_4Nva8qT2mL7z","name":"New York Office","type":"office"},null]},"latestRehireDate":{"anyOf":[{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},{"type":"null"}],"description":"The date the worker was most recently reactivated after an offboarding. This is distinct from startDate and is null if the worker has not been rehired.","examples":["2024-02-05",null]},"terminationReason":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The reason the worker was terminated, or null when no termination reason is recorded.","examples":["Position eliminated",null]},"updatedAt":{"type":"string","examples":["2026-08-20T14:30:00.000Z"]},"level":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","pattern":"^jlvl_","description":"The unique public id of the job level","examples":["jlvl_1234"]},"code":{"type":"string"},"name":{"type":"string"},"track":{"type":"string","enum":["ic","manager","executive"]}},"required":["id","code","name","track"],"additionalProperties":false},{"type":"null"}],"description":"The worker's assigned job level, or null if unassigned. Omitted when job levels are not enabled."},"compensation":{"anyOf":[{"$ref":"#/components/schemas/PublicWorkerCompensation"},{"type":"null"}],"description":"The worker's current regular compensation, or the rate effective on a future start date. Null when the worker has no applicable regular pay rate or the API key lacks the corresponding compensation read scope.","examples":[{"payRateId":"pyr_9Cka3pR8vM2x","per":"year","amount":15000000,"currency":"USD","display":"$150,000.00 / yr"},null]},"customFields":{"anyOf":[{"type":"array","items":{"$ref":"#/components/schemas/PublicWorkerCustomField"},"description":"The worker's custom field values. Every active company custom field appears; fields outside this API key's permission scopes are redacted (value null, redacted true) rather than omitted, so the list is identical across keys. Empty when the company has no custom fields.","examples":[[]]},{"type":"null"}]}},"required":["id","position","type","status","benefitEligible","startDate","endDate","isBusiness","businessName","firstName","lastName","email","workEmail","preferredName","biologicalSex","maritalStatus","dateOfBirth","phone","address","displayName","timeZone","department","primaryWorkplace","latestRehireDate","terminationReason","updatedAt","compensation"],"additionalProperties":false,"description":"A worker profile, including lifecycle, workplace, profile, and compensation fields.","examples":[{"id":"wrk_khac8380c2Lm","position":"Research Engineer","type":"employee","status":"active","benefitEligible":true,"startDate":"2022-04-11","endDate":null,"isBusiness":null,"businessName":null,"firstName":"Jane","lastName":"Doe","email":"jane.doe@example.com","workEmail":"jane.doe@acme.example","preferredName":"Jane","biologicalSex":"female","maritalStatus":"married","dateOfBirth":"1990-06-15","phone":"+12025550143","address":{"line1":"123 Example Street","line2":"Suite 400","city":"New York","state":"NY","postalCode":"10001","country":"US"},"displayName":"Jane Doe","manager":{"id":"wrk_3Fna7qP2mL8z","firstName":"Hank","lastName":"Rearden","displayName":"Hank Rearden"},"timeZone":"America/New_York","tShirtSize":"M","department":{"id":"dpt_7Rqa2mP9xK4c","name":"Engineering"},"primaryWorkplace":{"id":"wkp_4Nva8qT2mL7z","name":"New York Office","type":"office"},"latestRehireDate":"2024-02-05","terminationReason":null,"updatedAt":"2026-08-20T14:30:00.000Z","compensation":{"payRateId":"pyr_9Cka3pR8vM2x","per":"year","amount":15000000,"currency":"USD","display":"$150,000.00 / yr"},"customFields":[]}]}},"required":["id","type","timestamp","data"],"additionalProperties":false}}}},"responses":{"200":{"description":"Return any 2xx status code to acknowledge receipt. Non-2xx responses or timeouts are retried with exponential backoff."}}}},"offer.created":{"post":{"tags":["Offers"],"summary":"Offer Created","description":"Sent when an offer is created.","parameters":[{"name":"webhook-id","in":"header","required":true,"description":"Unique identifier for this message. Stable across retries and manual resends — use it as your idempotency key.","schema":{"type":"string","examples":["tor_abc123:550e8400-e29b-41d4-a716-446655440000"]}},{"name":"webhook-timestamp","in":"header","required":true,"description":"Unix timestamp in seconds for this delivery attempt. Recomputed on every attempt — reject deliveries whose timestamp is outside your tolerance window to guard against replay.","schema":{"type":"string","examples":["1752580800"]}},{"name":"webhook-signature","in":"header","required":true,"description":"Space-separated list of signatures over `{webhook-id}.{webhook-timestamp}.{body}`, each formatted `v1,<base64>` where `v1` is HMAC-SHA256 with your signing secret. During a secret rotation the list carries one signature per live secret; a match on any one is valid.","schema":{"type":"string","examples":["v1,g0hM9SsE+OTPJTGt/tmIKtSyZlE3uFJELVlNIOLJ1OE="]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Unique event identifier (format: `<objectTag>:<uuid>`). Stable across retries.","examples":["tor_abc123:550e8400-e29b-41d4-a716-446655440000"]},"type":{"type":"string","enum":["offer.created"],"description":"The event type."},"timestamp":{"type":"string","description":"ISO 8601 timestamp of when the event occurred. Unchanged across retries.","examples":["2026-07-15T12:00:00.000Z"]},"data":{"type":"object","properties":{"id":{"type":"string","pattern":"^offr_","description":"The tag of the offer.","examples":["offr_1234"]},"status":{"type":"string","enum":["draft","sent","accepted","void","expired"]},"voidReason":{"anyOf":[{"anyOf":[{"type":"string","enum":["replaced","candidate_declined","other"]},{"type":"null"}]},{"type":"null"}],"description":"The reason the offer was voided. Null for offers that have not been voided."},"voidNotes":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"null"}]},{"type":"null"}],"description":"Additional notes explaining why the offer was voided."},"workerType":{"type":"string","enum":["employee","us_contractor","global_contractor"]},"candidate":{"type":"object","properties":{"firstName":{"type":"string","examples":["Jonathan"]},"lastName":{"type":"string","examples":["Galt"]},"email":{"type":"string","format":"email","title":"Email","description":"An email with a reasonably valid regex (based on RFC 5321 atext characters)","examples":["john@joinwarp.com"]},"contractorDetails":{"anyOf":[{"type":"object","properties":{"isBusiness":{"type":"boolean"},"legalBusinessName":{"anyOf":[{"type":"string"},{"type":"null"}],"examples":[null,"Galt Enterprises, LLC"]}},"required":["isBusiness","legalBusinessName"],"additionalProperties":false},{"type":"null"}]}},"required":["firstName","lastName","email","contractorDetails"],"additionalProperties":false},"position":{"type":"object","properties":{"title":{"type":"string","examples":["Research Engineer"]},"startDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"country":{"type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"scopeOfWork":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["title","startDate","country","scopeOfWork"],"additionalProperties":false},"department":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","pattern":"^dpt_","description":"The unique public id of the department","examples":["dpt_1234"]},"name":{"type":"string","examples":["Engineering"]}},"required":["id","name"],"additionalProperties":false},{"type":"null"}]},"workplace":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","pattern":"^wkp_","description":"Public workplace identifier","examples":["wkp_1234"]},"name":{"type":"string","examples":["New York Office"]}},"required":["id","name"],"additionalProperties":false},{"type":"null"}]},"manager":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","pattern":"^wrk_","description":"The id of the worker.","examples":["wrk_1234"]},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"examples":[null,"Dagny Taggart"]}},"required":["id","name"],"additionalProperties":false},{"type":"null"}]},"level":{"anyOf":[{"anyOf":[{"type":"object","properties":{"id":{"type":"string","pattern":"^jlvl_","description":"The unique public id of the job level","examples":["jlvl_1234"]},"code":{"type":"string"},"name":{"type":"string"},"track":{"type":"string","enum":["ic","manager","executive"]}},"required":["id","code","name","track"],"additionalProperties":false},{"type":"null"}]},{"type":"null"}],"description":"The offer's job level, or null if unassigned. Omitted when job levels are not enabled."},"sentBy":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Display name of the person or company that sent the offer. Null for offers not yet sent.","examples":[null,"Dagny Taggart","Galt Enterprises, LLC"]},"compensation":{"type":"object","properties":{"basePay":{"type":"object","properties":{"amount":{"$ref":"#/components/schemas/PublicMoneyAmount"},"basis":{"type":"string","enum":["year","month","week","hour","variable"]},"type":{"anyOf":[{"type":"string","enum":["fixed","pay_as_you_go"]},{"type":"null"}]},"variableRate":{"anyOf":[{"$ref":"#/components/schemas/PublicMoneyAmount"},{"type":"null"}]}},"required":["amount","basis","type","variableRate"],"additionalProperties":false},"signOnBonus":{"anyOf":[{"$ref":"#/components/schemas/PublicMoneyAmount"},{"type":"null"}]},"relocationBonus":{"anyOf":[{"$ref":"#/components/schemas/PublicMoneyAmount"},{"type":"null"}]},"stock":{"anyOf":[{"type":"object","properties":{"options":{"type":"integer","minimum":0},"vestingScheduleMonths":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}]},"cliffMonths":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}]}},"required":["options","vestingScheduleMonths","cliffMonths"],"additionalProperties":false},{"type":"null"}]}},"required":["basePay","signOnBonus","relocationBonus","stock"],"additionalProperties":false},"offerUrl":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The candidate-facing offer portal URL. Null for offers that have not been sent."},"expirationTime":{"anyOf":[{"type":"string"},{"type":"null"}]},"lastViewedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"createdAt":{"type":"string"}},"required":["id","status","workerType","candidate","position","department","workplace","manager","sentBy","compensation","offerUrl","expirationTime","lastViewedAt","createdAt"],"additionalProperties":false}},"required":["id","type","timestamp","data"],"additionalProperties":false}}}},"responses":{"200":{"description":"Return any 2xx status code to acknowledge receipt. Non-2xx responses or timeouts are retried with exponential backoff."}}}},"offer.signature_requested":{"post":{"tags":["Offers"],"summary":"Offer Signature Requested","description":"Sent when a designated employer signer is asked to directly sign a draft offer.","parameters":[{"name":"webhook-id","in":"header","required":true,"description":"Unique identifier for this message. Stable across retries and manual resends — use it as your idempotency key.","schema":{"type":"string","examples":["tor_abc123:550e8400-e29b-41d4-a716-446655440000"]}},{"name":"webhook-timestamp","in":"header","required":true,"description":"Unix timestamp in seconds for this delivery attempt. Recomputed on every attempt — reject deliveries whose timestamp is outside your tolerance window to guard against replay.","schema":{"type":"string","examples":["1752580800"]}},{"name":"webhook-signature","in":"header","required":true,"description":"Space-separated list of signatures over `{webhook-id}.{webhook-timestamp}.{body}`, each formatted `v1,<base64>` where `v1` is HMAC-SHA256 with your signing secret. During a secret rotation the list carries one signature per live secret; a match on any one is valid.","schema":{"type":"string","examples":["v1,g0hM9SsE+OTPJTGt/tmIKtSyZlE3uFJELVlNIOLJ1OE="]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Unique event identifier (format: `<objectTag>:<uuid>`). Stable across retries.","examples":["tor_abc123:550e8400-e29b-41d4-a716-446655440000"]},"type":{"type":"string","enum":["offer.signature_requested"],"description":"The event type."},"timestamp":{"type":"string","description":"ISO 8601 timestamp of when the event occurred. Unchanged across retries.","examples":["2026-07-15T12:00:00.000Z"]},"data":{"type":"object","properties":{"id":{"type":"string","pattern":"^offr_","description":"The tag of the offer.","examples":["offr_1234"]},"status":{"type":"string","enum":["draft","sent","accepted","void","expired"]},"voidReason":{"anyOf":[{"anyOf":[{"type":"string","enum":["replaced","candidate_declined","other"]},{"type":"null"}]},{"type":"null"}],"description":"The reason the offer was voided. Null for offers that have not been voided."},"voidNotes":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"null"}]},{"type":"null"}],"description":"Additional notes explaining why the offer was voided."},"workerType":{"type":"string","enum":["employee","us_contractor","global_contractor"]},"candidate":{"type":"object","properties":{"firstName":{"type":"string","examples":["Jonathan"]},"lastName":{"type":"string","examples":["Galt"]},"email":{"type":"string","format":"email","title":"Email","description":"An email with a reasonably valid regex (based on RFC 5321 atext characters)","examples":["john@joinwarp.com"]},"contractorDetails":{"anyOf":[{"type":"object","properties":{"isBusiness":{"type":"boolean"},"legalBusinessName":{"anyOf":[{"type":"string"},{"type":"null"}],"examples":[null,"Galt Enterprises, LLC"]}},"required":["isBusiness","legalBusinessName"],"additionalProperties":false},{"type":"null"}]}},"required":["firstName","lastName","email","contractorDetails"],"additionalProperties":false},"position":{"type":"object","properties":{"title":{"type":"string","examples":["Research Engineer"]},"startDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"country":{"type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"scopeOfWork":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["title","startDate","country","scopeOfWork"],"additionalProperties":false},"department":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","pattern":"^dpt_","description":"The unique public id of the department","examples":["dpt_1234"]},"name":{"type":"string","examples":["Engineering"]}},"required":["id","name"],"additionalProperties":false},{"type":"null"}]},"workplace":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","pattern":"^wkp_","description":"Public workplace identifier","examples":["wkp_1234"]},"name":{"type":"string","examples":["New York Office"]}},"required":["id","name"],"additionalProperties":false},{"type":"null"}]},"manager":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","pattern":"^wrk_","description":"The id of the worker.","examples":["wrk_1234"]},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"examples":[null,"Dagny Taggart"]}},"required":["id","name"],"additionalProperties":false},{"type":"null"}]},"level":{"anyOf":[{"anyOf":[{"type":"object","properties":{"id":{"type":"string","pattern":"^jlvl_","description":"The unique public id of the job level","examples":["jlvl_1234"]},"code":{"type":"string"},"name":{"type":"string"},"track":{"type":"string","enum":["ic","manager","executive"]}},"required":["id","code","name","track"],"additionalProperties":false},{"type":"null"}]},{"type":"null"}],"description":"The offer's job level, or null if unassigned. Omitted when job levels are not enabled."},"sentBy":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Display name of the person or company that sent the offer. Null for offers not yet sent.","examples":[null,"Dagny Taggart","Galt Enterprises, LLC"]},"compensation":{"type":"object","properties":{"basePay":{"type":"object","properties":{"amount":{"$ref":"#/components/schemas/PublicMoneyAmount"},"basis":{"type":"string","enum":["year","month","week","hour","variable"]},"type":{"anyOf":[{"type":"string","enum":["fixed","pay_as_you_go"]},{"type":"null"}]},"variableRate":{"anyOf":[{"$ref":"#/components/schemas/PublicMoneyAmount"},{"type":"null"}]}},"required":["amount","basis","type","variableRate"],"additionalProperties":false},"signOnBonus":{"anyOf":[{"$ref":"#/components/schemas/PublicMoneyAmount"},{"type":"null"}]},"relocationBonus":{"anyOf":[{"$ref":"#/components/schemas/PublicMoneyAmount"},{"type":"null"}]},"stock":{"anyOf":[{"type":"object","properties":{"options":{"type":"integer","minimum":0},"vestingScheduleMonths":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}]},"cliffMonths":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}]}},"required":["options","vestingScheduleMonths","cliffMonths"],"additionalProperties":false},{"type":"null"}]}},"required":["basePay","signOnBonus","relocationBonus","stock"],"additionalProperties":false},"offerUrl":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The candidate-facing offer portal URL. Null for offers that have not been sent."},"expirationTime":{"anyOf":[{"type":"string"},{"type":"null"}]},"lastViewedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"createdAt":{"type":"string"}},"required":["id","status","workerType","candidate","position","department","workplace","manager","sentBy","compensation","offerUrl","expirationTime","lastViewedAt","createdAt"],"additionalProperties":false}},"required":["id","type","timestamp","data"],"additionalProperties":false}}}},"responses":{"200":{"description":"Return any 2xx status code to acknowledge receipt. Non-2xx responses or timeouts are retried with exponential backoff."}}}},"offer.sent":{"post":{"tags":["Offers"],"summary":"Offer Sent","description":"Sent when an offer is delivered to a candidate.","parameters":[{"name":"webhook-id","in":"header","required":true,"description":"Unique identifier for this message. Stable across retries and manual resends — use it as your idempotency key.","schema":{"type":"string","examples":["tor_abc123:550e8400-e29b-41d4-a716-446655440000"]}},{"name":"webhook-timestamp","in":"header","required":true,"description":"Unix timestamp in seconds for this delivery attempt. Recomputed on every attempt — reject deliveries whose timestamp is outside your tolerance window to guard against replay.","schema":{"type":"string","examples":["1752580800"]}},{"name":"webhook-signature","in":"header","required":true,"description":"Space-separated list of signatures over `{webhook-id}.{webhook-timestamp}.{body}`, each formatted `v1,<base64>` where `v1` is HMAC-SHA256 with your signing secret. During a secret rotation the list carries one signature per live secret; a match on any one is valid.","schema":{"type":"string","examples":["v1,g0hM9SsE+OTPJTGt/tmIKtSyZlE3uFJELVlNIOLJ1OE="]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Unique event identifier (format: `<objectTag>:<uuid>`). Stable across retries.","examples":["tor_abc123:550e8400-e29b-41d4-a716-446655440000"]},"type":{"type":"string","enum":["offer.sent"],"description":"The event type."},"timestamp":{"type":"string","description":"ISO 8601 timestamp of when the event occurred. Unchanged across retries.","examples":["2026-07-15T12:00:00.000Z"]},"data":{"type":"object","properties":{"id":{"type":"string","pattern":"^offr_","description":"The tag of the offer.","examples":["offr_1234"]},"status":{"type":"string","enum":["draft","sent","accepted","void","expired"]},"voidReason":{"anyOf":[{"anyOf":[{"type":"string","enum":["replaced","candidate_declined","other"]},{"type":"null"}]},{"type":"null"}],"description":"The reason the offer was voided. Null for offers that have not been voided."},"voidNotes":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"null"}]},{"type":"null"}],"description":"Additional notes explaining why the offer was voided."},"workerType":{"type":"string","enum":["employee","us_contractor","global_contractor"]},"candidate":{"type":"object","properties":{"firstName":{"type":"string","examples":["Jonathan"]},"lastName":{"type":"string","examples":["Galt"]},"email":{"type":"string","format":"email","title":"Email","description":"An email with a reasonably valid regex (based on RFC 5321 atext characters)","examples":["john@joinwarp.com"]},"contractorDetails":{"anyOf":[{"type":"object","properties":{"isBusiness":{"type":"boolean"},"legalBusinessName":{"anyOf":[{"type":"string"},{"type":"null"}],"examples":[null,"Galt Enterprises, LLC"]}},"required":["isBusiness","legalBusinessName"],"additionalProperties":false},{"type":"null"}]}},"required":["firstName","lastName","email","contractorDetails"],"additionalProperties":false},"position":{"type":"object","properties":{"title":{"type":"string","examples":["Research Engineer"]},"startDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"country":{"type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"scopeOfWork":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["title","startDate","country","scopeOfWork"],"additionalProperties":false},"department":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","pattern":"^dpt_","description":"The unique public id of the department","examples":["dpt_1234"]},"name":{"type":"string","examples":["Engineering"]}},"required":["id","name"],"additionalProperties":false},{"type":"null"}]},"workplace":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","pattern":"^wkp_","description":"Public workplace identifier","examples":["wkp_1234"]},"name":{"type":"string","examples":["New York Office"]}},"required":["id","name"],"additionalProperties":false},{"type":"null"}]},"manager":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","pattern":"^wrk_","description":"The id of the worker.","examples":["wrk_1234"]},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"examples":[null,"Dagny Taggart"]}},"required":["id","name"],"additionalProperties":false},{"type":"null"}]},"level":{"anyOf":[{"anyOf":[{"type":"object","properties":{"id":{"type":"string","pattern":"^jlvl_","description":"The unique public id of the job level","examples":["jlvl_1234"]},"code":{"type":"string"},"name":{"type":"string"},"track":{"type":"string","enum":["ic","manager","executive"]}},"required":["id","code","name","track"],"additionalProperties":false},{"type":"null"}]},{"type":"null"}],"description":"The offer's job level, or null if unassigned. Omitted when job levels are not enabled."},"sentBy":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Display name of the person or company that sent the offer. Null for offers not yet sent.","examples":[null,"Dagny Taggart","Galt Enterprises, LLC"]},"compensation":{"type":"object","properties":{"basePay":{"type":"object","properties":{"amount":{"$ref":"#/components/schemas/PublicMoneyAmount"},"basis":{"type":"string","enum":["year","month","week","hour","variable"]},"type":{"anyOf":[{"type":"string","enum":["fixed","pay_as_you_go"]},{"type":"null"}]},"variableRate":{"anyOf":[{"$ref":"#/components/schemas/PublicMoneyAmount"},{"type":"null"}]}},"required":["amount","basis","type","variableRate"],"additionalProperties":false},"signOnBonus":{"anyOf":[{"$ref":"#/components/schemas/PublicMoneyAmount"},{"type":"null"}]},"relocationBonus":{"anyOf":[{"$ref":"#/components/schemas/PublicMoneyAmount"},{"type":"null"}]},"stock":{"anyOf":[{"type":"object","properties":{"options":{"type":"integer","minimum":0},"vestingScheduleMonths":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}]},"cliffMonths":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}]}},"required":["options","vestingScheduleMonths","cliffMonths"],"additionalProperties":false},{"type":"null"}]}},"required":["basePay","signOnBonus","relocationBonus","stock"],"additionalProperties":false},"offerUrl":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The candidate-facing offer portal URL. Null for offers that have not been sent."},"expirationTime":{"anyOf":[{"type":"string"},{"type":"null"}]},"lastViewedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"createdAt":{"type":"string"}},"required":["id","status","workerType","candidate","position","department","workplace","manager","sentBy","compensation","offerUrl","expirationTime","lastViewedAt","createdAt"],"additionalProperties":false}},"required":["id","type","timestamp","data"],"additionalProperties":false}}}},"responses":{"200":{"description":"Return any 2xx status code to acknowledge receipt. Non-2xx responses or timeouts are retried with exponential backoff."}}}},"offer.viewed":{"post":{"tags":["Offers"],"summary":"Offer Viewed","description":"Sent when a candidate views their offer.","parameters":[{"name":"webhook-id","in":"header","required":true,"description":"Unique identifier for this message. Stable across retries and manual resends — use it as your idempotency key.","schema":{"type":"string","examples":["tor_abc123:550e8400-e29b-41d4-a716-446655440000"]}},{"name":"webhook-timestamp","in":"header","required":true,"description":"Unix timestamp in seconds for this delivery attempt. Recomputed on every attempt — reject deliveries whose timestamp is outside your tolerance window to guard against replay.","schema":{"type":"string","examples":["1752580800"]}},{"name":"webhook-signature","in":"header","required":true,"description":"Space-separated list of signatures over `{webhook-id}.{webhook-timestamp}.{body}`, each formatted `v1,<base64>` where `v1` is HMAC-SHA256 with your signing secret. During a secret rotation the list carries one signature per live secret; a match on any one is valid.","schema":{"type":"string","examples":["v1,g0hM9SsE+OTPJTGt/tmIKtSyZlE3uFJELVlNIOLJ1OE="]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Unique event identifier (format: `<objectTag>:<uuid>`). Stable across retries.","examples":["tor_abc123:550e8400-e29b-41d4-a716-446655440000"]},"type":{"type":"string","enum":["offer.viewed"],"description":"The event type."},"timestamp":{"type":"string","description":"ISO 8601 timestamp of when the event occurred. Unchanged across retries.","examples":["2026-07-15T12:00:00.000Z"]},"data":{"type":"object","properties":{"id":{"type":"string","pattern":"^offr_","description":"The tag of the offer.","examples":["offr_1234"]},"status":{"type":"string","enum":["draft","sent","accepted","void","expired"]},"voidReason":{"anyOf":[{"anyOf":[{"type":"string","enum":["replaced","candidate_declined","other"]},{"type":"null"}]},{"type":"null"}],"description":"The reason the offer was voided. Null for offers that have not been voided."},"voidNotes":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"null"}]},{"type":"null"}],"description":"Additional notes explaining why the offer was voided."},"workerType":{"type":"string","enum":["employee","us_contractor","global_contractor"]},"candidate":{"type":"object","properties":{"firstName":{"type":"string","examples":["Jonathan"]},"lastName":{"type":"string","examples":["Galt"]},"email":{"type":"string","format":"email","title":"Email","description":"An email with a reasonably valid regex (based on RFC 5321 atext characters)","examples":["john@joinwarp.com"]},"contractorDetails":{"anyOf":[{"type":"object","properties":{"isBusiness":{"type":"boolean"},"legalBusinessName":{"anyOf":[{"type":"string"},{"type":"null"}],"examples":[null,"Galt Enterprises, LLC"]}},"required":["isBusiness","legalBusinessName"],"additionalProperties":false},{"type":"null"}]}},"required":["firstName","lastName","email","contractorDetails"],"additionalProperties":false},"position":{"type":"object","properties":{"title":{"type":"string","examples":["Research Engineer"]},"startDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"country":{"type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"scopeOfWork":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["title","startDate","country","scopeOfWork"],"additionalProperties":false},"department":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","pattern":"^dpt_","description":"The unique public id of the department","examples":["dpt_1234"]},"name":{"type":"string","examples":["Engineering"]}},"required":["id","name"],"additionalProperties":false},{"type":"null"}]},"workplace":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","pattern":"^wkp_","description":"Public workplace identifier","examples":["wkp_1234"]},"name":{"type":"string","examples":["New York Office"]}},"required":["id","name"],"additionalProperties":false},{"type":"null"}]},"manager":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","pattern":"^wrk_","description":"The id of the worker.","examples":["wrk_1234"]},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"examples":[null,"Dagny Taggart"]}},"required":["id","name"],"additionalProperties":false},{"type":"null"}]},"level":{"anyOf":[{"anyOf":[{"type":"object","properties":{"id":{"type":"string","pattern":"^jlvl_","description":"The unique public id of the job level","examples":["jlvl_1234"]},"code":{"type":"string"},"name":{"type":"string"},"track":{"type":"string","enum":["ic","manager","executive"]}},"required":["id","code","name","track"],"additionalProperties":false},{"type":"null"}]},{"type":"null"}],"description":"The offer's job level, or null if unassigned. Omitted when job levels are not enabled."},"sentBy":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Display name of the person or company that sent the offer. Null for offers not yet sent.","examples":[null,"Dagny Taggart","Galt Enterprises, LLC"]},"compensation":{"type":"object","properties":{"basePay":{"type":"object","properties":{"amount":{"$ref":"#/components/schemas/PublicMoneyAmount"},"basis":{"type":"string","enum":["year","month","week","hour","variable"]},"type":{"anyOf":[{"type":"string","enum":["fixed","pay_as_you_go"]},{"type":"null"}]},"variableRate":{"anyOf":[{"$ref":"#/components/schemas/PublicMoneyAmount"},{"type":"null"}]}},"required":["amount","basis","type","variableRate"],"additionalProperties":false},"signOnBonus":{"anyOf":[{"$ref":"#/components/schemas/PublicMoneyAmount"},{"type":"null"}]},"relocationBonus":{"anyOf":[{"$ref":"#/components/schemas/PublicMoneyAmount"},{"type":"null"}]},"stock":{"anyOf":[{"type":"object","properties":{"options":{"type":"integer","minimum":0},"vestingScheduleMonths":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}]},"cliffMonths":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}]}},"required":["options","vestingScheduleMonths","cliffMonths"],"additionalProperties":false},{"type":"null"}]}},"required":["basePay","signOnBonus","relocationBonus","stock"],"additionalProperties":false},"offerUrl":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The candidate-facing offer portal URL. Null for offers that have not been sent."},"expirationTime":{"anyOf":[{"type":"string"},{"type":"null"}]},"lastViewedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"createdAt":{"type":"string"}},"required":["id","status","workerType","candidate","position","department","workplace","manager","sentBy","compensation","offerUrl","expirationTime","lastViewedAt","createdAt"],"additionalProperties":false}},"required":["id","type","timestamp","data"],"additionalProperties":false}}}},"responses":{"200":{"description":"Return any 2xx status code to acknowledge receipt. Non-2xx responses or timeouts are retried with exponential backoff."}}}},"offer.accepted":{"post":{"tags":["Offers"],"summary":"Offer Accepted","description":"Sent when a candidate accepts their offer.","parameters":[{"name":"webhook-id","in":"header","required":true,"description":"Unique identifier for this message. Stable across retries and manual resends — use it as your idempotency key.","schema":{"type":"string","examples":["tor_abc123:550e8400-e29b-41d4-a716-446655440000"]}},{"name":"webhook-timestamp","in":"header","required":true,"description":"Unix timestamp in seconds for this delivery attempt. Recomputed on every attempt — reject deliveries whose timestamp is outside your tolerance window to guard against replay.","schema":{"type":"string","examples":["1752580800"]}},{"name":"webhook-signature","in":"header","required":true,"description":"Space-separated list of signatures over `{webhook-id}.{webhook-timestamp}.{body}`, each formatted `v1,<base64>` where `v1` is HMAC-SHA256 with your signing secret. During a secret rotation the list carries one signature per live secret; a match on any one is valid.","schema":{"type":"string","examples":["v1,g0hM9SsE+OTPJTGt/tmIKtSyZlE3uFJELVlNIOLJ1OE="]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Unique event identifier (format: `<objectTag>:<uuid>`). Stable across retries.","examples":["tor_abc123:550e8400-e29b-41d4-a716-446655440000"]},"type":{"type":"string","enum":["offer.accepted"],"description":"The event type."},"timestamp":{"type":"string","description":"ISO 8601 timestamp of when the event occurred. Unchanged across retries.","examples":["2026-07-15T12:00:00.000Z"]},"data":{"type":"object","properties":{"id":{"type":"string","pattern":"^offr_","description":"The tag of the offer.","examples":["offr_1234"]},"status":{"type":"string","enum":["draft","sent","accepted","void","expired"]},"voidReason":{"anyOf":[{"anyOf":[{"type":"string","enum":["replaced","candidate_declined","other"]},{"type":"null"}]},{"type":"null"}],"description":"The reason the offer was voided. Null for offers that have not been voided."},"voidNotes":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"null"}]},{"type":"null"}],"description":"Additional notes explaining why the offer was voided."},"workerType":{"type":"string","enum":["employee","us_contractor","global_contractor"]},"candidate":{"type":"object","properties":{"firstName":{"type":"string","examples":["Jonathan"]},"lastName":{"type":"string","examples":["Galt"]},"email":{"type":"string","format":"email","title":"Email","description":"An email with a reasonably valid regex (based on RFC 5321 atext characters)","examples":["john@joinwarp.com"]},"contractorDetails":{"anyOf":[{"type":"object","properties":{"isBusiness":{"type":"boolean"},"legalBusinessName":{"anyOf":[{"type":"string"},{"type":"null"}],"examples":[null,"Galt Enterprises, LLC"]}},"required":["isBusiness","legalBusinessName"],"additionalProperties":false},{"type":"null"}]}},"required":["firstName","lastName","email","contractorDetails"],"additionalProperties":false},"position":{"type":"object","properties":{"title":{"type":"string","examples":["Research Engineer"]},"startDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"country":{"type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"scopeOfWork":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["title","startDate","country","scopeOfWork"],"additionalProperties":false},"department":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","pattern":"^dpt_","description":"The unique public id of the department","examples":["dpt_1234"]},"name":{"type":"string","examples":["Engineering"]}},"required":["id","name"],"additionalProperties":false},{"type":"null"}]},"workplace":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","pattern":"^wkp_","description":"Public workplace identifier","examples":["wkp_1234"]},"name":{"type":"string","examples":["New York Office"]}},"required":["id","name"],"additionalProperties":false},{"type":"null"}]},"manager":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","pattern":"^wrk_","description":"The id of the worker.","examples":["wrk_1234"]},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"examples":[null,"Dagny Taggart"]}},"required":["id","name"],"additionalProperties":false},{"type":"null"}]},"level":{"anyOf":[{"anyOf":[{"type":"object","properties":{"id":{"type":"string","pattern":"^jlvl_","description":"The unique public id of the job level","examples":["jlvl_1234"]},"code":{"type":"string"},"name":{"type":"string"},"track":{"type":"string","enum":["ic","manager","executive"]}},"required":["id","code","name","track"],"additionalProperties":false},{"type":"null"}]},{"type":"null"}],"description":"The offer's job level, or null if unassigned. Omitted when job levels are not enabled."},"sentBy":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Display name of the person or company that sent the offer. Null for offers not yet sent.","examples":[null,"Dagny Taggart","Galt Enterprises, LLC"]},"compensation":{"type":"object","properties":{"basePay":{"type":"object","properties":{"amount":{"$ref":"#/components/schemas/PublicMoneyAmount"},"basis":{"type":"string","enum":["year","month","week","hour","variable"]},"type":{"anyOf":[{"type":"string","enum":["fixed","pay_as_you_go"]},{"type":"null"}]},"variableRate":{"anyOf":[{"$ref":"#/components/schemas/PublicMoneyAmount"},{"type":"null"}]}},"required":["amount","basis","type","variableRate"],"additionalProperties":false},"signOnBonus":{"anyOf":[{"$ref":"#/components/schemas/PublicMoneyAmount"},{"type":"null"}]},"relocationBonus":{"anyOf":[{"$ref":"#/components/schemas/PublicMoneyAmount"},{"type":"null"}]},"stock":{"anyOf":[{"type":"object","properties":{"options":{"type":"integer","minimum":0},"vestingScheduleMonths":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}]},"cliffMonths":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}]}},"required":["options","vestingScheduleMonths","cliffMonths"],"additionalProperties":false},{"type":"null"}]}},"required":["basePay","signOnBonus","relocationBonus","stock"],"additionalProperties":false},"offerUrl":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The candidate-facing offer portal URL. Null for offers that have not been sent."},"expirationTime":{"anyOf":[{"type":"string"},{"type":"null"}]},"lastViewedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"createdAt":{"type":"string"}},"required":["id","status","workerType","candidate","position","department","workplace","manager","sentBy","compensation","offerUrl","expirationTime","lastViewedAt","createdAt"],"additionalProperties":false}},"required":["id","type","timestamp","data"],"additionalProperties":false}}}},"responses":{"200":{"description":"Return any 2xx status code to acknowledge receipt. Non-2xx responses or timeouts are retried with exponential backoff."}}}},"offer.voided":{"post":{"tags":["Offers"],"summary":"Offer Voided","description":"Sent when an offer is voided. Contains an offer snapshot captured when it was voided, including the reason and any notes.","parameters":[{"name":"webhook-id","in":"header","required":true,"description":"Unique identifier for this message. Stable across retries and manual resends — use it as your idempotency key.","schema":{"type":"string","examples":["tor_abc123:550e8400-e29b-41d4-a716-446655440000"]}},{"name":"webhook-timestamp","in":"header","required":true,"description":"Unix timestamp in seconds for this delivery attempt. Recomputed on every attempt — reject deliveries whose timestamp is outside your tolerance window to guard against replay.","schema":{"type":"string","examples":["1752580800"]}},{"name":"webhook-signature","in":"header","required":true,"description":"Space-separated list of signatures over `{webhook-id}.{webhook-timestamp}.{body}`, each formatted `v1,<base64>` where `v1` is HMAC-SHA256 with your signing secret. During a secret rotation the list carries one signature per live secret; a match on any one is valid.","schema":{"type":"string","examples":["v1,g0hM9SsE+OTPJTGt/tmIKtSyZlE3uFJELVlNIOLJ1OE="]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Unique event identifier (format: `<objectTag>:<uuid>`). Stable across retries.","examples":["tor_abc123:550e8400-e29b-41d4-a716-446655440000"]},"type":{"type":"string","enum":["offer.voided"],"description":"The event type."},"timestamp":{"type":"string","description":"ISO 8601 timestamp of when the event occurred. Unchanged across retries.","examples":["2026-07-15T12:00:00.000Z"]},"data":{"type":"object","properties":{"id":{"type":"string","pattern":"^offr_","description":"The tag of the offer.","examples":["offr_1234"]},"status":{"type":"string","enum":["draft","sent","accepted","void","expired"]},"voidReason":{"anyOf":[{"anyOf":[{"type":"string","enum":["replaced","candidate_declined","other"]},{"type":"null"}]},{"type":"null"}],"description":"The reason the offer was voided. Null for offers that have not been voided."},"voidNotes":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"null"}]},{"type":"null"}],"description":"Additional notes explaining why the offer was voided."},"workerType":{"type":"string","enum":["employee","us_contractor","global_contractor"]},"candidate":{"type":"object","properties":{"firstName":{"type":"string","examples":["Jonathan"]},"lastName":{"type":"string","examples":["Galt"]},"email":{"type":"string","format":"email","title":"Email","description":"An email with a reasonably valid regex (based on RFC 5321 atext characters)","examples":["john@joinwarp.com"]},"contractorDetails":{"anyOf":[{"type":"object","properties":{"isBusiness":{"type":"boolean"},"legalBusinessName":{"anyOf":[{"type":"string"},{"type":"null"}],"examples":[null,"Galt Enterprises, LLC"]}},"required":["isBusiness","legalBusinessName"],"additionalProperties":false},{"type":"null"}]}},"required":["firstName","lastName","email","contractorDetails"],"additionalProperties":false},"position":{"type":"object","properties":{"title":{"type":"string","examples":["Research Engineer"]},"startDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"country":{"type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"scopeOfWork":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["title","startDate","country","scopeOfWork"],"additionalProperties":false},"department":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","pattern":"^dpt_","description":"The unique public id of the department","examples":["dpt_1234"]},"name":{"type":"string","examples":["Engineering"]}},"required":["id","name"],"additionalProperties":false},{"type":"null"}]},"workplace":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","pattern":"^wkp_","description":"Public workplace identifier","examples":["wkp_1234"]},"name":{"type":"string","examples":["New York Office"]}},"required":["id","name"],"additionalProperties":false},{"type":"null"}]},"manager":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","pattern":"^wrk_","description":"The id of the worker.","examples":["wrk_1234"]},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"examples":[null,"Dagny Taggart"]}},"required":["id","name"],"additionalProperties":false},{"type":"null"}]},"level":{"anyOf":[{"anyOf":[{"type":"object","properties":{"id":{"type":"string","pattern":"^jlvl_","description":"The unique public id of the job level","examples":["jlvl_1234"]},"code":{"type":"string"},"name":{"type":"string"},"track":{"type":"string","enum":["ic","manager","executive"]}},"required":["id","code","name","track"],"additionalProperties":false},{"type":"null"}]},{"type":"null"}],"description":"The offer's job level, or null if unassigned. Omitted when job levels are not enabled."},"sentBy":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Display name of the person or company that sent the offer. Null for offers not yet sent.","examples":[null,"Dagny Taggart","Galt Enterprises, LLC"]},"compensation":{"type":"object","properties":{"basePay":{"type":"object","properties":{"amount":{"$ref":"#/components/schemas/PublicMoneyAmount"},"basis":{"type":"string","enum":["year","month","week","hour","variable"]},"type":{"anyOf":[{"type":"string","enum":["fixed","pay_as_you_go"]},{"type":"null"}]},"variableRate":{"anyOf":[{"$ref":"#/components/schemas/PublicMoneyAmount"},{"type":"null"}]}},"required":["amount","basis","type","variableRate"],"additionalProperties":false},"signOnBonus":{"anyOf":[{"$ref":"#/components/schemas/PublicMoneyAmount"},{"type":"null"}]},"relocationBonus":{"anyOf":[{"$ref":"#/components/schemas/PublicMoneyAmount"},{"type":"null"}]},"stock":{"anyOf":[{"type":"object","properties":{"options":{"type":"integer","minimum":0},"vestingScheduleMonths":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}]},"cliffMonths":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}]}},"required":["options","vestingScheduleMonths","cliffMonths"],"additionalProperties":false},{"type":"null"}]}},"required":["basePay","signOnBonus","relocationBonus","stock"],"additionalProperties":false},"offerUrl":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The candidate-facing offer portal URL. Null for offers that have not been sent."},"expirationTime":{"anyOf":[{"type":"string"},{"type":"null"}]},"lastViewedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"createdAt":{"type":"string"}},"required":["id","status","workerType","candidate","position","department","workplace","manager","sentBy","compensation","offerUrl","expirationTime","lastViewedAt","createdAt"],"additionalProperties":false}},"required":["id","type","timestamp","data"],"additionalProperties":false}}}},"responses":{"200":{"description":"Return any 2xx status code to acknowledge receipt. Non-2xx responses or timeouts are retried with exponential backoff."}}}},"offer.expired":{"post":{"tags":["Offers"],"summary":"Offer Expired","description":"Sent when a sent offer reaches its expiration deadline. Contains an offer snapshot with status expired and its expirationTime. Does not emit offer.voided.","parameters":[{"name":"webhook-id","in":"header","required":true,"description":"Unique identifier for this message. Stable across retries and manual resends — use it as your idempotency key.","schema":{"type":"string","examples":["tor_abc123:550e8400-e29b-41d4-a716-446655440000"]}},{"name":"webhook-timestamp","in":"header","required":true,"description":"Unix timestamp in seconds for this delivery attempt. Recomputed on every attempt — reject deliveries whose timestamp is outside your tolerance window to guard against replay.","schema":{"type":"string","examples":["1752580800"]}},{"name":"webhook-signature","in":"header","required":true,"description":"Space-separated list of signatures over `{webhook-id}.{webhook-timestamp}.{body}`, each formatted `v1,<base64>` where `v1` is HMAC-SHA256 with your signing secret. During a secret rotation the list carries one signature per live secret; a match on any one is valid.","schema":{"type":"string","examples":["v1,g0hM9SsE+OTPJTGt/tmIKtSyZlE3uFJELVlNIOLJ1OE="]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Unique event identifier (format: `<objectTag>:<uuid>`). Stable across retries.","examples":["tor_abc123:550e8400-e29b-41d4-a716-446655440000"]},"type":{"type":"string","enum":["offer.expired"],"description":"The event type."},"timestamp":{"type":"string","description":"ISO 8601 timestamp of when the event occurred. Unchanged across retries.","examples":["2026-07-15T12:00:00.000Z"]},"data":{"type":"object","properties":{"id":{"type":"string","pattern":"^offr_","description":"The tag of the offer.","examples":["offr_1234"]},"status":{"type":"string","enum":["draft","sent","accepted","void","expired"]},"voidReason":{"anyOf":[{"anyOf":[{"type":"string","enum":["replaced","candidate_declined","other"]},{"type":"null"}]},{"type":"null"}],"description":"The reason the offer was voided. Null for offers that have not been voided."},"voidNotes":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"null"}]},{"type":"null"}],"description":"Additional notes explaining why the offer was voided."},"workerType":{"type":"string","enum":["employee","us_contractor","global_contractor"]},"candidate":{"type":"object","properties":{"firstName":{"type":"string","examples":["Jonathan"]},"lastName":{"type":"string","examples":["Galt"]},"email":{"type":"string","format":"email","title":"Email","description":"An email with a reasonably valid regex (based on RFC 5321 atext characters)","examples":["john@joinwarp.com"]},"contractorDetails":{"anyOf":[{"type":"object","properties":{"isBusiness":{"type":"boolean"},"legalBusinessName":{"anyOf":[{"type":"string"},{"type":"null"}],"examples":[null,"Galt Enterprises, LLC"]}},"required":["isBusiness","legalBusinessName"],"additionalProperties":false},{"type":"null"}]}},"required":["firstName","lastName","email","contractorDetails"],"additionalProperties":false},"position":{"type":"object","properties":{"title":{"type":"string","examples":["Research Engineer"]},"startDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"country":{"type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"scopeOfWork":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["title","startDate","country","scopeOfWork"],"additionalProperties":false},"department":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","pattern":"^dpt_","description":"The unique public id of the department","examples":["dpt_1234"]},"name":{"type":"string","examples":["Engineering"]}},"required":["id","name"],"additionalProperties":false},{"type":"null"}]},"workplace":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","pattern":"^wkp_","description":"Public workplace identifier","examples":["wkp_1234"]},"name":{"type":"string","examples":["New York Office"]}},"required":["id","name"],"additionalProperties":false},{"type":"null"}]},"manager":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","pattern":"^wrk_","description":"The id of the worker.","examples":["wrk_1234"]},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"examples":[null,"Dagny Taggart"]}},"required":["id","name"],"additionalProperties":false},{"type":"null"}]},"level":{"anyOf":[{"anyOf":[{"type":"object","properties":{"id":{"type":"string","pattern":"^jlvl_","description":"The unique public id of the job level","examples":["jlvl_1234"]},"code":{"type":"string"},"name":{"type":"string"},"track":{"type":"string","enum":["ic","manager","executive"]}},"required":["id","code","name","track"],"additionalProperties":false},{"type":"null"}]},{"type":"null"}],"description":"The offer's job level, or null if unassigned. Omitted when job levels are not enabled."},"sentBy":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Display name of the person or company that sent the offer. Null for offers not yet sent.","examples":[null,"Dagny Taggart","Galt Enterprises, LLC"]},"compensation":{"type":"object","properties":{"basePay":{"type":"object","properties":{"amount":{"$ref":"#/components/schemas/PublicMoneyAmount"},"basis":{"type":"string","enum":["year","month","week","hour","variable"]},"type":{"anyOf":[{"type":"string","enum":["fixed","pay_as_you_go"]},{"type":"null"}]},"variableRate":{"anyOf":[{"$ref":"#/components/schemas/PublicMoneyAmount"},{"type":"null"}]}},"required":["amount","basis","type","variableRate"],"additionalProperties":false},"signOnBonus":{"anyOf":[{"$ref":"#/components/schemas/PublicMoneyAmount"},{"type":"null"}]},"relocationBonus":{"anyOf":[{"$ref":"#/components/schemas/PublicMoneyAmount"},{"type":"null"}]},"stock":{"anyOf":[{"type":"object","properties":{"options":{"type":"integer","minimum":0},"vestingScheduleMonths":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}]},"cliffMonths":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}]}},"required":["options","vestingScheduleMonths","cliffMonths"],"additionalProperties":false},{"type":"null"}]}},"required":["basePay","signOnBonus","relocationBonus","stock"],"additionalProperties":false},"offerUrl":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The candidate-facing offer portal URL. Null for offers that have not been sent."},"expirationTime":{"anyOf":[{"type":"string"},{"type":"null"}]},"lastViewedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"createdAt":{"type":"string"}},"required":["id","status","workerType","candidate","position","department","workplace","manager","sentBy","compensation","offerUrl","expirationTime","lastViewedAt","createdAt"],"additionalProperties":false}},"required":["id","type","timestamp","data"],"additionalProperties":false}}}},"responses":{"200":{"description":"Return any 2xx status code to acknowledge receipt. Non-2xx responses or timeouts are retried with exponential backoff."}}}},"pay_rate.created":{"post":{"tags":["Pay Rates"],"summary":"Pay Rate Created","description":"Sent after a regular pay rate is created. The payload is a metadata-only snapshot and never includes compensation values. `id` is null for variable pay because no fixed row is stored; otherwise it can be fetched from the Pay Rates API with the corresponding compensation read scope. Replacing a fixed row on the same date emits two separate events: `pay_rate.deleted` for the removed row and `pay_rate.created` for the replacement. Delivery order is not guaranteed. Creating a fixed rate over variable pay emits only the created event because there is no prior fixed row to delete. No update event is emitted.","parameters":[{"name":"webhook-id","in":"header","required":true,"description":"Unique identifier for this message. Stable across retries and manual resends — use it as your idempotency key.","schema":{"type":"string","examples":["tor_abc123:550e8400-e29b-41d4-a716-446655440000"]}},{"name":"webhook-timestamp","in":"header","required":true,"description":"Unix timestamp in seconds for this delivery attempt. Recomputed on every attempt — reject deliveries whose timestamp is outside your tolerance window to guard against replay.","schema":{"type":"string","examples":["1752580800"]}},{"name":"webhook-signature","in":"header","required":true,"description":"Space-separated list of signatures over `{webhook-id}.{webhook-timestamp}.{body}`, each formatted `v1,<base64>` where `v1` is HMAC-SHA256 with your signing secret. During a secret rotation the list carries one signature per live secret; a match on any one is valid.","schema":{"type":"string","examples":["v1,g0hM9SsE+OTPJTGt/tmIKtSyZlE3uFJELVlNIOLJ1OE="]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Unique event identifier (format: `<objectTag>:<uuid>`). Stable across retries.","examples":["tor_abc123:550e8400-e29b-41d4-a716-446655440000"]},"type":{"type":"string","enum":["pay_rate.created"],"description":"The event type."},"timestamp":{"type":"string","description":"ISO 8601 timestamp of when the event occurred. Unchanged across retries.","examples":["2026-07-15T12:00:00.000Z"]},"data":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","pattern":"^pyr_","description":"The tag of the pay rate.","examples":["pyr_1234"]},{"type":"null"}],"description":"The fixed pay-rate id, or null when the event represents a variable-pay boundary with no row."},"workerId":{"type":"string","pattern":"^wrk_","description":"The worker whose regular pay-rate timeline changed.","examples":["wrk_1234"]},"effectiveDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"}},"required":["id","workerId","effectiveDate"],"additionalProperties":false}},"required":["id","type","timestamp","data"],"additionalProperties":false}}}},"responses":{"200":{"description":"Return any 2xx status code to acknowledge receipt. Non-2xx responses or timeouts are retried with exponential backoff."}}}},"pay_rate.deleted":{"post":{"tags":["Pay Rates"],"summary":"Pay Rate Deleted","description":"Sent after a future regular pay rate or variable-pay boundary is deleted. The frozen metadata-only snapshot never includes compensation values. `id` is null for a variable-pay boundary, and a non-null deleted id is no longer fetchable; use `workerId` and `effectiveDate` to identify the change.","parameters":[{"name":"webhook-id","in":"header","required":true,"description":"Unique identifier for this message. Stable across retries and manual resends — use it as your idempotency key.","schema":{"type":"string","examples":["tor_abc123:550e8400-e29b-41d4-a716-446655440000"]}},{"name":"webhook-timestamp","in":"header","required":true,"description":"Unix timestamp in seconds for this delivery attempt. Recomputed on every attempt — reject deliveries whose timestamp is outside your tolerance window to guard against replay.","schema":{"type":"string","examples":["1752580800"]}},{"name":"webhook-signature","in":"header","required":true,"description":"Space-separated list of signatures over `{webhook-id}.{webhook-timestamp}.{body}`, each formatted `v1,<base64>` where `v1` is HMAC-SHA256 with your signing secret. During a secret rotation the list carries one signature per live secret; a match on any one is valid.","schema":{"type":"string","examples":["v1,g0hM9SsE+OTPJTGt/tmIKtSyZlE3uFJELVlNIOLJ1OE="]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Unique event identifier (format: `<objectTag>:<uuid>`). Stable across retries.","examples":["tor_abc123:550e8400-e29b-41d4-a716-446655440000"]},"type":{"type":"string","enum":["pay_rate.deleted"],"description":"The event type."},"timestamp":{"type":"string","description":"ISO 8601 timestamp of when the event occurred. Unchanged across retries.","examples":["2026-07-15T12:00:00.000Z"]},"data":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","pattern":"^pyr_","description":"The tag of the pay rate.","examples":["pyr_1234"]},{"type":"null"}],"description":"The fixed pay-rate id, or null when the event represents a variable-pay boundary with no row."},"workerId":{"type":"string","pattern":"^wrk_","description":"The worker whose regular pay-rate timeline changed.","examples":["wrk_1234"]},"effectiveDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"}},"required":["id","workerId","effectiveDate"],"additionalProperties":false}},"required":["id","type","timestamp","data"],"additionalProperties":false}}}},"responses":{"200":{"description":"Return any 2xx status code to acknowledge receipt. Non-2xx responses or timeouts are retried with exponential backoff."}}}}}}