Input Objects

Input Objects represent input to a query or mutation.

AcceptBidInput

The input used for hiring.

Fields
`bid`ID! The ID of the bid which the hire should be based on.
`contactPerson`ID The ID of the person in the company which is responsible for the contact. If not supplied, the currently authenticated user will be used.
`billingContactPerson`ID The ID of the person in the company which is responsible for the billing. If not supplied, the currently authenticated user will be used.
`startDate`Date The date that the contract should start. This date is used on the draft contract.
`endDate`Date The date that the contract should end. This date is used on the draft contract.
`jobTitle`String The title of the job the person will be hired to do. If not filled out, the job title from the job of the bid will be used. This title is used on the draft contract.
`jobDescription`String The description of the hire job. If not filled out, the job description from the job of the bid will be used. This title is used on the draft contract.
`paymentTermMethod`PaymentTermMethod The payment term method for the contract.
`paymentTermDays`PaymentTermDays The amount of days to use with the payment term method for the contract.
`purchaseOrderNumber`String The Purchaser Order Number for the contract.
`additionalTerms`String Any additional terms to the contract. The contract is always subject to the terms and conditions for Worksome’s platform.
`workplaceAddress`String The address for where the work will be taken place. This will be part of the contract also. The Address should be a full address, with city and postal code.
`customInvoiceText`String Any text which should be included in all invoices that are part of this hire. This text will be shown on the top of each invoice once they are created.
`companyName`String The company name used on the contract. If not set the current company name will be used instead.
`companyAddress`String The company address used on the contract. If not set the current company address will be used instead.
`companyZipCode`String The company zip code used on the contract. If not set the current company zip code will be used instead.
`companyCity`String The company city used on the contract. If not set the current company city will be used instead.
`companyCountry`String The company country used on the contract. If not set the current company country will be used instead.
`recruiter`RecruiterInput The recruiter for which will be attributed to the hire.
`closeOtherConversations`Boolean Close other conversations if true.
`closingMessage`String Message to send when closing other conversations.
`attachments`[ID!] Attached documents.
`externalIdentifier`String An identifier associated with the hire from an external system.

ActionApprovalApprovableInput

The input for taking action on an approval request.

Fields
`id`ID! The ID of the approval request to act on.
`status`ApprovalApprovableState The action to take: `APPROVED`, `REJECTED`, or `NEEDS_CHANGE`.
`reason`String An optional message explaining the decision (required when rejecting or requesting changes).

AddressInput

An input for storing the given address.

Fields
`address`String The address.
`postCode`String The post code (ZIP code).
`city`String The city.
`country`String The country alpha2-code.
`state`String The state alpha2-code, if applicable.

ApprovalApprovablesOrderByClauseInput

The input for sorting approval requests.

Fields
`field`ApprovalApprovableOrderByColumn The field to sort by.
`order`SortOrder The sort direction.

ApproveEmploymentChangesInput

Input for approving employment changes.

Fields
`employment`ID! The ID of the employment to approve changes for.

ApproveTrustedContactInput

The details for approving a trusted contact.

Fields
`id`ID! The ID of the trusted contact to be deleted.

ArgsInput

An input for additional arguments for the export.

Fields
`companies`[Int!]! A list of company IDs to include in the export.
`dateFrom`Date The date for the start of the export.
`dateTo`Date The date for the end of the export.
`meta`String Additional information and metadata.

AttachJobsToProjectInput

The input used for attaching one or more jobs to a project.

Fields
`jobs`[ID!]! Jobs to be added to the project.
`project`ID! The project containing jobs.

AttachUsersToUserGroupInput

The input used for attaching one or more users to a group.

Fields
`userGroup`ID! The user group containing users.
`users`[ID!] Users to be attached to the group.

AttributeRecruiterToHireInput

The input object used for attributing a recruiter to a hire.

Fields
`hire`ID! The ID of the hire.
`recruiter`ID! The ID of the recruiter.
`fee`StrictPercentage The fee the recruiter is taking as a percentage.
`ownershipDays`Int! The amount of days the recruiters ownership period exist in.
`ownershipStartDate`Date! The date that the ownership starts.

BatchActionScopeInput

Scope for selecting which items in the batch to target.

Fields
`ids`[ID!] Only operate on these item IDs.
`excludeIds`[ID!] Exclude these item IDs from the operation.
`status`BatchItemStatus Only operate on items with this status.

BbanInput

The BBAN input details.

Fields
`bsb`String The Bank-State-Branch or BSB number.
`bankId`String The bank ID.
`bankCode`String The bank code.
`branchId`String The bank branch ID.
`branchCode`String The bank branch code.
`accountNumber`String The bank account number.
`accountSuffix`String The bank account suffix.
`institutionNumber`String The bank institution number
`transitNumber`String The bank transit number.
`registrationNumber`String The bank registration number.
`routingCode`String The bank routing code.
`sortCode`String The bank sort code.
`purposeOfPayment`String The bank purpose of payment code.

BlockTrustedContactInput

The details for blocking a trusted contact.

Fields
`id`ID! The ID of the trusted contact to be blocked.
`account`ID! The account performing the block.

CancelHireInput

The input object used for all the information required to cancel a hire.

Fields
`hire`ID! The ID of the hire.
`message`String! The reason for canceling the hire.

ChangeEmailInput

The details required for changing the email.

Fields
`user`ID The ID of the user whose email address should be updated. If this is `null` or excluded, the currently authenticated user’s email will be changed.
`email`String! The new email for the user.

CreateApprovalInput

The input for creating a new approval flow.

After creating the approval, use createApprovalRule to add conditions and then createApprover to assign user groups who will review matching items.

Alternatively, use createWorkflow to create the entire approval flow (root, rules, and approvers) in a single operation.

Fields
`name`String! The display name for the approval flow.
`status`ApprovalStatus! Whether the approval should be active immediately. Only `ACTIVE` approvals are evaluated when triggering events occur.
`trigger`ApprovalTrigger! The event that triggers this approval flow (e.g. hire created, contract changed).
`description`String A human-readable description of the approval flow’s purpose.
`company`ID! The company that the approval flow belongs to.

