Objects

Object types are the most common type within GraphQL, they represent an object that can be fetched from the Worksome GraphQL API.

Address

An address.

Fields
`address`String The address.
`postCode`String The post code (ZIP code).
`city`String The city.
`state`String The state.
`country`Country The country object.
`formattedAddress`String The formatted address string.

Related Types

References: Country

Referenced by: Company, ComplianceDataAddress, Contract, Job, Partner, Worker

Approval

An approval flow that defines a review process triggered by specific events on hires.

Approvals are configured by companies to require sign-off before certain actions take effect. Currently, approval flows can only be applied to hires. The supported automatic triggers are:

- HIRE_CREATED — require approval when a new hire is created (e.g. rate exceeds a budget threshold). - HIRE_CHANGED — require approval when an existing hire’s contract is modified (e.g. rate or end date changes). - CLASSIFICATION_CREATED — require approval when a worker classification (e.g. IR35, US worker classification) is completed on a hire.

A trigger of NONE means the approval flow will not be automatically evaluated.

Approval flows cannot currently be applied to jobs, payment requests, or other entities.

Each approval has a trigger (the event that starts the flow), one or more rules (conditions that determine when approval is needed), and approvers (user groups who must review and approve). When a matching event occurs, an approval request is created and the action is blocked until all required approvers have acted. The outcome of rejection depends on the trigger: for HIRE_CREATED, the hire is cancelled; for HIRE_CHANGED, the pending contract change is reverted; for CLASSIFICATION_CREATED, the classification result is discarded.

Use the Workflow type and its mutations (createWorkflow, updateWorkflow) to manage approvals as a complete tree structure (root + rules + approvers) in a single operation.

Fields
`id`ID! The ID of the approval flow.
`name`String! The display name of the approval flow.
`version`Int! The version number. Each update to an approval creates a new version.
`status`ApprovalStatus! Whether this approval flow is currently active, inactive, or archived. Only `ACTIVE` approvals are evaluated when triggering events occur.
`trigger`ApprovalTrigger! The event that triggers this approval flow. All triggers currently apply to hires only. Possible values: - `HIRE_CREATED` — evaluated when a new hire is created. - `HIRE_CHANGED` — evaluated when a hire’s contract terms are modified. - `CLASSIFICATION_CREATED` — evaluated when a worker classification completes on a hire. Approval flows for jobs, payment requests, or other entities are not currently supported.
`description`String A human-readable description of the approval flow’s purpose.
`company`Company! The company that owns this approval flow.
`approvalRules`[ApprovalRule!]! The rules that define conditions and approvers for this approval flow. Each rule specifies conditions (e.g. “rate > 100”) and a sequence of approver groups. When the trigger fires, the system evaluates rules to determine which approval path applies.
`createdAt`DateTime! The date and time that the approval was created.
`updatedAt`DateTime! The date and time that the approval was last updated.
`latestVersionId`String! The ID of the latest version of this approval flow. Approvals are versioned — when updated, a new version is created. Use this to navigate to the most recent version.

Related Types

References: ApprovalRule, ApprovalStatus, ApprovalTrigger, Company, DateTime

Referenced by: ApprovalApprovable, ApprovalPaginator, ApprovalRule

ApprovalApprovable

An approval request — a runtime instance created when a triggering event on a hire matches an approval rule.

Approval requests are currently only created for hires. The supported triggering events are: - A hire is created (HIRE_CREATED) - A hire’s contract is changed (HIRE_CHANGED) - A worker classification is completed on a hire (CLASSIFICATION_CREATED)

Jobs, payment requests, and other entities do not go through approval workflows.

When a trigger fires and an active approval rule’s conditions match, the system creates an ApprovalApprovable linking the hire to the matched rule. The outcome of rejection depends on the trigger: for HIRE_CREATED, the hire is cancelled; for HIRE_CHANGED, the pending contract change is reverted; for CLASSIFICATION_CREATED, the classification result is discarded.

Each approval request tracks its history of actions through approvalStates — showing who approved, rejected, or requested changes and when.

Fields
`id`ID! The ID of the approval request.
`approval`Approval! The approval flow that generated this request.
`approvalRule`ApprovalRule! The specific rule whose conditions matched to create this request.
`approvalStates`[ApprovalState!]! The history of actions taken on this request (approvals, rejections, change requests). States are recorded in chronological order as each approver acts.
`approvable`Approvable The item that requires approval (e.g. a hire).
`viewerCanAction`Boolean! Whether the authenticated user can take action on this approval request. Returns `true` when the user is a member of the next approver group in the sequence and the request is still pending their review.

Related Types

References: Approvable, Approval, ApprovalRule, ApprovalState

Referenced by: ApprovalApprovablePaginator, ApprovalState

ApprovalApprovablePaginator

A paginated list of ApprovalApprovable items.

Fields
`paginatorInfo`PaginatorInfo! Pagination information about the list of items.
`data`[ApprovalApprovable!]! A list of ApprovalApprovable items.

Related Types

References: ApprovalApprovable, PaginatorInfo

ApprovalPaginator

A paginated list of Approval items.

Fields
`paginatorInfo`PaginatorInfo! Pagination information about the list of items.
`data`[Approval!]! A list of Approval items.

Related Types

References: Approval, PaginatorInfo

Referenced by: Hire

ApprovalRule

A rule within an approval flow that defines when approval is required and who must approve.

Each rule belongs to an approval and contains two key parts: 1. Conditions (rules): Variable comparisons that determine whether this rule applies. For example, “hourly rate > 100” or “budget >= 50000”. Conditions use workflow variables (system fields like rate/budget, or custom fields configured on the company). 2. Approvers: An ordered sequence of user groups who must review and approve items that match this rule’s conditions. Approvers are processed in position order.

When a triggering event occurs (e.g. a hire is created), the system evaluates each active rule’s conditions against the item. If a rule matches, approval requests are sent to its approvers.

Fields
`id`ID! The ID of the approval rule.
`approval`Approval! The approval flow that this rule belongs to.
`fields`[CustomField!]! The custom fields referenced by this rule’s conditions. These are the company-configured fields used as variables in the rule’s conditions.
`rules`[WorkflowVariableRule!]! The variable conditions that determine when this rule applies. Each condition compares a workflow variable (e.g. hourly rate, budget, or a custom field) against a value using an operator (e.g. greater than, equals). All conditions must be met for the rule to trigger.
`approvers`[Approver!]! The user groups assigned to review items that match this rule, in approval order.
`approverCount`Int! The number of approver groups assigned to this rule.
`createdAt`Date! The date that the approval rule was created.
`updatedAt`Date! The date that the approval rule was updated.

Related Types

References: Approval, Approver, CustomField, Date, WorkflowVariableRule

Referenced by: Approval, ApprovalApprovable, ApprovalRulePaginator, Approver, WorkflowVariableRule

ApprovalRulePaginator

A paginated list of ApprovalRule items.

Fields
`paginatorInfo`PaginatorInfo! Pagination information about the list of items.
`data`[ApprovalRule!]! A list of ApprovalRule items.

Related Types

References: ApprovalRule, PaginatorInfo

ApprovalState

A recorded action on an approval request — an entry in the approval audit trail.

Each time an approver acts on an approval request (approves, rejects, or requests changes), an ApprovalState is created to record the decision, the user who made it, and any message. The system also creates states when an approval is automatically cancelled (e.g. the hire was cancelled or the job was closed).

Fields
`id`ID! The ID of this approval action record.
`state`ApprovalApprovableState! The action that was taken: `REQUESTED`, `APPROVED`, `REJECTED`, `NEEDS_CHANGE`, or `CANCELLED`.
`actionedBy`User! The user who took this action.
`message`String An optional message provided by the reviewer explaining their decision.
`cancellationReason`ApprovalCancellationReason The reason the approval was automatically cancelled, if applicable. Only present when `state` is `CANCELLED`. For example, the hire may have been cancelled or the associated job closed before the approval was completed.
`approver`Approver! The approver group that this action was taken on behalf of.
`approvalApprovable`ApprovalApprovable! The approval request that this action belongs to.
`createdAt`DateTime The date and time that this action was recorded.

Related Types

References: ApprovalApprovable, ApprovalApprovableState, ApprovalCancellationReason, Approver, DateTime, User

Referenced by: ApprovalApprovable, ApprovalStatePaginator, Classification, Hire

ApprovalStatePaginator

A paginated list of ApprovalState items.

Fields
`paginatorInfo`PaginatorInfo! Pagination information about the list of items.
`data`[ApprovalState!]! A list of ApprovalState items.

Related Types

References: ApprovalState, PaginatorInfo

Approver

An approver assignment — a user group assigned to review items that match an approval rule.

Approvers are ordered by position within a rule. When an approval request is created, the system notifies the first approver group (position 1). Once they approve, the next group (position 2) is notified, and so on. All approvers in the sequence must approve for the overall request to be approved.

Fields
`id`ID! The ID of the approver assignment.
`approvalRule`ApprovalRule! The approval rule this approver is assigned to.
`userGroup`UserGroup! The user group whose members can act on approval requests for this rule.
`position`Int! The position in the approval sequence (1-based). Lower positions are asked to approve first.
`createdAt`Date! The date that the approver assignment was created.
`updatedAt`Date! The date that the approver assignment was last updated.

Related Types

References: ApprovalRule, Date, UserGroup

Referenced by: ApprovalRule, ApprovalState, ApproverPaginator

ApproverPaginator

A paginated list of Approver items.

Fields
`paginatorInfo`PaginatorInfo! Pagination information about the list of items.
`data`[Approver!]! A list of Approver items.

Related Types

References: Approver, PaginatorInfo

AvailableMarket

A market that an account is available to work in, including the specific regions within that market.

Fields
`market`Market! The market.
`regions`[AvailableRegion!]! The regions within the market that the account is available in.

Related Types

References: AvailableRegion, Market

Referenced by: Recruiter

AvailableRegion

A specific region within a market that an account is available to work in.

Fields
`id`Int! The unique identifier for the region.
`name`String! The name of the region.
`isOnSite`Boolean! Whether the account is available for on-site work in this region.
`isRemote`Boolean! Whether the account is available for remote work in this region.

Related Types

Referenced by: AvailableMarket

BankDetail

Bank account details.

Fields
`id`ID! The ID of the bank account details.
`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`Bban The BBAN information, if applicable.
`iban`String The bank account IBAN, if applicable.
`swift`String The bank account SWIFT code, if applicable.

Related Types

References: Bban

Referenced by: ComplianceDataBankDetail

Batch

A batch of items for processing.

Batches are a way to group multiple items (such as payment requests) together so that you can perform bulk actions on them. They’re mainly intended for operational workflows inside the platform (e.g., approving or processing large sets of items at once). For most external integrations, batches are not usually needed – you’ll likely want to work directly with the individual items instead.

Fields
`id`ID! The ID of the batch.
`name`String! The name of the batch.
`type`BatchType! The type of batch.
`account`Account! The account that owns the batch.
`itemsCountByStatus`Int! The number of items in the batch that have the specified statuses.
`createdAt`DateTime! The date and time when the batch was created.
`updatedAt`DateTime! The date and time when the batch was last updated.
`deletedAt`DateTime The date and time when the batch was deleted (if soft deleted).
`items`BatchItemPaginator! The items in the batch.

Related Types

References: Account, BatchItemPaginator, BatchType, DateTime

Referenced by: BatchPaginator, RunBatchActionResponse

BatchItemPaginator

A paginated list of BatchItem items.

Fields
`paginatorInfo`PaginatorInfo! Pagination information about the list of items.
`data`[BatchItem!]! A list of BatchItem items.

Related Types

References: BatchItem, PaginatorInfo

Referenced by: Batch

BatchPaginator

A paginated list of Batch items.

Fields
`paginatorInfo`PaginatorInfo! Pagination information about the list of items.
`data`[Batch!]! A list of Batch items.

Related Types

References: Batch, PaginatorInfo

Referenced by: PaymentRequest

Bban

The BBAN type 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.

Related Types

Referenced by: BankDetail

Bid

Represents a bid sent on a job.

Fields
`id`ID! The ID of the bid.
`status`BidStatus! The status of the bid.
`job`Job! The job which the bid was made on.
`conversation`Conversation! The conversation which contains the bid.
`message`Message! The message with the bid.
`worker`Worker! The worker that this bid belongs to.
`supplier`Account The supplier account for this bid, if applicable.
`rate`Float The rate proposed by the worker.
`rateType`RateType The rate type for the bid.
`currency`String! The currency of the bid.
`brief`String The brief / cover text submitted with the bid.
`links`[String!]! External links submitted with the bid.
`files`[File!]! Files attached to the bid.
`fees`[Fee!]! The fees associated with this bid.
`workerType`CandidateSubmissionType Whether the supplier directly manages the worker (Managed) or is referring an independent worker they do not manage (Referred). Null on bids made before this distinction was tracked.

Related Types

References: Account, BidStatus, CandidateSubmissionType, Conversation, Fee, File, Job, Message, RateType, Worker

Referenced by: BidPaginator, JobCandidate

BidPaginator

A paginated list of Bid items.

Fields
`paginatorInfo`PaginatorInfo! Pagination information about the list of items.
`data`[Bid!]! A list of Bid items.

Related Types

References: Bid, PaginatorInfo

Referenced by: Job

BusinessEntity

A business entity.

Fields
`id`ID! The ID of the business entity.
`type`BusinessEntityType! The business entity type.
`name`String! The name of the business entity type.
`localisedName`String! The localised friendly name of the business entity type.
`companyName`String The company name for the business entity.
`companyNumber`String The company number for the business entity.
`taxNumber`String The tax number for the business entity.
`nationalIdentifier`String The national identifier for the business entity (e.g. Canadian SIN).
`companyNumberValidationStatus`CompanyNumberValidationStatus The validation status of the company number against the relevant external authority (e.g. KvK for NL). Null when the business entity type is not subject to external validation in its market.

Related Types

References: BusinessEntityType, CompanyNumberValidationStatus

Referenced by: BusinessEntityPaginator, ComplianceDataBusinessEntity, Contract, Invoice, Partner, Worker

BusinessEntityPaginator

A paginated list of BusinessEntity items.

Fields
`paginatorInfo`PaginatorInfo! Pagination information about the list of items.
`data`[BusinessEntity!]! A list of BusinessEntity items.

Related Types

References: BusinessEntity, PaginatorInfo

Referenced by: Worker