CreateApprovalRuleInput

The input for adding a rule to an approval flow.

Fields
`approval`ID! The ID of the approval flow to add this rule to.
`rules`[CreateWorkflowVariableFieldInput!]! The conditions that determine when this rule triggers. Each condition compares a workflow variable against a threshold value.

CreateApproverInput

The input for assigning a user group as an approver on an approval rule.

Fields
`approvalRule`ID! The ID of the approval rule to assign this approver to.
`userGroup`ID! The ID of the user group whose members will review approval requests.
`position`Int! The position in the approval sequence (1-based). Lower positions are notified first.

CreateBatchInput

The input used for creating batches.

Fields
`account`ID! The account that the batch is for.
`type`BatchType! The type of batch to create.
`items`[ID!] A list of items to add to the batch.

CreateCompanyRecruiterInput

The details for adding and inviting a recruiter.

Fields
`company`ID! The company that the recruiter relationship is for.
`name`String! The invited recruiter name.
`email`String! The recruiter email.
`recruiterFee`Float The recruiter fee.
`recruiterOwnershipDays`Int The ownership days of the recruiter.
`message`String The message that will be sent to the recruiter.
`tags`[String!] The tags to associate with the recruiter.
`externalIdentifier`String An identifier associated with the company recruiter from an external system.
`managesWorkers`Boolean Whether the recruiter manages workers for this company relationship. When null, the company-level default is used.
`customFieldValues`[CustomFieldTypeValueInput!] The custom fields for the company recruiter.

CreateCustomFieldInput

The input for creating a custom field.

Fields
`account`ID! The account that will own the custom field.
`fieldType`CustomFieldType! SINGLE_SELECT The custom field type.
`appliesTo`TypeSupportingCustomFieldValues! The type to which the custom field is applying to.
`title`String! The title or label of the custom field.
`slug`String A unique human-readable key for the custom field, preferably in a slug format with lowercase and hyphens to replace spaces. The key is only unique within the same account.
`description`String The description of the custom field.
`settings`CustomFieldSettingsInput! The settings to apply to the custom field.
`visibility`CustomFieldVisibility! INTERNAL The visibility of the custom field.
`approval`Boolean Whether the field is enabled for approval workflows.
`apiOnly`Boolean Configures the field to be enabled for api updates only.
`workerInputAllowed`Boolean Configures the field to allow worker input. When enabled, workers can provide values for this field through the worker API.
`recruiterInputAllowed`Boolean Configures the field to allow recruiter (staffing agency) input. When enabled, recruiters can provide values for this field through the recruiter API.
`options`[CustomFieldCustomFieldOptionInput!] The list of options which will be available for custom field values. Only applies to some custom field types (e.g. `SINGLE_SELECT`)

CreateCustomTimesheetInput

An input for creating a custom timesheet.

Fields
`schema`String! The schema for the data format of the submitted timesheet data. Contact Worksome to obtain information on supported schemas.
`data`String! The custom data for the timesheet.

CreateExportInput

An input for creating an export.

Fields
`userId`Int! The ID of the user to create an export for.
`impersonatorId`Int The ID of the impersonator that is creating the export.
`accountId`Int! The ID of the account to create an export for.
`accountType`String! The type of account to create an export for.
`type`String! The type of processor to use for the export.
`generatorType`String! The type of generator (format) that is creating the export.
`deliveries`[String!]! The methods and locations that the export should be delivered to.
`args`ArgsInput! Additional arguments to record for the export.

CreateJobCandidateInput

The details for creating a job candidate.

Fields
`job`ID! The job for which the candidates are for.
`workers`[ID!]! The workers that should be candidates for the specified job.
`sourcingChannel`SourcingChannel! The sourcing channel that the candidates are from.

CreateJobInput

The input for creating a new job.

createJob is a minimal first step that creates the job in DRAFT status with only the required fields. Use updateJob afterwards to set the full job details (description, rates, dates, location, visibility, etc.) and to publish the job when it is ready.

Fields
`company`ID! The company that the job is for.
`name`String! The title of the job.
`owners`[ID!] The owners of the job posting. If omitted, the authenticated user becomes the owner.
`skills`[String!]! The skills required for the job.

CreateJobShareInput

An input for creating a job share.

Fields
`job`ID! The job that the job share is for.
`accounts`[ID!]! The accounts to share the job with.

CreateMilestoneInput

The input for creating a milestone.

Fields
`name`String! The name of the milestone.
`purchaseOrderNumber`String The Purchase Order (PO) number for the milestone.
`dueDate`Date! The due date for the milestone.
`amount`Float! The total cost for the milestone.
`hire`ID! The ID of the hire that the milestone is for.

CreateMilestonesInput

The input for creating one or more milestones.

Fields
`milestones`[CreateMilestoneInput!]! The milestones to create.

CreateNoteInput

An input for creating a note.

Fields
`body`String! The body of the note.
`title`String The title of the note.
`accountId`ID! The account that the note is related to.
`notableId`ID! The entity that the note is for.

CreatePasswordInput

The details required for creating a password.

Fields
`password`String! The password which will be set on the user.

CreatePaymentRequestInput

An input for creating a payment request.

Fields
`worker`ID! The worker that is creating the payment request.
`job`ID! The job that the payment request is for.
`company`ID! The company that the payment request is for.
`hire`ID! The hire that the payment request is for.
`startDate`Date! The date that the payment request started.
`endDate`Date The date that the payment request ended (if applicable).
`expenseReports`[ID!] The expense reports for the payment request.
`rate`Float The rate for the payment request.
`billableTime`Float The billable time for the payment request.
`billableTotal`Float The billable total for the payment request.
`comments`String! Comments related to the payment request.
`taxLines`[TaxLineInput!] A list of tax lines.
`timesheet`ID The timesheet to link to the payment request.

CreateProjectInput