Classification

A classification represents a worker classification (SDS/WCR) for a hire. This can be various types of classifications like IR35, US Worker Classification, etc.

Fields
`id`ID! The unique identifier of the classification
`user`User! The user who created this classification
`hire`Hire! The hire this classification belongs to
`company`Company! The company that requested this classification
`freelancer`Worker! The worker this classification is for.
`type`ClassificationType! The type of classification (e.g., IR35, US Worker Classification)
`description`String Describes this classification type
`complianceName`String! The name of the compliance this classification is using
`status`ClassificationStatus! The current status of the classification
`acceptedStatus`Boolean! Whether this classification has been accepted by the company
`result`ClassificationResultDetails! The result of the classification with detailed outcome information
`pdfUrl`String! URL to download the PDF version of this classification (WCR/SDS)
`overridesAnother`Boolean! Whether this classification overrides another classification
`overrideReason`String The reason provided when this classification was overridden (null if not overridden)
`overrideUser`User The user who performed the override (null if not overridden)
`disputesAnother`Boolean! Whether this classification is the result of a dispute on another classification (when applicable)
`hasUnknownAnswers`Boolean! Whether there are any questions with an unknown answer in the classification questionnaire
`hasUpdatedAnswers`Boolean! Whether there are questions with an updated answer from the Worker in the classification questionnaire.
`hasWorkerCompletedAnswers`Boolean! Whether all questions for the worker has been resolved.
`canChange`Boolean! Whether this classification is allowed to be changed
`canOverride`Boolean! Whether this classification can be overridden
`hasHireBlockingCondition`Boolean! Whether the hire has blocking conditions that prevent the classification from continuing
`currentApprovalState`ApprovalState The overall state for approvals on the classification with a given trigger.
`hasPendingApproval`Boolean! Whether there is an approval request pending for the classification on the hire
`title`String! The user-friendly title for this classification
`wcrTerm`String! The WCR term used in the UI for this classification
`hasUpdatedHire`Boolean! Deprecated Whether the hire has been updated since the determination input was provided
`isReclassificationRequired`Boolean! Whether the hire requires a reclassification
`isClassificationActionRequired`Boolean! Whether the current classification requires action from the user to be completed.
`endClientInputComplete`Boolean! Whether the end client has completed their classification input (always true for non-supplier hires)
`createdAt`DateTime The date and time the classification was created.
`updatedAt`DateTime The date and time the classification was last updated.

Related Types

References: ApprovalState, ClassificationResultDetails, ClassificationStatus, ClassificationType, Company, DateTime, Hire, User, Worker

Referenced by: ClassificationPaginator, Hire

ClassificationPaginator

A paginated list of Classification items.

Fields
`paginatorInfo`PaginatorInfo! Pagination information about the list of items.
`data`[Classification!]! A list of Classification items.

Related Types

References: Classification, PaginatorInfo

ClassificationResultDetails

Detailed information about a classification result including outcome, label, and title.

Fields
`outcome`ClassificationResult! Canonical enum value (business logic)
`label`String! Short, user-friendly single-word/phrase
`title`String! Longer descriptive title of outcome

Related Types

References: ClassificationResult

Referenced by: Classification

Client

The relationship between a worker and a company as seen from the workers perspective.

An equivalent relationship can be found for companies called TrustedContacts.

Fields
`id`ID! The ID of the client.
`company`Company! The client company account.
`status`ContactStatus! Status of the client relationship.
`statusUpdatedAt`Date! The date that the status of the contact was last updated.
`invitedAt`Date! The date that an invite as a contact was sent.
`token`String! The unique invite token used to accept invites from clients.
`origin`TrustedContactOrigin! The origin of the contact.
`originChannel`TrustedContactOriginChannel! The channel of origin of the contact.
`requiresOnboarding`Boolean! If the client has onboarding steps that need to be completed as part of the relationship.
`canLeaveClient`Boolean! Whether it’s possible at this time for the worker to end their relationship with the client.
`onboardingDocuments`[OnboardingDocument!]! The onboarding documents associated with the client relationship.
`onboardingStatus`TrustedContactOnboardingStatus The onboarding status of the client relationship.
`requiredCustomFieldsComplete`Boolean! Whether all required worker-editable custom fields have been filled.
`customFieldValues`[CustomFieldValue!]! The custom field values for the client relationship.

Related Types

References: Company, ContactStatus, CustomFieldValue, Date, OnboardingDocument, TrustedContactOnboardingStatus, TrustedContactOrigin, TrustedContactOriginChannel

Referenced by: Worker

Company

A company account — the primary hiring entity on Worksome.

Companies create jobs, manage a Talent Pool of trusted contacts, make hires, and process payments. A company may belong to one or more organisations and can work with staffing agencies and partners.

Fields
`id`ID! The ID of the company.
`name`String! The name of the company.
`currency`String! The company preferred currency.
`market`MarketCode! The market that the company is in.
`avatar`URL The avatar (or profile picture) for the company.
`profile`Profile The profile that the company has.
`contactInviteUrl`String The company full invite url.
`personalInviteUrl`String The personal invite URL for the authenticated user. This link allows auto-approval to the company’s Talent Pool.
`settings`CompanySettings The settings for the company.
`address`Address The address of the company.
`hasActiveWebhooks`Boolean! If the account has active webhooks.
`hasMultipleBusinessEntities`Boolean! If the account has multiple business entities.
`usedEngagementTypeSetups`[EngagementTypeSetup!]! All engagement type setups that the company has ever used when engaging with workers.
`externalIdentifier`String An identifier associated with the company from an external system.
`recruiterManagesMixedMode`Boolean! Whether staffing agency relationships can be individually configured as managed or referral. When true, each SA relationship can override the company default (staffingAgencyManagesWorker). When false, the company default applies uniformly to all SA relationships.
`trustedContacts`TrustedContactPaginator! The trusted contacts that the company has.
`teamMembers`UserPaginator! The team members that the company has.
`teamMembersAndOwners`UserPaginator! The team members and owners that the company has.
`organisations`OrganisationPaginator! The organisations that a company is a part of.
`customFields`CustomFieldPaginator! The custom fields that the company owns.
`staffingAgencies`CompanyRecruiterPaginator! The staffing agencies that the company has relationships with.

Related Types

References: Address, CompanyRecruiterPaginator, CompanySettings, CustomFieldPaginator, EngagementTypeSetup, MarketCode, OrganisationPaginator, Profile, TrustedContactPaginator, URL, UserPaginator

Referenced by: Approval, Classification, Client, CompanyPaginator, CompanyRecruiter, CompanySupplier, Contract, Hire, Invoice, Job, PaymentRequest, Project, TrustedContact, UserGroup

CompanyPaginator

A paginated list of Company items.

Fields
`paginatorInfo`PaginatorInfo! Pagination information about the list of items.
`data`[Company!]! A list of Company items.

Related Types

References: Company, PaginatorInfo

Referenced by: Organisation

CompanyRecruiter

A company recruiter relationship.

Fields
`id`ID! The ID of the company recruiter.
`email`String The mail of the recruiter.
`status`ContactStatus! Status of the company recruiter.
`token`String The token used to invite the recruiter.
`message`String The message sent to the recruiter when inviting them.
`recruiterFee`Float Deprecated The fee of the recruiter for the relationship.
`recruiterOwnershipDays`Int The days of ownership of the recruiter.
`recruiterOwnershipDaysLeft`Int The amount of days left of the ownership. Null when the staffing agency’s ownership never expires.
`recruiterManagesWorkers`Boolean! Whether the recruiter manages workers for this company relationship. Resolved from the per-relationship override if set, otherwise falls back to the company-level default.
`hasHires`Boolean! Whether there are any hires between this recruiter and company.
`recruiter`Recruiter! The recruiter for this company recruiter.
`company`Company! The company recruiter company.
`tags`[Tag!]! The tags applied to the relationship.
`externalIdentifier`String An identifier associated with the company recruiter from an external system.
`customFieldValues`[CustomFieldValue!]! The custom field values for the company recruiter.
`requiresOnboarding`Boolean! Whether the company requires onboarding for this staffing agency relationship.
`requiredCustomFieldsComplete`Boolean! Whether all required custom fields have been filled by the staffing agency.
`onboardingDocuments`[OnboardingDocument!]! Onboarding documents the staffing agency must review for this client.
`onboardingStatus`RecruiterOnboardingStatus The onboarding status of the staffing agency.
`invitedAt`Date! The date the contact was invited.
`fees`[Fee!]! The fees associated with this staffing agency relationship.
`compliances`[Compliance!]! Compliance requirements for this staffing agency as seen by the pivot’s company. The viewing company is unambiguous here (it’s the pivot’s company), so per-company review state never depends on session state. When `names` is omitted, the curated review-modal subset is returned. Pass explicit names to filter to a specific compliance.
`notes`NotePaginator! Notes added to the recruiter releationship by the company.

Related Types

References: Company, Compliance, ContactStatus, CustomFieldValue, Date, Fee, NotePaginator, OnboardingDocument, Recruiter, RecruiterOnboardingStatus, Tag

Referenced by: CompanyRecruiterPaginator, Recruiter

CompanyRecruiterPaginator

A paginated list of CompanyRecruiter items.

Fields
`paginatorInfo`PaginatorInfo! Pagination information about the list of items.
`data`[CompanyRecruiter!]! A list of CompanyRecruiter items.

Related Types

References: CompanyRecruiter, PaginatorInfo

Referenced by: Company

CompanySettings

Company settings.

Fields
`projectTracking`Boolean Whether project tracking is enabled.
`requiredJobBudget`Boolean Whether job budget is required.
`requiredJobRate`Boolean Whether a pay rate is required on jobs before they can be published. This is controlled by a company-settings.
`multiCurrencyContractsDisabled`Boolean Whether a company has enabled multi currency contracts.
`staffingAgencyManagesWorker`Boolean Whether a company has enabled managing of workers by staffing agencies (company-level default). This can be overridden per staffing agency relationship and per hire.
`defaultMessageRemindWorkerToBill`String The company default message for reminding workers to bill.

Related Types

Referenced by: Company

CompanySupplier

A link between a client company and a supplier account (Company acting as a staffing agency).

Fields
`id`ID! The ID of the company supplier.
`company`Company! The client company.
`supplier`Account The supplier account.

Related Types

References: Account, Company

Referenced by: CompanySupplierPaginator

CompanySupplierPaginator

A paginated list of CompanySupplier items.

Fields
`paginatorInfo`PaginatorInfo! Pagination information about the list of items.
`data`[CompanySupplier!]! A list of CompanySupplier items.

Related Types

References: CompanySupplier, PaginatorInfo

Compliance

A compliance requirement that must be met for business processes to proceed.

Fields
`actor`ComplianceActorTypes! The party responsible for completing this compliance
`name`ComplianceName! Unique identifier for this compliance requirement
`applicable`Boolean! Whether this compliance applies to the current context
`completed`Boolean! Whether this compliance has been completed
`completedAt`DateTime When this compliance was fulfilled, if known
`type`String Optional categorization of the compliance
`title`String! Human readable title describing the compliance
`description`String! Detailed description of what needs to be done
`action`ComplianceAction Optional action details if user input is required
`validationDetails`ComplianceValidationDetails Details about validation status and any blocking issues
`data`[ComplianceData!]! Typed data associated with this compliance.

Related Types

References: ComplianceAction, ComplianceActorTypes, ComplianceData, ComplianceName, ComplianceValidationDetails, DateTime

Referenced by: CompanyRecruiter, Gate, Hire, TrustedContact

ComplianceAction

A compliance action represents an action that can be taken to complete a compliance requirement.

Fields
`action`String! URL or route where the action can be performed.
`title`String! Title of the action button or link
`description`String! Description of what the action will do
`buttonText`String Optional button copy text
`tooltip`String Optional tooltip text for additional context
`inputIdentifier`String Identifier for the input form required to complete this action. When set, the frontend resolves and renders the corresponding input view inline.

Related Types

Referenced by: Compliance

ComplianceClassificationQuestion

A single question/answer pair within a classification.

Fields
`text`String! The question as shown to the worker.
`helpText`String Additional guidance shown alongside the question, if any.
`answer`ComplianceClassificationAnswer The recorded answer. Null when the question is unanswered.

Related Types

References: ComplianceClassificationAnswer

Referenced by: ComplianceDataClassification

ComplianceDataAddress

An address associated with a compliance (residential address, work location, etc.). Wraps the existing Address type so the frontend can query any field.

Fields
`title`String Optional heading rendered above the address, e.g. ‘Residential address’.
`address`Address! The address record.

Related Types

References: Address

ComplianceDataBankDetail

Bank account details associated with a compliance. Wraps the existing BankDetail type so the same fragment can be reused across owner-facing and reviewer-facing flows. The wrapper always resolves so the frontend can render “Bank details on file” rows; bankDetail is null for viewers who aren’t authorised to read the underlying fields (everyone except the account owner and companies on external payments with visibility to the worker), avoiding the @passes field guards bubbling up and nulling out the entire compliance row.

Fields
`title`String Optional heading, e.g. ‘Primary bank account’.
`bankDetail`BankDetail The bank account record. Null when the viewer can’t read the details.

Related Types

References: BankDetail

ComplianceDataBusinessEntity

A business entity associated with a compliance, typically the freelancer’s primary business entity (company details, tax numbers, etc.).

Fields
`businessEntity`BusinessEntity! The business entity record. Reuses the existing `BusinessEntity` type so any field on it can be queried.

Related Types

References: BusinessEntity

ComplianceDataClassification

A determination-style questionnaire result (IR35, NL/Global/US worker classification). Each question carries its text, optional help text, and the recorded answer (if any).

Fields
`questions`[ComplianceClassificationQuestion!]! The answered questions that make up the classification.

Related Types

References: ComplianceClassificationQuestion

ComplianceDataField

A single label/value pair. Null value is preserved so the UI can render semantically-empty fields (e.g. “Not subject to VAT”) rather than hiding them.

Fields
`label`String! The field label (e.g. a question or attribute name).
`value`String The field value, formatted for display by the backend.

Related Types

Referenced by: ComplianceDataGroup

ComplianceDataFile

A file associated with a compliance (certificate, proof document, etc.).

Fields
`title`String Optional display title, e.g. ‘KvK certificate’ or ‘Insurance policy’.
`file`File! The compliance-related file.

Related Types

References: File

ComplianceDataGroup