The input used for projects.

Fields
`name`String! The name of the project.
`description`String The description of the project.
`internalBudget`Float The internal budget of the project.
`company`ID! The company that the project is for.
`owners`[ID!] The owners of the project.
`externalIdentifier`String An identifier associated with the project from an external system.

CreateRecruiterCandidateInput

The details for adding and inviting a recruiter candidate.

Fields
`recruiter`ID! The recruiter that the recruiter candidate relationship is for.
`firstName`String! The invited candidate first name
`middleName`String The invited candidate middle name
`lastName`String! The invited candidate last name
`email`String! The candidate email.
`jobTitle`String The candidate job title.
`currency`String! The candidates currency.
`hourlyRate`Float The hourly rate of the candidate.
`dailyRate`Float The daily rate of the candidate.
`monthlyRate`Float The monthly rate of the candidate.
`tags`[String!]! The tags to associate to the candidate.
`links`[String!]! The links related tot he candidate.
`files`[ID!] The files attached to the relationship.

CreateSmsMultiFactorInput

An input for creating a new SMS multi-factor authentication implementation.

Fields
`name`String An optional name for the SMS multi-factor authentication implementation.

CreateTimesheetInput

The input used for creating timesheets.

Fields
`worker`ID! The worker that the timesheet is for.
`hire`ID! The hire that the timesheet is for.
`startDate`Date! The start date of the timesheet.
`endDate`Date! The end date of the timesheet.
`registrations`[TimesheetRegistrationInput!] A list of registrations to add to the timesheet.
`files`[ID!] A list of files to add to the timesheet.

CreateTotpMultiFactorInput

An input for creating a new TOTP multi-factor authentication implementation.

Fields
`name`String An optional name for the TOTP multi-factor authentication implementation.

CreateTrustedContactInput

The details for adding & inviting a trusted contact.

Fields
`company`ID! The company that the trusted contact is for.
`firstName`String! The invited trusted contact first name.
`middleName`String The invited trusted contact middle name.
`lastName`String! The invited trusted contact last name.
`name`String The invited trusted contact full name.
`email`String! The invited trusted contact email.
`country`String The invited trusted contact country.
`state`String The invited trusted contact country state, if applicable.
`links`[String!]! The invited trusted contact links.
`attachments`[ID!]! The invited trusted contact attachments.
`skills`[String!]! The skills to associate with the trusted contact.
`message`String The message that will be sent to the trusted contact.
`notifyWorker`Boolean! 1 Whether the worker should be notified that they have been added to the platform.
`externalIdentifier`String An identifier associated with the trusted contact from an external system.
`origin`TrustedContactOrigin! The origin of the trusted contact
`originChannel`TrustedContactOriginChannel! The channel of origin of the trusted contact
`customFieldValues`[CustomFieldTypeValueInput!] The custom fields for the trusted contact. BETA. Custom fields on Workers are currently available for a subset of users.

CreateUserGroupInput

The input used for groups.

Fields
`name`String! The name of the group.
`description`String The description of the group.
`status`UserGroupStatus! The status of the user group.
`company`ID! The company that the group is for.
`users`[ID!] The users of the group.

CreateWebhookInput

The input used for creating a webhook.

Fields
`title`String! The title of the webhook.
`description`String The description of the webhook.
`url`String! The URL of the webhook.
`secret`String The secret of the webhook. If using OAuth this is the client secret
`isActive`Boolean Whether the webhook is active or not.
`clientId`String The client ID of the webhook, when using OAuth.
`clientUrl`String The client URL of the webhook, when using OAuth.
`subscribedEvents`[WebhookEventType!] The event types that this webhook should be subscribed to. If null or not provided, the webhook will be subscribed to all event types. If an empty array, the webhook will not receive any events.
`company`ID! The company that the webhook is for.

CreateWorkflowApproverInput

An approver node in the workflow tree — assigns user groups to a rule.

Fields
`id`ID A temporary ID for this node.
`parent`ID The temporary ID of the parent rule node.
`children`[ID!] The temporary IDs of any child nodes.
`data`[ID!]! The user groups whose members will review approval requests matching the parent rule.

CreateWorkflowInput

The input for creating a complete workflow tree (approval + rules + approvers) in one operation.

The tree is structured using temporary node IDs: each node has an id that its children reference via parent, and the node references its children via children. This allows the entire approval structure to be submitted as a flat list of connected nodes.

Fields
`root`CreateWorkflowRootInput! The root node — defines the approval flow (name, trigger, status).
`rules`[CreateWorkflowRuleInput!] The rule nodes — each defines conditions that determine when approval is needed. Connected to the root via `parent`.
`approvers`[CreateWorkflowApproverInput!] The approver nodes — each assigns user groups to review matching items. Connected to rules via `parent`.

CreateWorkflowRootInput

The root node of a workflow tree — contains the approval flow definition.

Fields
`id`ID A temporary ID for this node, used by child nodes to reference it via `parent`.
`children`[ID!] The temporary IDs of rule nodes that are direct children of this root.
`data`CreateApprovalInput! The approval flow details (name, trigger, status, company).

CreateWorkflowRuleInput

A rule node in the workflow tree — defines conditions for when approval is required.

Fields
`id`ID A temporary ID for this node, used by child nodes to reference it via `parent`.
`parent`ID The temporary ID of the parent node (the root or another rule).
`children`[ID!] The temporary IDs of approver nodes that are children of this rule.
`data`[CreateWorkflowVariableFieldInput!] The conditions for this rule — each compares a workflow variable against a threshold.

CreateWorkflowVariableFieldInput

A condition to add to an approval rule, pairing a variable with a comparison.

Use the workflowVariables query to discover available variables for a given trigger type.

Fields
`id`String! The identifier of the workflow variable or custom field to evaluate. Use the `workflowVariables` query to find valid identifiers for the approval’s trigger type.
`rule`WorkflowVariableFieldRuleInput! The comparison operator and threshold value for this condition.

CustomFieldCustomFieldOptionInput