Titled collection of label/value fields. Use when a compliance emits multiple semantically-distinct groups (e.g. “Primary contact” + “Emergency contact”). For a single flat list of fields, skip the wrapper and emit top-level ComplianceDataField entries instead.

Fields
`title`String Optional heading rendered above the fields.
`fields`[ComplianceDataField!]! The fields in the group.

Related Types

References: ComplianceDataField

ComplianceDataUser

A user associated with a compliance, typically an attribution such as ‘Reviewed by’. Wraps the existing User type so the frontend can query avatar, name, etc.

Fields
`title`String Optional label describing the user’s relation to the compliance.
`user`User! The user record.

Related Types

References: User

ComplianceValidationDetails

Validation details for a compliance requirement.

Fields
`isValid`Boolean! Whether the compliance passes all validation checks
`issues`[String!]! List of validation issues preventing completion

Related Types

Referenced by: Compliance

Contract

A legal agreement between a company and a worker within a hire.

A hire may have multiple contracts over its lifetime (e.g. an initial draft, an active contract, and amended versions). The activeContract on a hire is the currently accepted agreement between the parties.

Fields
`id`ID! The ID of the contract.
`jobName`String! The name of the contract that the job is for.
`jobDescription`String! The description of the contract that the job is for.
`locationPreference`LocationPreference The location preference of the contract.
`status`ContractStatus! The status of the contract.
`startDate`Date The date that the contract started.
`endDate`Date The date that the contract ended.
`location`Address The address location associated to the contract.
`address`String The address of the contract.
`currency`Currency! The type of currency.
`rateType`RateType The unit of time when payment is due.
`rate`Float The payment amount per specified rate type.
`purchaseOrderNumber`String The Purchase Order (PO) number.
`companyCvr`String The company’s Central Virksomhed (Company) Registration (CVR) number. For more information, visit: https://datacvr.virk.dk
`pdfUrl`URL A URL of the actual contract. This URL will link to a PDF for the contract. This URL cannot be used for saving in external systems as it might change over time or be regenerated. If a permanent URL is needed for the contract, it should be stored in the clients own system.
`paymentTermMethod`PaymentTermMethod! The method of payment over the specified term.
`paymentTerm`Int! The term that the payment will be made within, in days. Example `paymentTerm: 10` means Worksome will pay the worker’s approved payment requests within 10 days.
`termsAccepted`Boolean! Whether the contract’s terms have been accepted.
`termsAcceptedAt`DateTime The date that the terms were accepted.
`workerAcceptedAt`DateTime The date that the terms were accepted by a worker.
`effectiveAt`DateTime The date a scheduled change takes effect. Null means the change applies immediately on signature; a future date means it is parked until then.
`workerSignature`String The submitted signature of the accepted worker.
`job`Job! The job for which the contract is for.
`worker`Worker The worker for which the contract is for.
`company`Company! The company for which the contract is for.
`companyContact`User The company contact person for the contract.
`businessEntity`BusinessEntity The business entity associated with the contract.
`companyName`String The company name associated with the contract.
`companyLocation`Address The company location associated with the contract.
`files`[File!]! The files attached to the contract (e.g. SOW, NDA, supporting documents).
`contractDocuments`[ContractDocument!]! The contract documents (e.g. KID, onboarding documents) generated for the contract. The Key Information Document is only included for the worker on the contract.
`milestoneDetails`MilestoneDetailPaginator! The latest milestone details at the time of creation of the contract.

Related Types

References: Address, BusinessEntity, Company, ContractDocument, ContractStatus, Currency, Date, DateTime, File, Job, LocationPreference, MilestoneDetailPaginator, PaymentTermMethod, RateType, URL, User, Worker

Referenced by: ContractPaginator, Hire

ContractDocument

A document associated with a contract (e.g. KID, onboarding document).

Fields
`id`ID! The ID of the contract document.
`docType`String The type of document (e.g. Key Information Document, Contract Document, Onboarding Document).
`pdfUrl`String URL to download the PDF version of this document.
`createdAt`DateTime The date and time the document was created.
`updatedAt`DateTime The date and time the document was last updated.

Related Types

References: DateTime

Referenced by: Contract

ContractPaginator

A paginated list of Contract items.

Fields
`paginatorInfo`PaginatorInfo! Pagination information about the list of items.
`data`[Contract!]! A list of Contract items.

Related Types

References: Contract, PaginatorInfo

Referenced by: Hire, MilestoneDetail

Conversation

A conversation between a company and a worker.

Fields
`id`ID! The ID of the conversation.
`subject`String! The subject line of the conversation.
`job`Job The job that the conversation is related to.
`latestMessage`Message The latest message sent in the conversation.
`url`URL! The URL for the conversation.
`viewerCanAccess`Boolean! Whether the authenticated user’s active account can open this conversation. Mirrors the check behind `url`, so do not render a link to `url` when this is `false` — the viewer would land on a “No access” page.
`createdAt`Date! The date that the conversation was created.
`isClosed`Boolean! Whether the conversation is closed.
`isUnread`Boolean! Whether the conversation is unread by the authenticated user.
`closedAt`Date The date that the conversation was closed.
`messages`MessagePaginator! The messages in the conversation.
`participants`ParticipantPaginator! The participants involved in the conversation.

Related Types

References: Date, Job, Message, MessagePaginator, ParticipantPaginator, URL

Referenced by: Bid, ConversationPaginator, Hire, Participant

ConversationPaginator

A paginated list of Conversation items.

Fields
`paginatorInfo`PaginatorInfo! Pagination information about the list of items.
`data`[Conversation!]! A list of Conversation items.

Related Types

References: Conversation, PaginatorInfo

Referenced by: Job

Country

A country.

Fields
`isoCode`CountryCode! The ISO 3166 alpha-2 code. This is a two-letter country identifier (e.g. US).
`name`String The full name of the country.

Related Types

References: CountryCode

Referenced by: Address

CreateCustomTimeSheetResponse

The response from creating a custom timesheet.

Fields
`providedRegistrations`Int! The total number of timesheet registrations that were detected in the submitted payload.
`successfulRegistrations`Int! The number of timesheet registrations that passed validation and were queued for processing.
`rejectedRegistrations`[RejectedCustomTimesheetRegistration!]! Per-registration errors for any registrations that were not accepted. Each entry corresponds to a single rejected registration.

Related Types

References: RejectedCustomTimesheetRegistration

CreateExportResponse

A response with data from the export creation.

Fields
`status`ExportResponseStatus! The status of the export.
`message`String! A message explaining the result of the export.

Related Types

References: ExportResponseStatus

CustomField

A custom field.

Fields
`id`ID! The ID of the field.
`user`User The user that created the field. The user may have been deleted in which case we return null.
`account`Account! The account that the field is owned by.
`title`String! The title of the field.
`slug`String A unique human-readable key for the 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 field.
`fieldType`CustomFieldType! The type of the field.
`appliesTo`TypeSupportingCustomFieldValues! The type of item that the field applies to.
`customFieldOptions`[CustomFieldOption!]! The possible options for the field.
`settings`CustomFieldSettings! Additional custom field settings. For example, validation rules.
`visibility`CustomFieldVisibility! To which people should the custom field be visible to.
`customFieldValues`[CustomFieldValue!]! The custom field related values which were applied on an entity.
`isUsedInFieldValues`Boolean! Whether the field has been applied to an entity supporting custom fields.
`rule`WorkflowVariableRule Access to the approval rule field pivot, containing the operator and rule value.
`approval`Boolean! Whether the field is enabled for approval workflows.
`viewerCanUpdate`Boolean! Whether the user querying the field can edit it.
`viewerOwnsField`Boolean! Whether the field is owned by the account the viewer is acting as, either directly or through an organisation that account belongs to. Inherited organisation fields count as the viewer’s own; fields shared by another company do not.
`apiOnly`Boolean! Whether the field is enabled to be updated by the API only.
`workerInputAllowed`Boolean! Whether workers are allowed to provide values for this field. When enabled, workers can update field values through the worker API.
`recruiterInputAllowed`Boolean! Whether recruiters (staffing agencies) are allowed to provide values for this field. When enabled, recruiters can update field values through the recruiter API.
`showOnInvoice`Boolean! Whether values for this field should be surfaced on client invoices.
`sharedWithClients`Boolean! Whether this field is shared with client companies. When enabled, clients of the supplier that owns this field will see it during job sharing.
`sharedWithStaffingAgencies`Boolean! Whether values for this field are visible to staffing agencies this company shares the job with. When enabled, agencies with an active share of the job can read this field’s value (read-only).
`viewerCanManageFieldValues`Boolean! Whether the user querying the field can edit the field value. Not to be confused with ‘viewerCanUpdate’ which indicates if the user can edit the field itself, not the field value.
`createdAt`DateTime! The date and time that the field was created.
`updatedAt`DateTime The date and time that the field was updated.
`deletedAt`DateTime The date and time that the field was deleted.

Related Types

References: Account, CustomFieldOption, CustomFieldSettings, CustomFieldType, CustomFieldValue, CustomFieldVisibility, DateTime, TypeSupportingCustomFieldValues, User, WorkflowVariableRule

Referenced by: ApprovalRule, CustomFieldOption, CustomFieldPaginator, CustomFieldValue

CustomFieldOption

A custom field option.

Fields
`id`ID! The ID of the field option.
`customField`CustomField! The field that the field option is valid for.
`displayOrder`Int! The display order of the field option. This is an unsigned integer.
`value`String! The value of the field option.

Related Types

References: CustomField

Referenced by: CustomField, CustomFieldValue

CustomFieldPaginator

A paginated list of CustomField items.

Fields
`paginatorInfo`PaginatorInfo! Pagination information about the list of items.
`data`[CustomField!]! A list of CustomField items.

Related Types

References: CustomField, PaginatorInfo

Referenced by: Company

CustomFieldSettings

The settings for a custom field.

Fields
`validation`[CustomFieldValidationRules!]! Validation rules for the custom field.

Related Types

References: CustomFieldValidationRules

Referenced by: CustomField

CustomFieldValue

A custom field value.

Those represents the custom fields value filled for an entity supporting custom fields.

e.g: You’ve defined a free-text “sector” custom field applying to Job entities. Say you have a job which is in the “IT” sector. You’d need to create a custom field value with field_id = <sector field id>, and content = "IT".

Fields
`id`ID! The ID of the field value.
`account`Account! The account that the field value is owned by.
`user`User! The user who created the field value.
`appliesTo`SupportsCustomFieldValue! The entity to which the custom field value is applying to.
`customField`CustomField! The field that the field value is valid for.
`customFieldOption`CustomFieldOption The field option which was applied for that field to the entity supporting custom fields. This will be present for a single-select field type.
`content`String The content of the custom field value in the case of a custom field not using custom field options. This will be present for a free-text field type.
`displayValue`String A representation of the value for easier display. This gives a “human” representation of the custom field value no matter the field type. For example, this will return `content` for a free-text value, will return the custom field option `value` for a single-select value, or the file `name` for a file-upload value.
`file`File The uploaded file referenced by the field value. Present for `FILE_UPLOAD` field-values; null for every other field type.

Related Types

References: Account, CustomField, CustomFieldOption, File, SupportsCustomFieldValue, User

Referenced by: Client, CompanyRecruiter, CustomField, Job, TimesheetRegistration, TrustedContact, UpdateWorkerCustomFieldValuesPayload

Employment

An employment record for a worker engaged on payroll through Worksome or an Employer of Record (EoR) partner.

Employment records track the formal payroll relationship when a worker is employed rather than operating as an independent contractor. A hire may have an associated employment when the engagement uses a payroll arrangement; not all hires have one.

Fields
`id`ID! The ID of the employment.
`worker`Worker! The worker that the employment relates to.
`employerOfRecord`Account The employer of record for this employment.
`hiringManagers`[User!]! The hiring managers for this employment.
`status`EmploymentStatus! The employment status for the employment.
`onboardingStatus`EmployerRecordStatus! The employer record status for the employment.
`startDate`Date The start date of the employment.
`endDate`Date The end date of the employment.
`firstPayrolledAt`DateTime The date when the worker was first payrolled.
`previouslyHired`Boolean Indicates if the worker was previously hired.
`createdAt`DateTime The date and time that the employment was created.
`updatedAt`DateTime The date and time that the employment was updated.
`isOnboarded`Boolean Whether the employment is onboarded.
`onboardedAt`DateTime The date when the employment was onboarded (status set to Complete).
`hires`HirePaginator! The hires associated with this employment.
`employmentCosts`EmploymentCostPaginator! The employment costs applied to the employment.

Related Types

References: Account, Date, DateTime, EmployerRecordStatus, EmploymentCostPaginator, EmploymentStatus, HirePaginator, User, Worker

Referenced by: EmploymentPaginator, Hire

EmploymentCost

An employment cost.

Fields
`id`ID! The ID of the employment cost.
`category`EmploymentCostCategory! The category of the employment cost.
`type`EmploymentCostType! The type of the employment cost.
`frequency`EmploymentCostFrequency! The frequency of the employment cost.
`amount`Float! The amount of the employment cost.
`currency`String The currency of the employment cost.
`createdAt`DateTime The date and time that the employment cost was created.
`updatedAt`DateTime The date and time that the employment cost was updated.

Related Types

References: DateTime, EmploymentCostCategory, EmploymentCostFrequency, EmploymentCostType

Referenced by: EmploymentCostPaginator

EmploymentCostPaginator

A paginated list of EmploymentCost items.

Fields
`paginatorInfo`PaginatorInfo! Pagination information about the list of items.
`data`[EmploymentCost!]! A list of EmploymentCost items.

Related Types

References: EmploymentCost, PaginatorInfo

Referenced by: Employment

EmploymentPaginator

A paginated list of Employment items.

Fields
`paginatorInfo`PaginatorInfo! Pagination information about the list of items.
`data`[Employment!]! A list of Employment items.

Related Types

References: Employment, PaginatorInfo

Expense

An expense line item within an expense report.

Expenses represent individual costs incurred by a worker during an engagement, such as travel or materials. They are grouped into expense reports and submitted alongside payment requests for approval.

Fields
`id`ID! The ID of the expense.
`description`String The description of the expense.
`currency`Currency! The currency of the expense.
`amount`Float! The amount of the expense.
`vendor`String! The vendor of the expense.
`expenseAt`DateTime! The date and time that the expense was expensed.
`createdAt`DateTime! The date and time that the expense was created.
`files`FilePaginator! The files attached to this expense.