The settings input for custom fields.

Fields
`option`ID The ID of the custom field option to update.
`value`String! The custom field option representation value that is likely shown to the user for selection. For example: “title”, “label”, “number”
`displayOrder`Int! 0 Specify a display order for use later in.

CustomFieldSettingsInput

The settings input for custom fields.

Fields
`validation`[CustomFieldValidationRules!] A list of validation rules to be applied when using custom fields.

CustomFieldTypeValueInput

An input representing a custom field value, tailored to the field type.

All input fields are mutually exclusive.

Fields
`singleSelect`SingleSelectCustomFieldValueInput The input custom field values representation of the `SINGLE_SELECT` field type.
`freeText`FreeTextCustomFieldValueInput The input custom field values representation of the `FREE_TEXT` field type.

CustomFieldValueInput

An input for a custom field value.

Fields
`appliesTo`ID! The entity that supports custom fields to which the value should be attached.
`value`CustomFieldTypeValueInput! The representation of the value.

DateRangeInput

An input for a date range.

Fields
`from`Date The start date of the range.
`to`Date The end date of the range.

DeleteCompanyRecruiterInput

The details for deleting a recruiter relationship.

Fields
`id`ID! The recruiter relationship to delete.

DeleteCustomFieldInput

The input for the deletion of a custom field.

Fields
`customField`ID! The ID of the custom field to delete.

DeleteMilestoneInput

The input for deleting a milestone.

Fields
`id`ID! The ID of the milestone to delete.

DeleteMilestonesInput

The input for deleting one or more milestones.

Fields
`milestones`[DeleteMilestoneInput!]! The milestones to delete.

DeleteNoteInput

An input for deleting a note.

Fields
`id`ID! The ID of the note to be deleted.

DeletePaymentRequestInput

The input used for deleting a payment request.

Fields
`id`ID! The ID of the payment request to delete.

DeleteProjectInput

An input for deleting an existing project.

Fields
`id`ID! The ID of the project.

DeleteRecruiterCandidateInput

The details for deleting a recruiter candidate relationship.

Fields
`id`ID! The recruiter candidate relationship to delete.

DeleteTimesheetInput

The input used for deleting a timesheet.

Fields
`id`ID! The ID of the timesheet to delete.

DeleteTimesheetRegistrationInput

The input used for deleting a timesheet registration.

Fields
`id`ID! The ID of the timesheet registration to delete.

DeleteTrustedContactInput

The details for deleting a trusted contact.

Fields
`id`ID! The ID of the trusted contact to be deleted.
`account`ID! The account performing the delete.

DeleteUserGroupInput

An input for deleting an existing group.

Fields
`id`ID! The ID of the group.

DeleteWebhookInput

The input for deleting a webhook.

Fields
`id`ID! The ID of the webhook to be deleted.

DeleteWorkflowInput

The input for deleting an existing workflow.

Fields
`id`ID! The ID of the workflow to delete (same as the approval ID).

DetachJobFromProjectInput

The input used for attaching one or more jobs to a project.

Fields
`job`ID! Jobs to be detached from the project.
`project`ID! The project containing jobs.

DetachUsersFromUserGroupInput

The input used for detaching one or more users from a group.

Fields
`userGroup`ID! The user group containing users.
`users`[ID!] Users to be detached from the group.

DuplicateJobInput

The input for duplicating an existing job.

Fields
`id`ID! The ID of the job to duplicate.
`title`String Optional title for the duplicated job. If not provided, the original job title will be used with “[Copy]” prepended.

EmploymentCostsInput

Input for employment costs.

Fields
`fixedAmount`Float Fixed amount cost.
`percentage`Float Percentage cost.
`oneTimeAmount`Float One-time amount cost.

EmploymentsOrderByClauseInput

Input for ordering employments.

Fields
`field`EmploymentOrderByColumn The field to order by.
`order`SortOrder! The direction to order by.

EndJobInput

An input for ending (aka closing) an existing job.

Fields
`id`ID! The ID of the job.
`accountId`ID! The ID of the account performing the action.

EndProjectInput

An input for ending an existing project.

Fields
`id`ID! The ID of the project.

ForwardCandidateInput

The details for forwarding (presenting) a candidate to a linked client job.

Fields
`sourceCandidate`ID! The source candidate to present.
`rate`Float! The rate to present to the client.
`rateType`RateType! The rate type for the presentation.
`brief`String An optional brief describing the candidate.

FreeTextCustomFieldValueInput

An input for a free-text custom field.

Fields
`id`ID The ID of the field to create a free text for.
`slug`String A unique human-readable key for the custom field, preferably in a slug format with lowercase and hyphens to replace spaces. The key is only unique within the same account.
`value`String This is the value for the field. A null value indicates that the field value will be deleted.

GenerateInviteLinkInput

The input used to generate the company invite link token.

Fields
`company`ID! The company that the link token is for.

GeneratePersonalInviteLinkInput

The input used to generate the personal invite link token.

Fields
`company`ID! The company that the link token is for.

HireHistoryFilterInput

Trusted contact hire history filter input.

Fields
`status`TrustedContactHireHistory The hire history filter value.
`accounts`[ID!] Supply which accounts to filter hire history for.

HireInput

The input used for direct hires (hiring a worker without a bid).

Direct hires require the worker to be a trusted contact of the hiring company. If job is omitted, a new job will be created automatically using the provided name, description, and related fields. If job is provided, the hire will be associated with that existing job.

Fields
`trustedContact`ID The trusted contact to hire directly. The worker must already exist as a trusted contact of the hiring company. Use `createTrustedContact` first if the worker is not yet in the company’s Talent Pool.
`job`ID The ID of an existing job to associate with this hire. Optional — if omitted, a new job will be created automatically from the `name`, `description`, and other job-related fields provided in this input.
`name`String The title for the auto-created job. Only used when `job` is not provided.
`description`String The description for the auto-created job. Only used when `job` is not provided.
`message`String The message to send the trusted contact.
`rateType`RateType The rate type that is due.
`rate`Float The rate that is due.
`locationPreference`LocationPreferenceInput The location preference of the job.
`startDate`Date The date that the contract should start. This date is used on the draft contract.
`endDate`Date The date that the contract should end. This date is used on the draft contract.
`includeStandardContract`Boolean Whether to include the standard contract. The default is to include a standard contract.
`purchaseOrderNumber`String A Purchase Order (PO) number to attribute to the direct hire.
`conversation`ID The conversation that the direct hire should be attributed to.
`recruiter`RecruiterInput The recruiter that the hire should be attributed to.
`customFieldValues`[CustomFieldTypeValueInput!] Additional custom fields for the direct hire. Details specified in this will only be visible to you and your team members, not to workers. Note: Passing an empty array `[]` will skip custom field syncing entirely. If you have required custom fields configured, you must provide values for them or validation will fail.
`company`ID! The company that the direct hire is for.
`externalIdentifier`String An identifier associated with the hire from an external system.
`owners`[ID!] The users who should own this hire. If not provided, the authenticated user will be set as the owner.
`hireDescription`String The description for the hire. If not provided and a job is provided, the job description will be used. This description is used on the draft contract.

HireStatusFilterInput

Trusted contact hire status filter input.

Fields
`status`TrustedContactHireStatus The hire status filter value.
`accounts`[ID!] Supply which accounts to filter the hire status for.

HiresOrderByClauseInput

The input object used to sort hires.

Fields
`field`HireOrderByColumn The field to sort hires by.
`order`SortOrder The order to sort hires by.

InviteCompanyRecruiterInput

The details for inviting a recruiter.

Fields
`id`ID! The recruiter to invite.
`company`ID! The company inviting the recruiter.
`recruiterFee`Float The recruiter fee.
`recruiterOwnershipDays`Int The ownership days of the recruiter.
`message`String The message that will be sent to the recruiter.
`tags`[String!] The tags to associate with the recruiter.
`managesWorkers`Boolean Whether the recruiter manages workers for this company relationship. When null, the company-level default is used.

InvitedByInput

Trusted contact invited by users filter input.

If null, all trusted contacts will be returned.

Fields
`users`[ID!]! User IDs by which to filter by.
`includeAutomation`Boolean! Whether or not to include TCs that have been invited via automation.

JobCandidateOrderByClauseInput

Trusted contact sorting clause input.

Fields
`column`JobCandidateOrderByColumn! The column by which trusted contacts should be sorted.
`order`SortOrder! ASC The sorting order for the associated sorting column.

JobShareOrderByClauseInput

An input for ordering job shares.

Fields
`field`JobShareOrderByColumn! The field to order by.
`order`SortOrder! The direction to order by.

JobsOrderByClauseInput

The input object used to sort jobs.

Fields
`field`JobOrderByColumn The field to sort jobs by.
`order`SortOrder The order to sort jobs by.

LanguageInput

An input for a language.

Fields
`name`LanguageName! The name of the language.
`experience`Fluency! The experience level required for the language.

LocationPreferenceInput

An input for the location preferences.

Fields
`preference`LocationPreference! The location preference.
`address`String The address for the job. This is not required when `location` is set to `REMOTE_ONLY`.

ManageOnboardingDocumentsInput

The input used to manage onboarding documents.

Fields
`company`ID! The company that the onboarding documents are for.
`documents`[ID!]! The documents to be added for onboarding.

MarkFilesAsUploadedInput

The input used for marking one or more files as uploaded.

Fields
`files`[ID!]! The list of files to mark as uploaded.

OnboardEmploymentInput

Input for onboarding an employment.

Fields
`employment`ID! The ID of the employment to onboard.
`employmentCosts`EmploymentCostsInput Optional employment costs to apply.

OpenProjectInput

An input for opening an existing project.

Fields
`id`ID! The ID of the project.

OrderByClause

Allows ordering a list of records.

Fields
`column`String! The column that is used for ordering.
`order`SortOrder! The direction that is used for ordering.

PaymentRequestOrderByClauseInput

Payment request sorting clause input.

Fields
`field`PaymentRequestOrderByColumn The field to sort payment requests by.
`order`SortOrder The order to sort payment requests by.

QueryInvoicesOrderByOrderByClause

Order by clause for Query.invoices.orderBy.

Fields
`column`InvoicesOrderByColumn! The column that is used for ordering.
`order`SortOrder! The direction that is used for ordering.

RateInput

An input for the rate.

Fields
`type`RateType! The unit of time when payment is due.
`rate`Float The payment amount per specified rate type.
`range`RateRangeInput The payment amount as a range per specified rate type.

RateRangeInput

An input for the rate as a range.

Fields
`minimum`Float! The minimum payment amount per specified rate type.
`maximum`Float! The maximum payment amount per specified rate type.

RecruiterInput

The input object used for all the information required to attribute a recruiter.

Fields
`recruiter`ID! The ID of the recruiter.
`fee`StrictPercentage! The fee the recruiter is taking as a percentage.
`ownershipDays`Int! The amount of days the recruiters ownership period exist in.
`ownershipStartDate`Date! The date that the ownership starts.

RecruiterOrderByClauseInput

Recruiter sorting clause input.

Fields
`column`RecruiterOrderByColumn Column by which trusted contacts should be sorted.
`order`SortOrder ASC Sorting order for the associated sorting column.

ReinviteTrustedContactInput

The input for resending an invitation to a Trusted Contact.

Fields
`id`ID! The ID of the Trusted Contact to re-invite. (Note, this is different from the Worker ID)

RejectHireInput

The input used to reject a hire.

Fields
`account`ID! The account that is rejecting the hire.
`hire`ID! The ID of the hire to be rejected.

RemoveJobShareInput

An input for removing a job share.

Fields
`ids`[ID!]! Which job share ids to remove job shares for.

RemoveMultiFactorInput

An input for removing a multi-factor authentication implementation.