Related Types

References: Currency, DateTime, FilePaginator

Referenced by: ExpensePaginator

ExpensePaginator

A paginated list of Expense items.

Fields
`paginatorInfo`PaginatorInfo! Pagination information about the list of items.
`data`[Expense!]! A list of Expense items.

Related Types

References: Expense, PaginatorInfo

Referenced by: ExpenseReport

ExpenseReport

An expense report.

Fields
`id`ID! The ID of the expense report.
`title`String The title of the expense report.
`description`String The description of the expense report.
`total`Float! The total of the expense report.
`isDraft`Boolean! Whether the expense report is a draft.
`createdAt`DateTime The date and time that the expense report was created.
`expenses`ExpensePaginator! The expenses on the expense report.

Related Types

References: DateTime, ExpensePaginator

Referenced by: ExpenseReportPaginator

ExpenseReportPaginator

A paginated list of ExpenseReport items.

Fields
`paginatorInfo`PaginatorInfo! Pagination information about the list of items.
`data`[ExpenseReport!]! A list of ExpenseReport items.

Related Types

References: ExpenseReport, PaginatorInfo

Referenced by: PaymentRequest

Fee

A fee attached to a feeable entity (e.g. Hire, PaymentRequest, staffing agency relationship).

Fields
`id`ID! The ID of the fee.
`feeType`FeeType! The type of the fee.
`application`FeeApplication! How the fee is applied when calculating or explaining an amount.
`rate`DecimalFour! The rate value of the fee. For percentage-based fees this is a decimal fraction (e.g. 0.125 = 12.5%). For duration-based fees (hourly/daily/weekly/monthly) this is the monetary rate per unit.
`amount`DecimalTwo The computed monetary amount of the fee, when available. This is typically populated when the fee is snapshotted onto a billing entity.
`currency`Currency The ISO 4217 currency code for the fee, when applicable.
`basis`FeeBasis! The basis on which the fee is calculated (e.g. percentage, hourly, daily, weekly, monthly).
`formattedRate`String! A human-readable representation of the rate, formatted per basis. For example: “12.50%” for a percentage fee, “EUR 25.50/h” for an hourly fee, or “EUR 200.00/day” for a daily fee.
`recipient`Account The recipient of the fee.
`parent`Fee The parent fee this fee was derived from, if any. For example, a bill fee may reference the hire fee it was snapshotted from.

Related Types

References: Account, Currency, DecimalFour, DecimalTwo, FeeApplication, FeeBasis, FeeType

Referenced by: Bid, CompanyRecruiter, Hire, PaymentRequest

File

A file.

Fields
`id`ID! The ID of the file.
`name`String! The name of the file.
`title`String The title of the file (optional display name).
`size`Int! The size of the file in bytes.
`humanReadableSize`String! A human-readable representation of the file size (e.g. `1.2 MB`).
`mimeType`String! The IANA MIME type of the file.
`owner`Account! The account that the file belongs to.
`url`String! The URL that should be used to download the file. This URL cannot be used for saving in external systems as it might change over time or be regenerated. If a permanent URL is needed for the file, it should be stored in the clients own system.
`createdAt`DateTime The date and time the file was created.
`updatedAt`DateTime The date and time the file was last updated.
`tags`[Tag!]! The tags applied to the file.

Related Types

References: Account, DateTime, Tag

Referenced by: Bid, ComplianceDataFile, Contract, CustomFieldValue, FilePaginator, Job, OnboardingDocument, TrustedContact, WorkerInsurance

FilePaginator

A paginated list of File items.

Fields
`paginatorInfo`PaginatorInfo! Pagination information about the list of items.
`data`[File!]! A list of File items.

Related Types

References: File, PaginatorInfo

Referenced by: Expense, PaymentRequest, RecruiterCandidate, SupplierCandidate, Timesheet

Gate

A gate represents a collection of related compliance requirements.

Fields
`actor`ComplianceActorTypes! The primary party responsible for this gate’s requirements
`name`ComplianceName! Unique identifier for this gate
`compliances`[Compliance!]! List of individual compliance requirements in this gate
`completed`Boolean! Whether all applicable compliances in this gate are complete
`applicable`Boolean! Whether this gate applies to the current context
`title`String! Human readable title describing the gate’s purpose
`description`String! Detailed description of what needs to be done in this gate

Related Types

References: Compliance, ComplianceActorTypes, ComplianceName

Hire

A representation of an engagement between a company and a worker on a job.

A hire tracks the agreement between parties to work together. It is not itself a legal document — the contracts attached to the hire (Hire.contracts, Hire.activeContract) are the legal agreements.

A hire progresses through a lifecycle: DRAFT → OFFERED → READY → ACTIVE → ENDED. It may also be CANCELLED (before activation) or TERMINATED (ended early by the company).

Fields
`id`ID! The ID of the hire.
`number`String! The unique reference for the hire.
`lastPaymentRequestDate`Date The date the worker last submitted a payment request for this hire. Null if no payment request has ever been submitted.
`latestContract`Contract! The latest contract, not necessarily the active one. The latest contract could for example be a draft, if one of the parties wanted to make changes to the currently active contract. see `hire.activeContract` for the current active one.
`activeContract`Contract The currently active contract. This has been accepted by all parties and is the active legal document between them.
`draftContract`Contract The draft contract, if there is one waiting for the other party to accept.
`pendingContractChanges`Boolean! If there are pending changes to the contract that are awaiting acceptance by the worker.
`hasScheduledChanges`Boolean! If the hire has a contract change scheduled to take effect on a future date, whether or not it has been signed yet.
`hasSignedScheduledChange`Boolean! If the hire has a signed, future-dated change that is parked awaiting its effective date. When true the change is locked: it can no longer be amended and must be cancelled and re-created to change it.
`company`Company! The company which the worker will work with.
`job`Job! The job that the hire is on.
`recruiter`Recruiter The recruiter attributed to the hire.
`supplier`Account The polymorphic supplier (Company or Recruiter) attributed to the hire.
`viewerIsSupplier`Boolean! Whether the authenticated viewer is the supplier (staffing agency) on this hire. True for both traditional Recruiters and Company-as-supplier accounts.
`contractType`ContractType! The contract type for the hire (e.g., ‘SOW’, ‘Sole Trader’, etc.).
`engagementType`EngagementType The engagement type for the hire (e.g., ‘payroll’, ‘contractor’, ‘external’, ‘pending’). This represents the nature of the working relationship.
`engagementTypeLabel`String A descriptive label for the engagement type (e.g. ‘Employee’, ‘Contractor’, etc.).
`engagementTypeSetup`EngagementTypeSetup The engagement type setup for the hire (e.g. ‘W-2’, ‘InsideIR35’, ‘GlobalPayroll’, etc.).
`engagementTypeSetupLabel`String A descriptive label for the engagement type setup (e.g. ‘PAYE’, ‘Inside IR35’, ‘Outside IR35’, etc.).
`contractTypeShort`String A short code or abbreviation representing the contract type (e.g., ‘W2’, ‘IR35’, etc.).
`contractTypeLabel`String! A descriptive label for the contract type. e.g. ‘Subject to Worksome Classify’.
`usesClassification`Boolean! If this hire is using Worksomes Classify for determining its classification.
`wcr`Wcr Deprecated The Worksome Classification Recommendation (WCR) currently linked to this hire.
`classification`Classification The worksome classification recommendation represents a worker classification (SDS/WCR) for a hire. This can be various types of classifications like IR35, US Worker Classification, etc.
`classificationResult`ClassificationResult! Deprecated The result of classification.
`classificationLabel`String Deprecated A context dependent label that helps interpret the classification result. It can return a much wider array of labels than the classificationResult can and therefore should be used when displaying the legal context for the classification.
`classificationPdfUrl`String! Deprecated A URL of the classification documentation result. This URL will link to a PDF for the classification result is present. This URL cannot be used for saving in external systems as it might change over time or be regenerated. If a permanent URL is needed for the classification result, it should be stored in the clients own system.
`worker`Worker! The worker which the company is hiring.
`conversation`Conversation The conversation in which the hire is happening. If the hire is stuck in an approval flow, there can exist a situation where no conversation exists yet.
`employment`Employment The employment record for the worker on this hire when they are employed by Worksome or an EoR partner. Note: This employment is not always tied to a specific hire.
`createdAt`Date! The date that the hire was created.
`startDate`Date The date that the hire started.
`endDate`Date The date that the hire ended.
`recruiterOwnershipStartDate`Date The date that recruiter ownership started.
`recruiterFee`Percentage Deprecated The recruiter’s fee.
`recruiterOwnershipDays`Int The number of ownership days for the recruiter.
`recruiterOwnershipIsExpired`Boolean Indicates whether or not the recruiter ownership has expired yet.
`recruiterOwnershipDaysLeft`Int Number of days left in the recruiter’s ownership.
`currency`String! The currency of the hire.
`rate`Float The rate for the hire.
`rateType`String The rate type for the hire.
`status`HireActiveStatus! The current lifecycle status of the hire. See `activeStatus` for the same value. Possible values: `DRAFT`, `OFFERED`, `READY`, `ACTIVE`, `ENDED`, `CANCELLED`, `TERMINATED`.
`offeredAt`Date The date that the hire became active.
`externalIdentifier`String An identifier associated with the hire from an external system.
`purchaseOrderNumber`String The assigned Purchase Order (PO) number, if one has been added.
`compliances`[Compliance!]! Compliance rows for this hire. Pass `names` to filter.
`recruiterManagesWorkers`Boolean Whether the staffing agency (recruiter or company-as-supplier) manages workers on this hire.
`supplierSignatureWaived`Boolean Whether the supplier’s confirmation on this hire is signature-free and auto-accepted (the MSP opted this vendor-managed hire into no-signature confirmation). Drives whether the supplier sees a signature widget.
`canRemoveRecruiter`Boolean Whether the assigned recruiter can be removed from the hire.
`canRemindWorkerForBilling`Boolean! Whether the assigned worker can be reminded for billing.
`user`User The user who created the Hire.
`activeStatus`HireActiveStatus! The current lifecycle status of the hire. Possible values: `DRAFT`, `OFFERED`, `READY`, `ACTIVE`, `ENDED`, `CANCELLED`, `TERMINATED`.
`terminationDate`Date The date an early termination takes effect, or null when the hire has not been terminated.
`canTerminateContract`Boolean! If the company can terminate the contract of the hire.
`canCancelContract`Boolean! If the company can cancel the contract of the hire.
`hasMilestones`Boolean! If milestones exists for the hire.
`hasEmployment`Boolean! If an employment record exists for the hire.
`hasDraftContract`Boolean! If there is a draft contract for the hire.
`triggersApproval`Boolean If the hire triggers approval
`currentApprovalState`ApprovalState The overall state for approvals on the hire with a given trigger.
`hasPendingApproval`Boolean! Whether the hire has any pending approval request across all triggers.
`owners`[User!]! The owners of the hire.
`endsWithinDays`Boolean! Check if this hire ends within a given number of days.
`tenure`Int! The number of days the hire has been active (tenure).
`sourceHire`Hire The source hire this hire was derived from.
`supplierHire`Hire The supplier-side hire derived from this source hire.
`hasUnactedClientChanges`Boolean! True when the `sourceHire` has pending contract changes that haven’t yet been reflected here. Always false on hires without a `sourceHire`.
`viewerCanAcceptContract`Boolean! Checks if the current viewer has the correct permissions to be able to accept the contract and that all blocking actions have been completed.
`viewerCanCreatePaymentRequest`Boolean! Whether the current viewer can create a new payment request for this hire. Uses the createBill policy (worker or recruiter with access-placements) plus hire state.
`fees`[Fee!]! The fees associated with this hire.
`markupFee`Fee The staffing agency’s markup fee on this hire, when one applies. Visible only to the staffing agency; null otherwise.
`contracts`ContractPaginator! The contracts for the hire. These are legal documents, however it can contain old contracts and drafts also.
`paymentRequests`PaymentRequestPaginator! The payment requests created on the hire.
`milestones`MilestonePaginator! The milestones for the hire.
`approvals`ApprovalPaginator! The approvals on a hire.

Related Types

References: Account, ApprovalPaginator, ApprovalState, Classification, ClassificationResult, Company, Compliance, Contract, ContractPaginator, ContractType, Conversation, Date, Employment, EngagementType, EngagementTypeSetup, Fee, HireActiveStatus, Job, MilestonePaginator, PaymentRequestPaginator, Percentage, Recruiter, User, Wcr, Worker

Referenced by: Classification, HirePaginator, JobCandidate, Milestone, PaymentRequest, Timesheet, Worker

HirePaginator

A paginated list of Hire items.

Fields
`paginatorInfo`PaginatorInfo! Pagination information about the list of items.
`data`[Hire!]! A list of Hire items.

Related Types

References: Hire, PaginatorInfo

Referenced by: Employment, Job, Worker

Industry

An industry.

Fields
`id`ID! The ID of the industry.
`name`String! The name of the industry.

Related Types

Referenced by: IndustryPaginator, Job

IndustryPaginator

A paginated list of Industry items.

Fields
`paginatorInfo`PaginatorInfo! Pagination information about the list of items.
`data`[Industry!]! A list of Industry items.

Related Types

References: Industry, PaginatorInfo

Invoice

An invoice issued to a company for approved worker payment requests.

An invoice is created when one or more worker payment requests are approved by a company user. It defines the total amount due from the company to Worksome and tracks the payment lifecycle.