Fields
`id`ID! The ID of the multi-factor authentication implementation to remove.

RemoveOnboardingDocumentsInput

The input used to remove onboarding documents.

Fields
`company`ID! The company that the onboarding documents are for.
`documents`[ID!]! The document IDs to be removed from onboarding.

RemoveRecruiterFromHireInput

The input object used for removing a recruiter from a hire.

Fields
`hire`ID! The ID of the hire.

RetryWebhookEventInput

The input for retrying a webhook event.

Fields
`id`ID! The ID of the webhook event to be retried.

RunBatchActionInput

The input used for running an action on a batch.

Fields
`batch`ID! The ID of the batch to operate on.
`action`BatchActionType! The action to perform.
`scope`BatchActionScopeInput Limits which items in the batch are affected.
`deleteIfEmptied`Boolean If true and the action results in zero items remaining in the batch, delete the batch.

SetInternalBudgetOnJobInput

The input used for setting the internal budget on a job.

Fields
`job`ID! The job that the budget is for.
`amount`Float! The amount for the internal budget. Up to 2 decimal points are stored, the rest is omitted.

ShareCandidatesWithPartnerInput

The details for sharing candidates with the linked partner account.

Fields
`jobCandidates`[ID!]! The candidates to share.

ShareHireInput

The input object used for sharing a hire.

Fields
`hire`ID! The ID of the hire.
`message`String Optional message to include when sharing the hire.

SingleSelectCustomFieldValueInput

An input for a single-select custom field.

Fields
`id`ID The ID of the field to create a selection for.
`slug`String A unique human-readable key for the custom field, preferably in a slug format with lowercase and hyphens to replace spaces. The key is only unique within the same account.
`value`ID The ID of the option to select. A null value indicates that the field value will be deleted.

SkillOrderByClauseInput

Skill sorting clause input.

Fields
`column`SkillOrderByColumn! Column by which trusted contacts should be sorted
`order`SortOrder! ASC Sorting order for the associated sorting column

StoreBankDetailsInput

The details for updating a bank account details.

Fields
`accountId`ID! The account that the bank account is related to.
`name`String The display name for this bank account.
`bankAddress`String! The address of this bank account.
`bankCountry`String! The country of this bank account.
`bankName`String! The name of this bank account.
`beneficiaryName`String! The beneficiary name of this bank account.
`bban`BbanInput The BBAN information (if applicable).
`iban`String The bank account IBAN (if applicable).
`swift`String The bank account SWIFT code (if applicable).

TaxLineInput

An input for a tax line.

Fields
`rate`Float! The rate of tax.
`terminology`String! The terminology for the tax line.

TerminateHireInput

The input object used for all the information required to terminate a hire.

Fields
`hire`ID! The ID of the hire.
`reason`ContractTerminationReason! The reason for terminating a hire.
`comments`String Additional comments to explain why a hire is being terminated.
`date`Date! The date that the termination should take effect.
`message`String An optional message to the worker.

TimesheetRegistrationInput

An input representing a timesheet registration as part of the timesheet creation flow.

Fields
`type`TimesheetRegistrationType! The type of the timesheet registration.
`date`Date! The date of the timesheet registration.
`startTime`Time The start time of the timesheet registration.
`endTime`Time The end time of the timesheet registration.
`duration`Float! The duration of the timesheet registration.
`unit`TimesheetRegistrationDurationUnit! The unit of measurement for the timesheet registration.
`comments`String The comments for the timesheet registration.
`externalIdentifier`String An identifier associated with the timesheet registration from an external system.
`invoiceReferenceNumber`String An invoice reference number associated with the timesheet registration.
`isBillable`Boolean Whether the timesheet registration is billable.
`customFieldValues`[CustomFieldTypeValueInput!] The custom fields for the timesheet registration.

TrustedContactOrderByClauseInput

Trusted contact sorting clause input.

Fields
`column`TrustedContactOrderByColumn Column by which trusted contacts should be sorted.
`order`SortOrder ASC Sorting order for the associated sorting column.

UpdateApprovalDataInput

The updatable fields on an approval flow when updating via the workflow tree.

Fields
`name`String The updated display name.
`status`ApprovalStatus The updated status (`ACTIVE`, `INACTIVE`, or `ARCHIVED`).
`trigger`ApprovalTrigger The updated trigger event.
`description`String The updated description.

UpdateApprovalInput

The input for updating an existing approval flow.

All fields except id are optional — only provided fields are updated. Updates create a new version of the approval.

Fields
`id`ID! The ID of the approval flow to update.
`name`String The updated display name.
`status`ApprovalStatus The updated status. Set to `INACTIVE` to pause the approval without deleting it.
`trigger`ApprovalTrigger The updated trigger event.
`description`String The updated description.

UpdateApprovalRuleInput

The input for updating an existing approval rule.

Fields
`id`ID! The ID of the approval rule to update.
`approval`ID! The ID of the parent approval flow.
`fields`[CreateWorkflowVariableFieldInput!]! The updated conditions for this rule.

UpdateApproverInput

The input for updating an approver assignment.

Fields
`id`ID! The ID of the approver assignment to update.
`userGroup`ID The updated user group.
`position`Int The updated position in the approval sequence.

UpdateCompanyRecruiterInput

The details for updating a recruiter relationship.

Fields
`id`ID! The recruiter relationship to update.
`recruiterFee`Float The updated recruiter fee.
`recruiterOwnershipDays`Int The updated recruiter ownership.
`tags`[String!] The updated tags to associate the recruiter with.
`externalIdentifier`String An identifier associated with the company recruiter from an external system.
`managesWorkers`Boolean Whether the recruiter manages workers for this company relationship. When null, the company-level default is used.
`customFieldValues`[CustomFieldTypeValueInput!] The custom fields for the company recruiter.

UpdateCustomFieldInput

The input for updating a custom field.

Fields
`customField`ID! The ID of the custom field to update.
`fieldType`CustomFieldType! SINGLE_SELECT The custom field type. Updating a field type is restricted if the custom field already has values.
`title`String! The title or label of the custom field.
`slug`String A unique human-readable key for the custom field, preferably in a slug format with lowercase and hyphens to replace spaces. The key is only unique within the same account.
`description`String The description of the custom field.
`settings`CustomFieldSettingsInput! The settings to apply to the custom field.
`visibility`CustomFieldVisibility! The visibility of the custom field.
`approval`Boolean Whether the field is enabled for approval workflows.
`apiOnly`Boolean Configures the field to be enabled for api updates only.
`workerInputAllowed`Boolean Configures the field to allow worker input. When enabled, workers can provide values for this field through the worker API.
`recruiterInputAllowed`Boolean Configures the field to allow recruiter (staffing agency) input. When enabled, recruiters can provide values for this field through the recruiter API.
`options`[CustomFieldCustomFieldOptionInput!] The list of options which will be available for custom field values. Only applies to some field types (e.g. `SINGLE_SELECT`).

UpdateJobCandidatePreferredInput

The details for updating the “preferred” status of a job candidate.

Fields
`jobCandidate`ID! The job candidate to update.
`isPreferred`Boolean! Whether the candidate is preferred or not.

UpdateJobCandidateStatusInput

The details for updating a job candidate status.

Fields
`jobCandidate`ID! The job candidate to update.
`status`JobCandidateStatus! The status to update the job candidate to.
`statusReason`JobCandidateStatusReason The reason for changing the status of the job candidate.
`statusComment`String Open text to leave internal additional information on the status reason
`feedback`String The shared feedback in case the candidate already had a hire.

UpdateJobInput

The input for updating an existing job.

Use this after createJob to set the complete job details — description, rates, dates, location, visibility, and more. All fields are optional; only provided fields are updated.

Setting published to true publishes the job and makes it visible according to its visibility settings. Publication cannot be undone.

Fields
`id`ID! The ID of the job.
`locale`Locale An optional locale for the job. If set, skills and industries will use the locale’s spelling.
`name`String The name of the job.
`description`String The description required for the job.
`skills`[String!] The skills required for the job.
`attachments`[ID!] The files to be attached to the job.
`association`Association The project type of the job.
`expectedExperienceLevel`[ExpectedExperienceLevel!] The expected experience level required for the job.
`locationPreference`LocationPreferenceInput The location preference of the job.
`location`AddressInput The location information of the job.
`rateType`RateInput The rate unit, amount, and range for the job.
`paymentScheme`PaymentScheme The payment scheme that the job will use.
`startDate`Date The start date of the job. If this is set to `null`, we will assume that the job should start as soon as possible.
`endDate`Date The end date of the job. If this is set to `null`, we will assume that the job’s end date is undetermined.
`startDateTimeframe`JobStartTimeframe The timeframe of the job start.
`endDateTimeframe`JobEndTimeframe The timeframe of the job end.
`isExtensionAvailable`Boolean If the job will extend.
`evaluationPeriod`EvaluationPeriod The period of time required to reply to candidates.
`languages`[LanguageInput!] The languages required for the job.
`industries`[ID!] The industries that the worker requires experience in.
`owners`[ID!] The owners of the job posting.
`requiredWorkers`Int The number of required workers.
`visibility`[JobVisibility!] This controls via which channels the job can be shared. It is therefore important to select which audiences should be allowed to see the job listing.
`customFieldValues`[CustomFieldTypeValueInput!] Additional custom fields for the job. Details specified in this will only be visible to you and your team members, not to workers.
`published`Boolean Whether the job should be published. Note: Job publication cannot be undone.
`removed`Boolean Whether the job has been removed/discarded while being published and before having any hires.
`removedCause`String Optionally specify a reason for removing a Job. Note: This field is only relevant when the removed field is set to true, meaning it will not be used if provided on its own.
`externalIdentifier`String An identifier associated with the job from an external system.

UpdateMilestoneInput

The input for updating a single milestone.

Fields
`id`ID! The ID of the milestone.
`name`String The name of the milestone.
`purchaseOrderNumber`String The Purchase Order (PO) number for the milestone.
`dueDate`Date The due date for the milestone.
`amount`Float The total cost for the milestone.

UpdateMilestonesInput

The input for updating one or more milestones.

Fields
`milestones`[UpdateMilestoneInput!]! The milestones to update.

UpdateNoteInput

An input for updating a note.

Fields
`id`ID! The ID of the note to be updated.
`body`String The body of the note to be updated.
`title`String The title of the note to be updated.

UpdatePasswordInput

The details required to update a user’s password.

Fields
`currentPassword`String! The current password for the user.
`password`String! The new password for the user.
`passwordConfirmation`String! The confirmation of the password for the user.

UpdatePaymentRequestInput

The input used for updating a payment request.

Fields
`id`ID! The ID of the payment request to update.
`startDate`Date The date that the payment request started.
`endDate`Date The date that the payment request ended (if applicable).
`expenseReports`[ID!] The expense reports for the payment request.
`rate`Float The rate for the payment request.
`billableTime`Float The billable time for the payment request.
`billableTotal`Float The billable total for the payment request.
`comments`String Comments related to the payment request.
`taxLines`[TaxLineInput!] A list of tax lines.
`timesheet`ID The timesheet to link to the payment request.
`purchaseOrderNumber`String The purchase order number for the payment request.

UpdateProjectInput

An input for updating an existing project.

Fields
`id`ID! The ID of the project.
`name`String The name of the project.
`description`String The description of the project.
`internalBudget`Decimal The internal budget of the project.
`owners`[ID!] The owners of the project.
`externalIdentifier`String An identifier associated with the project from an external system.

UpdateRecruiterCandidateInput

The details for updating a recruiter candidate relationship.

Fields
`id`ID! The recruiter relationship to update.
`jobTitle`String The job title to update.
`currency`String The currency to update.
`hourlyRate`Float The hourly rate to update.
`dailyRate`Float The daily rate to update.
`monthlyRate`Float The monthly rate to update.
`tags`[String!] The updated tags to associate the relationship with.
`links`[String!] The updated links to associate the relationship with.
`files`[ID!] The updated files to associate the relationship with.