Fields
`id`ID! The ID of the invoice.
`number`String A number referencing the invoice. This is usually printed on the invoice itself and should be used by booking system and finance departments. The invoice number is in a human readable format.
`pdfUrl`URL! A URL of the actual invoice. This URL will link to a PDF for the invoice. This URL cannot be used for saving in external systems as it might change over time or be regenerated. If a permanent URL is needed for the invoice, it should be stored in the clients own system.
`currency`Currency! The type of currency.
`grossAmount`Float! The total amount including taxes etc.
`grossOpenAmount`Float! The total amount due on invoice minus credited amounts including taxes etc.
`taxAmount`Float! The total amount of taxes to be paid.
`netAmount`Float! The total amount without taxes.
`markedPaidAt`Date The date that the invoice was marked paid by Worksome. This date might vary from the actual date it was paid, as it takes time for a payment to go through and be validated.
`dueDate`Date! The date that the invoice should be paid by.
`company`Company! The company that the invoice is for.
`payerBusinessEntity`BusinessEntity The payer business entity on the invoice.
`payeeBusinessEntity`BusinessEntity The payee business entity on the invoice.
`payerDisplayName`String! Human-readable display name of the payer.
`payeeDisplayName`String! Human-readable display name of the payee.
`date`Date! The date that the invoice was created.
`isBatched`Boolean! Checks if the invoice is a batched invoice. A batch invoice aggregates multiple payment requests together in one, summarised invoice over a period of time. This reduces the overhead of processing high volumes of payment requests and corresponding invoices.
`transactionType`InvoiceTransactionType! The type of transaction to be used for the invoice.
`isFullyCredited`Boolean! Checks if the invoice has been fully credited.
`isOverDue`Boolean Checks if the invoice is overdue.
`creditNotes`[Invoice!]! The credit notes associated with the invoice.
`originalInvoice`Invoice The original invoice credited by this credit note.
`externalIdentifier`String An external identifier for the invoice, used to reference it in external systems.
`rows`InvoiceRowPaginator! A paginated list of all the rows on the invoice. This can be used to gather more information about the invoice than just the overall amount.

Related Types

References: BusinessEntity, Company, Currency, Date, InvoiceRowPaginator, InvoiceTransactionType, URL

Referenced by: InvoicePaginator, PaymentRequest

InvoicePaginator

A paginated list of Invoice items.

Fields
`paginatorInfo`PaginatorInfo! Pagination information about the list of items.
`data`[Invoice!]! A list of Invoice items.

Related Types

References: Invoice, PaginatorInfo

InvoiceRow

A row on the invoice.

Fields
`id`ID! The ID of the invoice row.
`paymentRequest`PaymentRequest The payment request which the row on the invoice is related to.
`worker`Worker The worker that is linked to this row.
`customText`String A custom text which will be shown on the invoice PDF.

Related Types

References: PaymentRequest, Worker

Referenced by: InvoiceRowPaginator

InvoiceRowPaginator

A paginated list of InvoiceRow items.

Fields
`paginatorInfo`PaginatorInfo! Pagination information about the list of items.
`data`[InvoiceRow!]! A list of InvoiceRow items.

Related Types

References: InvoiceRow, PaginatorInfo

Referenced by: Invoice

Job

A job posting created by a company on Worksome.

Jobs start in DRAFT status after creation via createJob, then move to ACTIVE once published via updateJob. A job can be shared with the marketplace, trusted contacts, or staffing agencies depending on its visibility settings. Workers can submit bids on published jobs, and the company can hire from those bids or directly hire a trusted contact.

Fields
`id`ID! The ID of the job.
`number`Int! The unique reference for the job.
`name`String! The name of the job.
`contactName`String The client contact’s full name.
`contactEmail`String The client contact’s email address.
`contactPhone`String The client contact’s phone number.
`skills`[Skill!]! The skills required for the job.
`description`String The description of the job.
`market`MarketCode! The market that the job is in.
`status`JobStatus The status of the job.
`address`String Deprecated The address of the job.
`location`Address! The address location associated to the job.
`currency`Currency! The type of currency.
`rateType`RateType The unit of time when payment is due.
`rate`Float The payment amount per specified rate type.
`minimumRate`Float The minimum payment amount per specified rate type.
`maximumRate`Float The maximum payment amount per specified rate type.
`paymentScheme`PaymentScheme Deprecated The payment scheme that the job will use.
`companyFee`StrictPercentage The company fee (as a percentage).
`workerFee`StrictPercentage The worker fee (as a percentage).
`association`Association The project type of the job.
`project`Project The project the job associated to.
`internalBudget`Float Internal budget of the project.
`spent`Float! Total job spent. Only enterprise company owning the job could access the budget.
`expectedExperienceLevel`[ExpectedExperienceLevel!]! The expected experience levels required for the job.
`locationPreference`LocationPreference The location preference of the job.
`startDate`Date The date that the job started.
`startDateTimeframe`JobStartTimeframe The timeframe within the job is likely to start
`endDateTimeframe`JobEndTimeframe The timeframe within the job is likely to end
`endDate`Date The date that the job ended.
`attachments`[File!]! The files attached to the job.
`isExtensionAvailable`Boolean Whether the job can be extended.
`evaluationPeriod`EvaluationPeriod The period of time required to reply to candidates.
`sourcingEndDate`DateTime The date and time by which candidates should be submitted for this job.
`sourcingDeadlineChoice`SourcingDeadlineChoice A pending choice for the sourcing deadline, while sourcingEndDate is still unresolved. Only meaningful when sourcingEndDate is null.
`sourcingEndDateLocal`String The deadline for candidate submission, formatted as “YYYY-MM-DDTHH:mm:ss” in the account’s market timezone.
`languages`[Language!]! The languages required for the job.
`industries`[Industry!]! The industries that the worker requires experience in for the job.
`requiredWorkers`Int The number of workers that are required for the job. If excluded, the default is 1 profile.
`owners`[User!]! The owners of the job posting.
`customFieldValues`[CustomFieldValue!]! Additional custom fields values for the job. Details specified here are never shown to workers. Depending on each field’s sharing settings, some may be visible outside your team.
`visibility`[JobVisibility!]! The audiences that will be able to see the job listing.
`approved`Boolean! Whether the job has been approved by Worksome.
`available`Boolean! Whether the job is available to receive offers.
`paused`Boolean! Whether the job is currently paused.
`completed`Boolean! Whether the job is completed.
`published`Boolean! Whether the job has been published.
`draft`Boolean! Whether the job is a draft.
`removed`Boolean! Whether the job has been removed/discarded while being published and before having any hires.
`removedCause`String The cause for removal of the Job.
`publishedAt`DateTime The date and time that the job was published.
`company`Company! The company that the job is for.
`region`String The region for the job.
`url`URL! The URL for the job.
`viewerCanDelete`Boolean! Whether the viewer is able to delete the job.
`viewerCanEdit`Boolean! Whether the viewer is able to edit the job.
`viewerCanShare`Boolean! Whether the viewer is able to share the job.
`viewerCanCreateJobCandidate`Boolean! Whether the viewer is able to create a job candidate.
`viewerCanCreateHire`Boolean! Whether the viewer is able to create a hire on the job.
`createdAt`DateTime! The date and time that the job was created.
`updatedAt`DateTime! The date and time that the job was updated.
`isForContacts`Boolean! Whether the job is shared with contacts.
`isForRecruiters`Boolean! Whether the job is shared with recruiters.
`isForMarketplace`Boolean! Whether the job is shared publicly on the marketplace.
`externalIdentifier`String An identifier associated with the job from an external system.
`canBePublished`Boolean! Determines if the job can be published.
`isJobPost`Boolean Whether the job is a job post.
`isBrief`Boolean Experimental. Whether the job is a lightweight brief rather than a full job post.
`isAvailable`Boolean Whether the job is available.
`sourceJob`Job The source job this job was derived from.
`supplierJob`Job The supplier-side job derived from this source job.
`hires`HirePaginator! The hires made on the job.
`conversations`ConversationPaginator! The conversations involving the job.
`notes`NotePaginator! The notes added to the job.
`paymentRequests`PaymentRequestPaginator! The payment requests created on the job.
`bids`BidPaginator! The bids submitted for the job.
`shares`JobSharePaginator! The contacts that this job was shared with.
`jobCandidates`JobCandidatePaginator! The workers candidates for this job. Scoped like the root jobCandidates query: company viewers see all, suppliers only their own submissions.

Related Types

References: Address, Association, BidPaginator, Company, ConversationPaginator, Currency, CustomFieldValue, Date, DateTime, EvaluationPeriod, ExpectedExperienceLevel, File, HirePaginator, Industry, JobCandidatePaginator, JobEndTimeframe, JobSharePaginator, JobStartTimeframe, JobStatus, JobVisibility, Language, LocationPreference, MarketCode, NotePaginator, PaymentRequestPaginator, PaymentScheme, Project, RateType, Skill, SourcingDeadlineChoice, StrictPercentage, URL, User

Referenced by: Bid, Contract, Conversation, Hire, JobCandidate, JobPaginator, JobShare, PaymentRequest

JobCandidate

The relation between a job and a worker, making them a candidate for the job.

Fields
`id`ID! The ID of the approvals.
`job`Job! The job for which the worker is a candidate.
`worker`Worker! The worker who is a candidate for the Job.
`bid`Bid The active bid made by the worker for the job.
`hire`Hire The hire created by the company for the job and worker pairing.
`jobShare`JobShare The job share reference if the worker was invited to apply.
`sourcingChannel`SourcingChannel! The sourcing channel that the worker came from as a job candidate.
`submissionType`CandidateSubmissionType How the candidate was submitted (managed vs referred). Null for candidates that didn’t come through a supplier submission.
`contactName`String Contact name of who submitted the candidate.
`contactEmail`String Contact email of who submitted the candidate.
`contactPhone`String Contact phone of who submitted the candidate.
`owner`Account The owner of the submitted candidate. Only applies if the candidate was submitted.
`step`JobCandidateHiringStep! The step of the hiring process that the job candidate is in.
`status`JobCandidateStatus! The status of the job candidate.
`statusReason`JobCandidateStatusReason When not eligible anymore, indicates why the job candidate is not.
`statusComment`String Added comment regarding the reason for the job candidate not being eligible. Only resolved for viewers on the job’s owning company.
`isPreferred`Boolean! Whether the candidate has been selected as preferred.
`statusSetByUser`User! The user that last changed the job candidate status.
`stepSetByUser`User! The user that last changed the job candidate step.
`createdAt`DateTime! The date and time that the job candidate was created.
`createdByUser`User! The user that created the job candidate.
`updatedAt`DateTime The date and time that the job candidate was last updated.
`updatedByUser`User The user that last updated the job candidate.
`viewerCanUpdateStatus`Boolean! Whether the viewer can update the job candidate status.
`viewerCanUpdatePreferred`Boolean! Whether the viewer can update the job candidate preferred.
`sourceCandidate`JobCandidate The source candidate this was presented from in a mirror setup. Only resolved for viewers on the job’s owning company.
`presentedCandidate`JobCandidate The client-side candidate created when this candidate was presented, in a mirror setup. Only resolved for viewers on the job’s owning company.
`stageHistory`[JobCandidateStageHistoryEntry!]! The history of stage transitions for this candidate.
`viewerCanWithdrawForwardedCandidate`Boolean! Whether the current user can withdraw this forwarded candidate.
`viewerCanWithdraw`Boolean! Whether the viewer (a supplier who owns this candidate) can withdraw them from the hiring process.
`viewerCanInviteToOnboard`Boolean! Whether the current user can invite this candidate to begin onboarding. True only when the viewer has edit-jobs permission on the candidate’s job, the candidate has a draft hire, and the candidate is not the client-side copy of a candidate presented through an MSP mirror flow.
`presentedToClient`Boolean! Whether this candidate has been presented (forwarded) to the client job.
`sourceAgencyName`String The name of the staffing agency that originally sourced this candidate. Only returned when the candidate was presented to the client by a different agency than the one that originally submitted them.

Related Types

References: Account, Bid, CandidateSubmissionType, DateTime, Hire, Job, JobCandidateHiringStep, JobCandidateStageHistoryEntry, JobCandidateStatus, JobCandidateStatusReason, JobShare, SourcingChannel, User, Worker

Referenced by: JobCandidatePaginator

JobCandidatePaginator

A paginated list of JobCandidate items.

Fields
`paginatorInfo`PaginatorInfo! Pagination information about the list of items.
`data`[JobCandidate!]! A list of JobCandidate items.

Related Types

References: JobCandidate, PaginatorInfo

Referenced by: Job

JobCandidateStageHistoryEntry

A single entry in a candidate’s stage transition history.

Fields
`stage`JobCandidateHiringStep! The stage that was set.
`changedByName`String The name of the user that made the change, if available.
`createdAt`DateTime! When the transition occurred.

Related Types

References: DateTime, JobCandidateHiringStep

Referenced by: JobCandidate

JobPaginator

A paginated list of Job items.

Fields
`paginatorInfo`PaginatorInfo! Pagination information about the list of items.
`data`[Job!]! A list of Job items.

Related Types

References: Job, PaginatorInfo

Referenced by: Project

JobShare

The contacts that the job was shared with.

Fields
`id`ID! The ID of the job share.
`account`JobShareableAccount! The account that the job share belongs to.
`isActive`Boolean! Whether the job share is active.
`createdAt`DateTime! The date and time that the job share was created.
`job`Job! The job that the job share is related to.

Related Types

References: DateTime, Job, JobShareableAccount

Referenced by: JobCandidate, JobSharePaginator

JobSharePaginator

A paginated list of JobShare items.

Fields
`paginatorInfo`PaginatorInfo! Pagination information about the list of items.
`data`[JobShare!]! A list of JobShare items.

Related Types

References: JobShare, PaginatorInfo

Referenced by: Job

Language

A language that is required for a job.

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

Related Types

References: Fluency, LanguageName

Referenced by: Job

LegacyTimesheet

A legacy timesheet.

This is only for internal use within the Worksome platform.

Fields
`format`LegacyTimesheetType Deprecated The format of the legacy timesheet.
`html`String Deprecated The HTML representation of the legacy timesheet.

Related Types

References: LegacyTimesheetType

Referenced by: PaymentRequest

Link

A link on a profile.

Fields
`title`String! The title of the link.
`url`String! The URL of the link.

Related Types

Referenced by: Profile

Market

A geographic market in which Worksome operates (e.g. UK, US, Denmark).

Markets determine applicable compliance rules, currencies, and employment regulations for accounts and jobs.

Fields
`code`MarketCode! The market code.
`name`String! The name of the market.
`regionLabel`String The label for the region type (e.g. regions, states, provinces).

Related Types

References: MarketCode

Referenced by: AvailableMarket, Recruiter, Worker

MarketRegion

A region within a market.

Fields
`id`Int! The unique identifier for the region.
`name`String! The translated name of the region.

Related Types

Referenced by: MarketWithRegions

MarketWithRegions

A launched market with all of its available regions.

Fields
`code`String! The market code.
`name`String! The market display name.
`regionLabel`String The label for the region type (e.g. regions, states, provinces).
`regions`[MarketRegion!]! All regions within this market.

Related Types

References: MarketRegion

Message

A message as part of a conversation.

Fields
`id`ID! The ID of the message.
`body`String The body of the message.
`author`User The author of the message.
`url`URL! The URL for the message.

Related Types

References: URL, User

Referenced by: Bid, Conversation, MessagePaginator, PaymentRequest

MessagePaginator

A paginated list of Message items.

Fields
`paginatorInfo`PaginatorInfo! Pagination information about the list of items.
`data`[Message!]! A list of Message items.

Related Types

References: Message, PaginatorInfo

Referenced by: Conversation

Milestone

A deliverable-based milestone within a hire.

Milestones allow companies and workers to break an engagement into discrete deliverables, each with its own amount and completion status. Payment can be tied to milestone completion rather than time-based billing.

Fields
`id`ID! The ID of the milestone.
`name`String! The name of the milestone.
`purchaseOrderNumber`String The Purchase Order (PO) number of the milestone.
`status`MilestoneStatus! The current status of the milestone.
`details`MilestoneDetail! The current details of the milestone.
`hire`Hire! The hire that the milestone belongs to.
`paymentRequests`PaymentRequestPaginator! The payment requests that the milestone is related to.

Related Types

References: Hire, MilestoneDetail, MilestoneStatus, PaymentRequestPaginator

Referenced by: MilestoneDetail, MilestonePaginator

MilestoneDetail

Milestone details.

Fields
`id`ID! The ID of the milestone details.
`dueDate`Date! The due date of the milestone detail.
`amount`Float! The total amount of the milestone detail.
`milestone`Milestone! The milestone that the details belong to.
`contracts`ContractPaginator! The contracts that the details belong to.

Related Types

References: ContractPaginator, Date, Milestone

Referenced by: Milestone, MilestoneDetailPaginator

MilestoneDetailPaginator

A paginated list of MilestoneDetail items.

Fields
`paginatorInfo`PaginatorInfo! Pagination information about the list of items.
`data`[MilestoneDetail!]! A list of MilestoneDetail items.

Related Types

References: MilestoneDetail, PaginatorInfo

Referenced by: Contract

MilestonePaginator

A paginated list of Milestone items.

Fields
`paginatorInfo`PaginatorInfo! Pagination information about the list of items.
`data`[Milestone!]! A list of Milestone items.

Related Types

References: Milestone, PaginatorInfo

Referenced by: Hire, PaymentRequest

MultiFactorPaginator

A paginated list of MultiFactor items.

Fields
`paginatorInfo`PaginatorInfo! Pagination information about the list of items.
`data`[MultiFactor!]! A list of MultiFactor items.

Related Types

References: MultiFactor, PaginatorInfo

Note

A note for an entity.

Fields
`id`ID! The ID of the note.
`title`String! The title of the note.
`body`String! The body of the note.
`author`User! The author of the note.
`notable`Notable! The entity that the note belongs to.
`account`Account! The account that the note belongs to.
`createdAt`DateTime! The date and time that the note was created.
`updatedAt`DateTime! The date and time that the note was updated.
`viewerCanUpdate`Boolean! Whether the viewer is able to update the note.
`viewerCanDelete`Boolean! Whether the viewer is able to delete the note.

Related Types

References: Account, DateTime, Notable, User

Referenced by: NotePaginator

NotePaginator

A paginated list of Note items.

Fields
`paginatorInfo`PaginatorInfo! Pagination information about the list of items.
`data`[Note!]! A list of Note items.

Related Types

References: Note, PaginatorInfo

Referenced by: CompanyRecruiter, Job, TrustedContact

OnboardingDocument

An onboarding document for a trusted contact.

Fields
`id`ID! The ID of the onboarding document.
`file`File The file associated with this document.
`pdfUrl`String The URL to view or download the PDF document.
`freelancerAcceptedAt`Date The date when the worker accepted the document.
`isAccepted`Boolean! Whether the document has been accepted by the worker.

Related Types

References: Date, File

Referenced by: Client, CompanyRecruiter, TrustedContact

Organisation

An organisation — a parent entity that groups one or more companies (divisions) under a shared structure.

Organisations provide a unified view across their divisions for talent pools, reporting, and governance. They do not create jobs or make hires directly; those actions are performed by the individual company divisions.

Fields
`id`ID! The ID of the organisation.
`name`String! The name of the organisation.
`market`MarketCode! The market that the organisation is in.
`avatar`URL The avatar (or profile picture) for the organisation.
`divisions`CompanyPaginator! The divisions that an organisation contains.

Related Types

References: CompanyPaginator, MarketCode, URL

Referenced by: OrganisationPaginator

OrganisationPaginator

A paginated list of Organisation items.

Fields
`paginatorInfo`PaginatorInfo! Pagination information about the list of items.
`data`[Organisation!]! A list of Organisation items.

Related Types

References: Organisation, PaginatorInfo

Referenced by: Company

Overtime

An overtime entry automatically calculated from a timesheet.

When a worker logs hours that exceed the standard threshold for a billing period, overtime entries are generated automatically. Each entry captures the duration, applicable rate multiplier, and the resulting total, and is linked to the timesheet that triggered it and the payment request where it is billed.

Fields
`id`ID! The ID of the overtime.
`type`OvertimeType! The type of the overtime.
`duration`Float! The duration of the overtime.
`rate`Float! The rate of the overtime.
`rateMultiplier`Float! The rate multiplier for the overtime.
`total`Int! The total of the overtime.
`worker`Worker The worker that the overtime is for.
`paymentRequest`PaymentRequest The payment request on which the overtime is charged.
`timesheet`Timesheet! The timesheet which prompted the creation of overtime.
`contributingPaymentRequestNumbers`[ID!]! The payment request numbers which contain contributing timesheets.
`createdAt`DateTime! The date and time that the overtime was created.
`updatedAt`DateTime! The date and time that the overtime was updated.

Related Types

References: DateTime, OvertimeType, PaymentRequest, Timesheet, Worker

Referenced by: OvertimePaginator

OvertimePaginator

A paginated list of Overtime items.

Fields
`paginatorInfo`PaginatorInfo! Pagination information about the list of items.
`data`[Overtime!]! A list of Overtime items.

Related Types

References: Overtime, PaginatorInfo

Referenced by: PaymentRequest, Timesheet

PaginatorInfo

Information about pagination using a fully featured paginator.

Fields
`count`Int! Number of items in the current page.
`currentPage`Int! Index of the current page.
`firstItem`Int Index of the first item in the current page.
`hasMorePages`Boolean! Are there more pages after this one?
`lastItem`Int Index of the last item in the current page.
`lastPage`Int! Index of the last available page.
`perPage`Int! Number of items per page.
`total`Int! Number of total available items.

Related Types

Referenced by: ApprovalApprovablePaginator, ApprovalPaginator, ApprovalRulePaginator, ApprovalStatePaginator, ApproverPaginator, BatchItemPaginator, BatchPaginator, BidPaginator, BusinessEntityPaginator, ClassificationPaginator, CompanyPaginator, CompanyRecruiterPaginator, CompanySupplierPaginator, ContractPaginator, ConversationPaginator, CustomFieldPaginator, EmploymentCostPaginator, EmploymentPaginator, ExpensePaginator, ExpenseReportPaginator, FilePaginator, HirePaginator, IndustryPaginator, InvoicePaginator, InvoiceRowPaginator, JobCandidatePaginator, JobPaginator, JobSharePaginator, MessagePaginator, MilestoneDetailPaginator, MilestonePaginator, MultiFactorPaginator, NotePaginator, OrganisationPaginator, OvertimePaginator, ParticipantPaginator, PaymentRequestPaginator, ProjectPaginator, RecruiterCandidatePaginator, RecruiterPaginator, SkillPaginator, SupplierCandidatePaginator, SupplierInvoicePaginator, TagPaginator, TimesheetPaginator, TimesheetRegistrationPaginator, TrustedContactPaginator, UserGroupPaginator, UserPaginator, WebhookEventLogPaginator, WebhookEventPaginator, WebhookPaginator, WorkflowPaginator, WorkflowVariablePaginator

Participant

A participant in a conversation.

Fields
`id`ID! The ID of the participant.
`conversation`Conversation! The conversation that the participant is a part of.
`account`Account! The account of the participant.

Related Types

References: Account, Conversation

Referenced by: ParticipantPaginator

ParticipantPaginator

A paginated list of Participant items.

Fields
`paginatorInfo`PaginatorInfo! Pagination information about the list of items.
`data`[Participant!]! A list of Participant items.

Related Types

References: PaginatorInfo, Participant

Referenced by: Conversation

Partner

A partner account — an employment or compliance partner that facilitates hiring on behalf of companies.

Partners provide services such as Employer of Record (EoR) and payroll management to companies using Worksome. They do not create jobs or hire workers directly.

Fields
`id`ID! The ID of the partner.
`name`String! The name of the partner.
`slug`String! The slug of the partner.
`currency`String! The partner preferred currency.
`market`MarketCode! The market that the partner is in.
`avatar`URL The avatar (or profile picture) for the partner.
`address`Address The address of the partner.
`primaryBusinessEntity`BusinessEntity The primary business entity of the partner.
`primaryProfile`Profile The primary profile of the partner.

Related Types

References: Address, BusinessEntity, MarketCode, Profile, URL

PaymentRequest

A payment request.

Fields
`id`ID! The ID of the payment request.
`worker`Worker! The worker attached to the payment request.
`recruiter`Recruiter The Recruiter, if any, attached to the payment request.
`company`Company! The Company attached to the payment request.
`number`String! The unique reference for the payment request.
`purchaseOrderNumber`String The purchase order number assigned to the payment request.
`startDate`Date The date that the billing period started.
`endDate`Date The date that the billing period ended.
`currency`Currency! The currency used for this payment request.
`rate`Float The charged rate for this payment request.
`rateType`RateType The rate type required for this payment request.
`rateTypeName`String! The human friendly rate type required for this payment request.
`ratetypeNameSlash`String The abbreviated human friendly rate type required for this payment request.
`rateQuantity`Float! The quantity of the selected rate type for the payment request. The rate type can be seen by looking at `PaymentRequest.rateType` and the rate can be seen by looking at `PaymentRequest.rate`.
`serviceAmount`Float! The fee for using the Worksome Platform. This will change depending on who is viewing the api.
`expensesAmount`Float! The total amount of expenses reported on the payment request.
`invoice`Invoice The invoice generated for this payment request.
`netAmount`Float! The total amount excluding taxes.
`grossAmount`Float! The total amount including taxes.
`recruiterFeeAmount`Float! The agreed fee on the payment request between the company and recruiter. Only the company and recruiter can see this.
`employmentCostAmount`Float! The employment cost. The fee for payrolling a Worker. Only the Company can see this.
`billedAmount`Float! The total amount excluding fees and expenses.
`billedAmountWithExpenses`Float! The total amount including fees and expenses.
`date`Date! The date that the payment request was created.
`manuallyApprovedAt`Date The date that the payment request was manually approved.
`approvedBy`User The user that approved the payment request.
`autoApprovedAt`Date The date that the payment request was automatically approved (if applicable).
`rejectedAt`Date The date that the payment request was rejected (if applicable).
`prepaidAt`Date The date that the payment request was prepaid (if applicable).
`issuedAt`Date The date that the payment request was issued (if applicable).
`cancelledAt`Date The date that the payment request was cancelled (if applicable).
`paidAt`Date The date that the payment request was paid (if applicable).
`payrolledAt`Date The date that the payment request was payrolled (if applicable).
`dueAt`Date The date that the payment request is or was due.
`completedAt`Date The date that the payment request is or was completed (if applicable).
`processedAt`Date The date that the payment request is or was processed (if applicable).
`hire`Hire The hire attached to the payment request.
`job`Job! The job attached to the payment request.
`message`Message The message attached to the payment request.
`comments`String The comments relevant to the payment request.
`workerStatus`PaymentRequestWorkerStatus! The worker status relevant to the payment request.
`workerPayoutStatus`PaymentRequestWorkerPayoutStatus! The worker payout status for the payment request. This represents whether the worker has been paid.
`status`PaymentRequestStatus! The approval status of the payment request.
`timesheet`Timesheet The timesheet attached to the payment request.
`legacyTimesheet`LegacyTimesheet Deprecated The legacy timesheet attached to the payment request. This is only for internal use within the Worksome platform.
`externalIdentifier`String An external identifier for the payment request, used to reference it in external systems.
`sourcePaymentRequest`PaymentRequest The source payment request this record was derived from.
`clientPaymentRequest`PaymentRequest The client-side payment request derived from this source.
`fees`[Fee!]! The fees associated with this payment request.
`files`FilePaginator! The files attached to the payment request. There could potentially be a timesheet stored as a separate file.
`expenseReports`ExpenseReportPaginator! The expense reports for the payment request.
`batches`BatchPaginator! The batches for the payment request.
`milestones`MilestonePaginator! The milestones for the payment request.
`overtimes`OvertimePaginator! The overtimes for the payment request.
`supplierInvoices`SupplierInvoicePaginator! The supplier invoices for the payment request. Supplier invoices are only available to suppliers.

Related Types

References: BatchPaginator, Company, Currency, Date, ExpenseReportPaginator, Fee, FilePaginator, Hire, Invoice, Job, LegacyTimesheet, Message, MilestonePaginator, OvertimePaginator, PaymentRequestStatus, PaymentRequestWorkerPayoutStatus, PaymentRequestWorkerStatus, RateType, Recruiter, SupplierInvoicePaginator, Timesheet, User, Worker

Referenced by: InvoiceRow, Overtime, PaymentRequestPaginator

PaymentRequestPaginator

A paginated list of PaymentRequest items.

Fields
`paginatorInfo`PaginatorInfo! Pagination information about the list of items.
`data`[PaymentRequest!]! A list of PaymentRequest items.

Related Types

References: PaginatorInfo, PaymentRequest

Referenced by: Hire, Job, Milestone, Timesheet

Profile

A public-facing profile for a worker or company on Worksome.

Profiles contain biographical information, descriptions, and other details that are visible to other users on the platform.

Fields
`id`ID! The ID of the profile.
`url`URL! The URL for the profile.
`links`[Link!]! The links for the profile

Related Types

References: Link, URL

Referenced by: Company, Partner, Worker

Project

A project with a budget containing one or more jobs.