UpdateTimesheetInput

The input used for updating a timesheet.

Fields
`id`ID! The ID of the timesheet to update.
`startDate`Date The start date of the timesheet.
`endDate`Date The end date of the timesheet.
`registrations`[TimesheetRegistrationInput!] A list of registrations to add to the timesheet.
`files`[ID!] A list of files to add to the timesheet.

UpdateTimesheetRegistrationInput

The input used for updating a timesheet registration.

Fields
`id`ID! The ID of the timesheet registration to update.
`startTime`Time The start time of the timesheet registration.
`endTime`Time The end time of the timesheet registration.
`duration`Float The duration of the timesheet registration.
`unit`TimesheetRegistrationDurationUnit The unit of measurement for the timesheet registration.
`comments`String The comments for the timesheet registration.
`invoiceReferenceNumber`String The invoice reference number associated with the timesheet registration.
`externalIdentifier`String An identifier associated with the timesheet registration from an external system.
`isBillable`Boolean Whether the timesheet registration is billable.

UpdateTrustedContactInput

The details for editing a trusted contact.

Fields
`id`ID! The ID of the trusted contact to be edited.
`links`[String!] The trusted contact links.
`attachments`[ID!] The trusted contact attachments.
`skills`[String!] The skills to associate with the trusted contact.
`externalIdentifier`String An identifier associated with the trusted contact from an external system.
`customFieldValues`[CustomFieldTypeValueInput!] The custom fields for the trusted contact. BETA. Custom fields on Workers are currently available for a subset of users.

UpdateUserGroupInput

An input for updating an existing group.

Fields
`id`ID! The ID of the group.
`name`String The name of the group.
`description`String The description of the group.
`status`UserGroupStatus The status of the user group.
`users`[ID!] The users of the group.

UpdateWebhookInput

The input used for updating a webhook.

Fields
`id`ID! The webhook to be updated.
`title`String! The title of the webhook.
`description`String The description of the webhook.
`url`String! The URL of the webhook.
`secret`String The secret of the webhook. If using OAuth this is the client secret. If you are not updating the secret, set it to null.
`isActive`Boolean Whether the webhook is active or not.
`clientId`String The client ID of the webhook, when using OAuth.
`clientUrl`String The client URL of the webhook, when using OAuth.
`subscribedEvents`[WebhookEventType!] The event types that this webhook should be subscribed to. If null, the subscribed events will not be changed. If an empty array, the webhook will not receive any events.

UpdateWorkerCustomFieldValuesInput

The input for updating custom field values as a worker.

Fields
`appliesTo`ID! The entity that supports custom fields (e.g., TrustedContact).
`values`[CustomFieldTypeValueInput!]! Collection of custom field values to update.

UpdateWorkerInput

The details for updating a worker.

Fields
`id`ID! The ID of the worker.
`jobTitle`String The job title that the worker has.
`links`[String!]! The links the worker has.
`skills`[String!]! The skills to associate with the worker.

UpdateWorkflowApproverInput

An approver node in the update workflow tree.

Fields
`id`ID A temporary ID for this node.
`parent`ID The temporary ID of the parent rule node.
`children`[ID!] The temporary IDs of any child nodes.
`data`[ID!]! The user groups to assign as approvers for the parent rule.

UpdateWorkflowInput

The input for updating an existing workflow tree. Replaces the entire structure.

Fields
`root`UpdateWorkflowRootInput! The updated root node (approval flow details).
`rules`[UpdateWorkflowRuleInput!] The updated rule nodes (conditions).
`approvers`[UpdateWorkflowApproverInput!] The updated approver nodes (user group assignments).

UpdateWorkflowRootInput

The root node of an update workflow tree.

Fields
`id`ID A temporary ID for this node, used by child nodes to reference it.
`children`[ID!] The temporary IDs of rule nodes that are direct children of this root.
`data`UpdateApprovalDataInput! The updated approval flow details.

UpdateWorkflowRuleInput

A rule node in the update workflow tree.

Fields
`id`ID A temporary ID for this node.
`parent`ID The temporary ID of the parent node.
`children`[ID!] The temporary IDs of child approver nodes.
`data`[UpdateWorkflowVariableFieldInput!] The updated conditions for this rule.

UpdateWorkflowVariableFieldInput

The input for updating a condition on an approval rule.

Fields
`id`String! The identifier of the workflow variable or custom field.
`rule`WorkflowVariableFieldRuleInput! The updated comparison operator and threshold value.

UpdateWorksomeIntelligenceConsentInput

An input for updating user consent to Worksome Intelligence.

Fields
`consent`Boolean! Whether or not to consent to Worksome Intelligence.

UploadFileInput

The input used for uploading a file.

Fields
`owner`ID! The ID of the account that owns this file.
`name`String! The name of the file that will be uploaded.
`size`Int! The size of the file that will be uploaded in bytes.
`mimeType`String! The mime of the file that will be uploaded.

VerifySmsMultiFactorInput

An input for verifying a newly-created SMS multi-factor authentication implementation.

Fields
`id`ID! The ID of the SMS multi-factor authentication implementation to verify.
`code`String! The current SMS authentication code to verify the implementation with.

VerifyTotpMultiFactorInput

An input for verifying a newly-created TOTP multi-factor authentication implementation.

Fields
`id`ID! The ID of the TOTP multi-factor authentication implementation to verify.
`code`String! The current TOTP authentication code to verify the implementation with.

WorkflowVariableFieldRuleInput

A condition definition specifying a variable, comparison operator, and threshold value.

For example, to create a condition “hourly rate greater than 100”, set id to the hourly rate variable identifier, operator to GREATER_THAN, and value to "100".

Fields
`value`String! The threshold value to compare against (as a string).
`operator`WorkflowVariableOperator! The comparison operator (e.g. equals, greater than, less than).