Fields
`id`ID! The ID of the project.
`name`String! The name of the project.
`description`String The description of the project.
`currency`Currency! The currency used for this project.
`creator`User! The creator of the project.
`company`Company! The company that the project is for.
`internalBudget`Decimal The total internal budget for the project.
`allocatedBudget`Decimal! The sum of all associated job budgets that have been allocated to the internal budget of the project.
`spent`Decimal! The amount that is spent out of the internal budget for the project. Spent for the project budget is registered when a bill is approved on an associated job.
`endDate`Date The date that the project ended. If this is set to `null`, we will assume that the project is not yet ended but active.
`owners`[User!]! The owners of the project.
`externalIdentifier`String An identifier associated with the project from an external system.
`jobs`JobPaginator! Jobs added to this project.

Related Types

References: Company, Currency, Date, Decimal, JobPaginator, User

Referenced by: Job, ProjectPaginator

ProjectPaginator

A paginated list of Project items.

Fields
`paginatorInfo`PaginatorInfo! Pagination information about the list of items.
`data`[Project!]! A list of Project items.

Related Types

References: PaginatorInfo, Project

Recruiter

A staffing agency account that sources and manages workers on behalf of companies.

Staffing agencies can be attributed to hires, manage workers during engagements, and earn fees based on their ownership period. Companies establish relationships with staffing agencies to leverage their talent sourcing capabilities.

Fields
`id`ID! The ID of the recruiter.
`name`String! The name of the recruiter.
`market`Market! The market that the recruiter is in.
`initials`String! The initials of the recruiter
`avatar`URL The avatar (or profile picture) for the recruiter.
`availableMarkets`[AvailableMarket!]! The markets and regions the recruiter is available in.
`owner`User The owner of the recruiter account
`clients`[CompanyRecruiter!]! The client relationships that the staffing agency has.
`candidates`[RecruiterCandidate!]! The candidate relationships that the recruiter has.
`insurances`[WorkerInsurance!]! The insurance information for the recruiter.

Related Types

References: AvailableMarket, CompanyRecruiter, Market, RecruiterCandidate, URL, User, WorkerInsurance

Referenced by: CompanyRecruiter, Hire, PaymentRequest, RecruiterCandidate, RecruiterPaginator

RecruiterCandidate

A recruiter candidate relationship.

Fields
`id`ID! The ID of the recruiter candidate.
`recruiter`Recruiter! The recruiter of the relationship.
`worker`Worker! The candidate in the relationship.
`email`String The email of the candidate.
`status`ContactStatus! The status of the candidate relationship.
`token`String The token used to invite the candidate.
`rate`Float The rate of the candidate.
`jobTitle`String The candidate job title
`country`String The candidate’s country of residence (cca2), from their location.
`state`String The candidate’s country state, if applicable.
`links`[String!]! The links attached to the relationship.
`tags`[Tag!]! The tags applied to the relationship.
`relationshipLabel`RecruiterCandidateRelationshipLabel! The recruiter’s commercial relationship with this worker, rolled up across all engagements (managed / referral / listed).
`files`FilePaginator! The files attached to the relationship.

Related Types

References: ContactStatus, FilePaginator, Recruiter, RecruiterCandidateRelationshipLabel, Tag, Worker

Referenced by: Recruiter, RecruiterCandidatePaginator

RecruiterCandidatePaginator

A paginated list of RecruiterCandidate items.

Fields
`paginatorInfo`PaginatorInfo! Pagination information about the list of items.
`data`[RecruiterCandidate!]! A list of RecruiterCandidate items.

Related Types

References: PaginatorInfo, RecruiterCandidate

RecruiterPaginator

A paginated list of Recruiter items.

Fields
`paginatorInfo`PaginatorInfo! Pagination information about the list of items.
`data`[Recruiter!]! A list of Recruiter items.

Related Types

References: PaginatorInfo, Recruiter

RejectedCustomTimesheetRegistration

A single rejected timesheet registration with the reason it was not accepted.

Fields
`externalId`String The externalId from the submitted payload, if one was provided. May be null if the registration was malformed.
`reason`CustomTimesheetRejectionReason! Machine-readable reason for the rejection.
`message`String! Human-readable explanation, suitable for logs or display to the client’s operator.

Related Types

References: CustomTimesheetRejectionReason

Referenced by: CreateCustomTimeSheetResponse

RunBatchActionResponse

The payload returned when running an action on a batch.

Fields
`batch`Batch The batch the action was run against.
`batchId`ID! The global ID of the batch. Always provided even if the batch was deleted.
`action`BatchActionType! The action that was requested.
`batchDeleted`Boolean! Whether the batch was deleted as a result of the action.
`resultUrl`String The URL of the result of the action.

Related Types

References: Batch, BatchActionType

Skill

A skill that is required for a job.

Fields
`id`ID! The ID of the skill.
`name`String! The name of the skill.

Related Types

Referenced by: Job, SkillPaginator, TrustedContact, Worker

SkillPaginator

A paginated list of Skill items.

Fields
`paginatorInfo`PaginatorInfo! Pagination information about the list of items.
`data`[Skill!]! A list of Skill items.

Related Types

References: PaginatorInfo, Skill

SmsCreateMultiFactorPayload

A response payload for a newly-created SMS multi-factor authentication implementation.

Fields
`multiFactor`SmsMultiFactor! The newly-created SMS multi factor.

Related Types

References: SmsMultiFactor

SmsMultiFactor

An SMS multi-factor authentication implementation.

Fields
`id`ID! The ID of the SMS multi-factor authentication implementation.
`name`String! The name of the SMS multi-factor authentication implementation.
`phoneNumber`E164PhoneNumber! The phone number for the SMS multi-factor authentication implementation.
`status`MultiFactorStatus! The status of the SMS multi-factor authentication implementation.
`owner`User! The owner of the SMS multi-factor authentication implementation.
`verifiedAt`DateTime When the SMS multi-factor authentication implementation was verified.
`createdAt`DateTime! When the SMS multi-factor authentication implementation was created.
`updatedAt`DateTime! When the SMS multi-factor authentication implementation was updated.

Related Types

References: DateTime, E164PhoneNumber, MultiFactorStatus, User

Referenced by: SmsCreateMultiFactorPayload

SupplierCandidate

A supplier candidate — a freelancer managed by a supplier account (Company or Recruiter).

Fields
`id`ID! The ID of the supplier candidate.
`supplier`Account The supplier account that owns this candidate.
`worker`Worker! The worker (freelancer) in the relationship.
`email`String The email used to invite the candidate.
`status`ContactStatus! The status of the candidate relationship.
`token`String The token used to invite the candidate.
`rate`Float The rate of the candidate.
`jobTitle`String The candidate job title.
`links`[String!]! The links attached to the candidate.
`tags`[Tag!]! The tags applied to the candidate by the supplier.
`files`FilePaginator! The files attached to the candidate.

Related Types

References: Account, ContactStatus, FilePaginator, Tag, Worker

Referenced by: SupplierCandidatePaginator

SupplierCandidatePaginator

A paginated list of SupplierCandidate items.

Fields
`paginatorInfo`PaginatorInfo! Pagination information about the list of items.
`data`[SupplierCandidate!]! A list of SupplierCandidate items.

Related Types

References: PaginatorInfo, SupplierCandidate

SupplierInvoice

A supplier invoice.

The invoice defines the amount due and is to be paid to the worker.

Fields
`id`ID! The ID of the supplier invoice.
`number`String A number referencing the supplier invoice. This is usually printed on the supplier invoice itself and should be used by booking system and finance departments. The supplier invoice number is in a human readable format.
`pdfUrl`URL! A URL of the actual supplier invoice. This URL will link to a PDF for the supplier invoice. This URL cannot be used for saving in external systems as it might change over time or be regenerated. If a permanent URL is needed for the supplier invoice, it should be stored in the clients own system.
`externalIdentifier`String An external identifier for the supplier invoice, used to reference it in external systems.

Related Types

References: URL

Referenced by: SupplierInvoicePaginator

SupplierInvoicePaginator

A paginated list of SupplierInvoice items.

Fields
`paginatorInfo`PaginatorInfo! Pagination information about the list of items.
`data`[SupplierInvoice!]! A list of SupplierInvoice items.

Related Types

References: PaginatorInfo, SupplierInvoice

Referenced by: PaymentRequest

Tag

A tag.

Fields
`id`ID! The ID of the tag.
`name`String The name of the tag.

Related Types

Referenced by: CompanyRecruiter, File, RecruiterCandidate, SupplierCandidate, TagPaginator

TagPaginator

A paginated list of Tag items.

Fields
`paginatorInfo`PaginatorInfo! Pagination information about the list of items.
`data`[Tag!]! A list of Tag items.

Related Types

References: PaginatorInfo, Tag

Referenced by: TrustedContact

TemporaryFileUploadResponse

The details for a temporary file upload.

Fields
`id`ID! The ID of the temporary file.
`name`String! The name of the file to be uploaded.
`url`URL! The temporary URL to upload the file to. The temporary URL will expire after 1 week.

Related Types

References: URL

Timesheet

A timesheet submitted by a worker for a hire.

Timesheets record hours worked during a billing period and are used to generate payment requests. They may also trigger overtime calculations when logged hours exceed standard thresholds.

Fields
`id`ID! The ID of the timesheet.
`worker`Worker The worker that the timesheet belongs to.
`hire`Hire The hire that the timesheet belongs to.
`startDate`Date The start date of timesheet.
`endDate`Date The end date of timesheet.
`createdAt`DateTime! The date and time that the timesheet was created.
`paymentRequests`PaymentRequestPaginator! The payment requests created on the timesheet.
`registrations`TimesheetRegistrationPaginator! The timesheet registrations.
`files`FilePaginator! The files that are related to the timesheet.
`overtimes`OvertimePaginator! The overtimes that the timesheet belongs to.

Related Types

References: Date, DateTime, FilePaginator, Hire, OvertimePaginator, PaymentRequestPaginator, TimesheetRegistrationPaginator, Worker

Referenced by: Overtime, PaymentRequest, TimesheetPaginator

TimesheetPaginator

A paginated list of Timesheet items.

Fields
`paginatorInfo`PaginatorInfo! Pagination information about the list of items.
`data`[Timesheet!]! A list of Timesheet items.

Related Types

References: PaginatorInfo, Timesheet

TimesheetRegistration

A registration for a timesheet.

Fields
`id`ID! The ID of the timesheet registration.
`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.
`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.
`customFieldValues`[CustomFieldValue!]! The custom fields values for the timesheet registration.

Related Types

References: CustomFieldValue, Date, Time, TimesheetRegistrationDurationUnit, TimesheetRegistrationType

Referenced by: TimesheetRegistrationPaginator

TimesheetRegistrationPaginator

A paginated list of TimesheetRegistration items.

Fields
`paginatorInfo`PaginatorInfo! Pagination information about the list of items.
`data`[TimesheetRegistration!]! A list of TimesheetRegistration items.

Related Types

References: PaginatorInfo, TimesheetRegistration

Referenced by: Timesheet

TotpCreateMultiFactorPayload

A response payload for a newly-created TOTP multi-factor authentication implementation.

Fields
`multiFactor`TotpMultiFactor! The newly-created TOTP multi factor.
`secret`String! The secret for the newly-created TOTP multi factor.
`qrCode`URL! A URL for the QR Code containing the secret. This is not the QR Code itself, but the URL that the QR code should contain. The URL is in `otpauth` format.

Related Types

References: TotpMultiFactor, URL

TotpMultiFactor

A TOTP multi-factor authentication implementation.

Fields
`id`ID! The ID of the TOTP multi-factor authentication implementation.
`name`String! The name of the TOTP multi-factor authentication implementation.
`status`MultiFactorStatus! The status of the TOTP multi-factor authentication implementation.
`owner`User! The owner of the TOTP multi-factor authentication implementation.
`verifiedAt`DateTime When the TOTP multi-factor authentication implementation was verified.
`createdAt`DateTime! When the TOTP multi-factor authentication implementation was created.
`updatedAt`DateTime! When the TOTP multi-factor authentication implementation was updated.

Related Types

References: DateTime, MultiFactorStatus, User

Referenced by: TotpCreateMultiFactorPayload

TrustedContact

A trusted contact — a worker in a company’s Talent Pool.

Trusted contacts represent the relationship between a company and a worker. A worker must be added as a trusted contact before the company can hire them directly (without going through the marketplace). Trusted contacts go through an approval workflow and can have custom fields, skills, and onboarding documents.

Fields
`id`ID! The ID of the trusted contact.
`worker`Worker! The trusted contact worker.
`company`Company! The trusted contact company.
`invitedByUser`User The user who invited the worker as trusted contact of the company. A `null` value here means the trusted contact was automatically added by a process.
`viewerCanApprove`Boolean! Whether the viewer is able to approve the trusted contact.
`viewerCanUpdate`Boolean! Whether the viewer is able to update the trusted contact.
`viewerCanDelete`Boolean! Whether the viewer is able to delete the trusted contact.
`viewerCanReInvite`Boolean! Whether the viewer is able to re-invite the trusted contact.
`links`[String!]! Links associated with the trusted contact.
`attachments`[File!]! File attachments uploaded by the company that are related to the worker.
`skills`[Skill!]! Skills associated with the trusted contact.
`managedStatus`TrustedContactManagedStatus Trusted contact managed status.
`status`ContactStatus! Status of the trusted contact.
`statusUpdatedAt`Date! The date that the status of the trusted contact was last updated.
`invitedAt`Date! The date that the trusted contact was invited.
`approvedByUser`User The user who approved the worker as trusted contact.
`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`[CustomFieldValue!]! The custom fields values for the trusted contact.
`requiredCustomFieldsComplete`Boolean! Whether all required worker-editable custom fields have been filled.
`onboardingStatus`TrustedContactOnboardingStatus The onboarding status of the trusted contact.
`onboardingDocuments`[OnboardingDocument!]! The onboarding documents associated with the trusted contact.
`compliances`[Compliance!]! Compliance requirements for this worker as seen by the trusted contact’s company. The viewing company is unambiguous here (it’s the pivot’s company), so per-company review state never depends on session state. When `names` is omitted, the curated review-modal subset is returned. Pass explicit names to filter to a specific compliance.
`createdAt`Date! The date that the trusted contact was created.
`tags`TagPaginator! Deprecated The tags for a trusted contact.
`notes`NotePaginator! Notes added to the trusted contact.

Related Types

References: Company, Compliance, ContactStatus, CustomFieldValue, Date, File, NotePaginator, OnboardingDocument, Skill, TagPaginator, TrustedContactManagedStatus, TrustedContactOnboardingStatus, TrustedContactOrigin, TrustedContactOriginChannel, User, Worker

Referenced by: TrustedContactPaginator

TrustedContactPaginator

A paginated list of TrustedContact items.

Fields
`paginatorInfo`PaginatorInfo! Pagination information about the list of items.
`data`[TrustedContact!]! A list of TrustedContact items.

Related Types

References: PaginatorInfo, TrustedContact

Referenced by: Company

UpdateWorkerCustomFieldValuesPayload

The payload returned after updating custom field values as a worker.

Fields
`fieldable`SupportsCustomFieldValue! The updated fieldable entity.
`customFieldValues`[CustomFieldValue!]! The updated field values.

Related Types

References: CustomFieldValue, SupportsCustomFieldValue

User

A user who can sign in to Worksome and act on behalf of one or more accounts.

Users are the people behind accounts — a single user may be a team member of a company, an owner of a staffing agency, or a worker. They authenticate and perform actions within their active account context.

Fields
`id`ID! The ID of the user.
`name`String! The name of the user.
`email`String! The email of the user
`avatar`URL The avatar (or profile picture) for the user.
`hasConsentedToWorksomeIntelligence`Boolean! Whether the user has consented to use Worksome Intelligence.
`canCreatePassword`Boolean! Whether the user is allowed to create a password for their account. The user might not be allowed if they already have a password, in which case they should use `updatePassword` or if they have SAML on their account.
`missingAuthentication`Boolean! Whether the user has any way of authenticating into the system. This will check that the user has no password, social, SAML etc. way of authenticating into their account.
`hasVerifiedEmail`Boolean! Checks whether the user has verified their email or not.
`emailVerifiedAt`DateTime When the email was verified.
`createdAt`DateTime! When the account was created.
`updatedAt`DateTime! When the account was last updated.

Related Types

References: DateTime, URL

Referenced by: ApprovalState, Classification, ComplianceDataUser, Contract, CustomField, CustomFieldValue, Employment, Hire, Job, JobCandidate, Message, Note, PaymentRequest, Project, Recruiter, SmsMultiFactor, TotpMultiFactor, TrustedContact, UserPaginator, Wcr

UserGroup

A named group of company team members.

User groups are used to assign approvers in approval workflows — when an approval is required, the members of the assigned user group are notified and can take action.

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

Related Types

References: Company, UserGroupStatus, UserPaginator

Referenced by: Approver, UserGroupPaginator

UserGroupPaginator

A paginated list of UserGroup items.

Fields
`paginatorInfo`PaginatorInfo! Pagination information about the list of items.
`data`[UserGroup!]! A list of UserGroup items.

Related Types

References: PaginatorInfo, UserGroup

UserPaginator

A paginated list of User items.

Fields
`paginatorInfo`PaginatorInfo! Pagination information about the list of items.
`data`[User!]! A list of User items.

Related Types

References: PaginatorInfo, User

Referenced by: Company, UserGroup

Wcr

Represents the Worksome Classification Recommendation (WCR) in the system.

Fields
`id`ID! The ID of the WCR.
`user`User The user associated with this WCR.
`supersededBy`WcrSupersede Reference to a supersede record, indicating a newer WCR that replaces or supersedes a previous one.
`overridesAnother`Boolean! Determines whether this WCR overrides another WCR. Details can be found in the WcrSupersede.

Related Types

References: User, WcrSupersede

Referenced by: Hire, WcrSupersede

WcrSupersede

Represents the supersede relationship for an WCR, used when one WCR replaces or supersedes another.

Fields
`type`WcrSupersedeType! The specific type of the supersede (e.g., ‘DISPUTE’, ‘OVERRIDE’, etc.).
`originalWcr`Wcr Reference to the original WCR that is being superseded.
`reason`String The reason provided for the supersede by the user.
`filedAt`Date! The date on which this supersede was filed.

Related Types

References: Date, Wcr, WcrSupersedeType

Referenced by: Wcr

Webhook

The webhook definition.

Fields
`id`ID! The ID of the webhook.
`title`String! The title of the webhook.
`description`String The description of the webhook.
`owner`String! The owner of the webhook (company name).
`url`String! The URL of the webhook.
`secret`String The secret of the webhook.
`isActive`Boolean Whether the webhook is active or not.
`clientId`String The client ID of the webhook, when using OAuth.
`clientSecret`String The client secret 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 is subscribed to. If null, the webhook is subscribed to all event types. If an empty array, the webhook is not subscribed to any events.
`createdAt`DateTime! The date and time that the webhook was created.
`updatedAt`DateTime! The date and time that the webhook was updated.

Related Types

References: DateTime, WebhookEventType

Referenced by: WebhookEventLog, WebhookPaginator

WebhookEvent

The webhook event definition.

Fields
`id`ID! The ID of the webhook event.
`key`String! The unique key of the webhook event.
`webhookId`ID! The ID of the webhook.
`event`String! The webhook event identifer. Refer to the webhook event documentation for more information about which event values Worksome uses here.
`description`String! The webhook event description (human readable version of the `event` field).
`status`String! The latest status of the webhook sending attempts: - `pending`: The webhook has not yet been sent. - `success`: The webhook was sent successfully. - `failed-N`: The webhook sending attempt failed for the N’th time. - `failed-finally`: The webhook sending attempt failed and will not be retried automatically.
`payload`JSON! The webhook event payload.
`logs`[WebhookEventLog!]! The log entries of webhook event calls.
`createdAt`DateTime! The date and time that the webhook event was created.
`updatedAt`DateTime! The date and time that the webhook event was updated.

Related Types

References: DateTime, JSON, WebhookEventLog

Referenced by: WebhookEventLog, WebhookEventPaginator

WebhookEventLog

The webhook event log definition.

Fields
`id`ID! The ID of the webhook event log.
`key`String! The unique key of the webhook event.
`result`String! The result of the webhook sending attempt: - `success`: The webhook was sent successfully. - `failed-N`: The webhook sending attempt failed for the N’th time. - `failed-finally`: The webhook sending attempt failed and will not be retried automatically.
`statusCode`Int The HTTP status code of the the webhook sending attempt.
`webhook`Webhook! The webhook.
`webhookEvent`WebhookEvent! The webhook event.
`request`JSON! The webhook event request.
`response`JSON! The webhook event response.
`createdAt`DateTime! The date and time that the webhook event log was created.

Related Types

References: DateTime, JSON, Webhook, WebhookEvent

Referenced by: WebhookEvent, WebhookEventLogPaginator

WebhookEventLogPaginator

A paginated list of WebhookEventLog items.

Fields
`paginatorInfo`PaginatorInfo! Pagination information about the list of items.
`data`[WebhookEventLog!]! A list of WebhookEventLog items.

Related Types

References: PaginatorInfo, WebhookEventLog

WebhookEventPaginator

A paginated list of WebhookEvent items.

Fields
`paginatorInfo`PaginatorInfo! Pagination information about the list of items.
`data`[WebhookEvent!]! A list of WebhookEvent items.

Related Types

References: PaginatorInfo, WebhookEvent

WebhookPaginator

A paginated list of Webhook items.

Fields
`paginatorInfo`PaginatorInfo! Pagination information about the list of items.
`data`[Webhook!]! A list of Webhook items.

Related Types

References: PaginatorInfo, Webhook

Worker

A worker account — a freelancer or contractor who can be hired by companies on Worksome.

Workers maintain a profile with skills, experience, and business entity details. They can be hired in two ways: by submitting a bid on a published job (marketplace flow), or via a direct hire — which requires the worker to first be added as a trusted contact in the company’s Talent Pool.

Fields
`id`ID! The ID of the worker.
`name`String! The name of the worker.
`firstName`String! The first name of the worker.
`lastName`String! The last name of the worker.
`middleName`String The middle name of the worker.
`email`String The email of the worker.
`phone`String The phone of the worker.
`avatar`URL The avatar (or profile picture) for the worker.
`address`Address The address that the worker is registered to.
`market`Market! The market that the worker is in.
`skills`[Skill!]! The skills that the worker has.
`profile`Profile The profile that the worker has.
`jobTitle`String The job title that the worker has.
`initials`String! The initials for the worker name.
`viewerCanEdit`Boolean! True when the viewer can edit this worker’s profile on their behalf.
`currency`String! The currency that the worker uses.
`dayRate`Float The daily rate for the worker.
`rtwVerifiedAt`DateTime Right to work verification and background checks have been made for this worker at this date.
`rtwExpiresAt`DateTime Right to work verification and background checks for this worker will expire by this date. If the expire date is in the future the verification is still valid.
`hiresWithAttribution`[Hire!]! Recruiter-attributed hires the viewer can see, as client, recruiter, or supplier. Workers get nothing; use `hires` instead. Includes drafts.
`primaryBusinessEntity`BusinessEntity The business entity that the worker uses.
`totalPaid`Float! The total amount received/paid by the given company.
`viewerIsClient`Boolean Whether the worker is a trusted contact for the current viewer. Only companies can see this.
`viewerCanContact`Boolean! Whether the viewer is able to contact the trusted contact.
`viewerCanOfferJob`Boolean! Whether the viewer is able to offer jobs to the trusted contact
`engagedViaSupplierName`String The name of the staffing agency / MSP through which the viewer’s company engages this worker, when every hire between them is sourced through a supplier. Returns null when the viewer’s company engages the worker directly (or has no engagement with them).
`isCurrentlyHired`Boolean! Determines if the worker is currently hired by the given company.
`clients`[Client!]! A list of relations between the worker and a company as seen from the workers perspective.
`insurances`[WorkerInsurance!]! The insurance information for the worker.
`identification`WorkerIdentification The worker’s identification details.
`businessEntities`BusinessEntityPaginator! The business entities that the worker has.
`hires`HirePaginator! The hires associated with the worker.

Related Types

References: Address, BusinessEntity, BusinessEntityPaginator, Client, DateTime, Hire, HirePaginator, Market, Profile, Skill, URL, WorkerIdentification, WorkerInsurance

Referenced by: Bid, Classification, Contract, Employment, Hire, InvoiceRow, JobCandidate, Overtime, PaymentRequest, RecruiterCandidate, SupplierCandidate, Timesheet, TrustedContact

WorkerIdentification

Identification details supplied by the worker.

Fields
`dateOfBirth`Date The worker’s date of birth. Null if it has not been provided.
`nationality`String! ISO 3166-1 alpha-2 country code of the worker’s nationality.
`documentType`IdentificationDocumentType! The kind of identification document the worker has provided.
`documentNumber`String! The full document number.
`documentNumberObfuscated`String The document number, partially masked.
`documentExpiresAt`Date! When the document expires.

Related Types

References: Date, IdentificationDocumentType

Referenced by: Worker

WorkerInsurance

Insurance information for a worker.

Fields
`type`String! The insurance type.
`title`String! The human-readable title of the insurance type.
`hasInsurance`Boolean! Whether the worker has this insurance.
`policyLimit`Int The policy limit amount in the smallest currency unit.
`updatedAt`DateTime The date when the insurance information was last updated.
`files`[File!]! The proof of insurance files.

Related Types

References: DateTime, File

Referenced by: Recruiter, Worker

Workflow

A workflow — an alternative tree-structured view of an approval flow for hires.

A Workflow is backed by the same data as an Approval, but exposes the structure as a tree of nodes (rules with their approvers). Use the workflow/workflows queries to read the tree structure, and createWorkflow/updateWorkflow to manage the entire approval flow as a single operation.

Workflows currently apply only to hires — they cannot be used for jobs, payment requests, or other entities. See the Approval type for supported trigger events.

Fields
`id`ID! The ID of the workflow (same as the underlying approval ID).
`nodes`[Nodeable!]! The approval rules that form the branches of this workflow tree.

Related Types

References: Nodeable

Referenced by: WorkflowPaginator

WorkflowPaginator

A paginated list of Workflow items.

Fields
`paginatorInfo`PaginatorInfo! Pagination information about the list of items.
`data`[Workflow!]! A list of Workflow items.

Related Types

References: PaginatorInfo, Workflow

WorkflowVariableOption

A selectable option for an option-type workflow variable.

Fields
`displayOrder`Int! The display order of the option in the list.
`label`String! The human-readable label for this option.
`value`String! The value to use when creating a condition with this option.

Related Types

Referenced by: WorkflowVariableOptionType

WorkflowVariableOptionType

A workflow variable that accepts one of a predefined set of options for comparison.

For example, a classification result variable with options like “Employee” and “Independent Contractor”.

Fields
`id`ID! The identifier for this variable.
`title`String! The human-readable title of the variable.
`description`String A description of what the variable represents.
`operators`[WorkflowVariableOperator!]! The comparison operators available for this variable.
`options`[WorkflowVariableOption!]! The predefined options that can be selected as the comparison value.

Related Types

References: WorkflowVariableOperator, WorkflowVariableOption

WorkflowVariablePaginator

A paginated list of WorkflowVariable items.

Fields
`paginatorInfo`PaginatorInfo! Pagination information about the list of items.
`data`[WorkflowVariable!]! A list of WorkflowVariable items.

Related Types

References: PaginatorInfo, WorkflowVariable

WorkflowVariableRule

A condition on an approval rule — compares a workflow variable against a threshold value.

For example, a rule might have a condition: “hourly rate greater than 100”. The variable field identifies what is being compared, operator defines the comparison type, and value is the threshold.

Fields
`id`ID! The ID of the condition.
`fieldId`String! The identifier of the variable or custom field being evaluated.
`approvalRule`ApprovalRule! The approval rule that this condition belongs to.
`variable`WorkflowVariable! The workflow variable being evaluated in this condition.
`operator`WorkflowVariableOperator! The comparison operator (e.g. equals, greater than, less than).
`value`String! The threshold value to compare against.
`createdAt`Date! The date that this condition was created.
`updatedAt`Date! The date that this condition was last updated.

Related Types

References: ApprovalRule, Date, WorkflowVariable, WorkflowVariableOperator

Referenced by: ApprovalRule, CustomField

WorkflowVariableStringType

A workflow variable that accepts free-text string values for comparison.

Fields
`id`ID! The identifier for this variable.
`title`String! The human-readable title of the variable.
`description`String A description of what the variable represents.
`operators`[WorkflowVariableOperator!]! The comparison operators available for this variable.

Related Types

References: WorkflowVariableOperator