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
addressString
The address.
postCodeString
The post code (ZIP code).
cityString
The city.
stateString
The state.
countryCountry
The country object.

Approval

The approval definition.

Fields
idID!
The ID of the approvals.
nameString!
The name of the approval.
versionInt!
The version of the approval.
statusApprovalStatus!
The status of the approval.
triggerApprovalTrigger!
The trigger type of the approval.
descriptionString!
The description of the approval.
companyCompany!
The company owning the approval.
approvalRules[ApprovalRule!]!
The approval rules related to the approval.
createdAtDateTime!
The date and time that the approval was created.
updatedAtDateTime!
The date and time that the approval was updated.

ApprovalApprovable

The approval approvable definition.

Fields
idID!
The ID of the approval approvable.
approvalApproval!
The approval that the approvable belongs to.
approvalRuleApprovalRule!
The approval rule that the approvable belongs to.
approvalStates[ApprovalState!]!
The approval states that the approvable has.
approvableApprovable
The approvable related to the approval approvable.
viewerCanActionBoolean!
Indicates if the viewer can perform action on the approval approvable.

ApprovalApprovablePaginator

A paginated list of ApprovalApprovable items.

Fields
paginatorInfoPaginatorInfo!
Pagination information about the list of items.
data[ApprovalApprovable!]!
A list of ApprovalApprovable items.

ApprovalPaginator

A paginated list of Approval items.

Fields
paginatorInfoPaginatorInfo!
Pagination information about the list of items.
data[Approval!]!
A list of Approval items.

ApprovalRule

The approval rule definition.

Fields
idID!
The ID of the approval rules.
approvalApproval!
The approval owning this rule.
fields[CustomField!]!
The fields related to the approval rule with associated rule definition.
rules[WorkflowVariableRule!]!
The rules related to the approval rule.
approvers[Approver!]!
The approvers related to the approval rule.
createdAtDate!
The date that the approval rule was created.
updatedAtDate!
The date that the approval rule was updated.

ApprovalRulePaginator

A paginated list of ApprovalRule items.

Fields
paginatorInfoPaginatorInfo!
Pagination information about the list of items.
data[ApprovalRule!]!
A list of ApprovalRule items.

ApprovalState

The approval state definition.

Fields
idID!
The ID of the approval approvables states.
stateApprovalStateEnum!
The state of the approval approvable.
actionedByUser!
The user that actioned on the approval approvable.
messageString
The message for the approval approvable.
approverApprover!
The approver the approval approvables it belongs to.
approvalApprovableApprovalApprovable!
The approval approvables that the states belongs to.
createdAtDateTime
The date that the approval state was created.

Approver

The approver definition.

Fields
idID!
The ID of the approvers.
approvalRuleApprovalRule!
The approval rule this approver belongs to.
userGroupUserGroup!
The user group related to this approver.
positionInt!
The current order the approver is in the sequence of receiver.
createdAtDate!
The date that the approver was created.
updatedAtDate!
The date that the approver was updated.

ApproverPaginator

A paginated list of Approver items.

Fields
paginatorInfoPaginatorInfo!
Pagination information about the list of items.
data[Approver!]!
A list of Approver items.

AuthenticationToken

Contains information about an authentication token.

Fields
accessTokenString!
The access token for authenticating.

BankDetail

A bank account details.

Fields
idID!
The ID of the bank account details.
nameString!
The display name for this bank account.
bankAddressString!
The address of this bank account.
bankCountryString!
The country of this bank account.
bankNameString!
The name of this bank account.
beneficiaryNameString!
The beneficiary name of this bank account.
bbanBban
The BBAN information, if applicable.
ibanString
The bank account IBAN, if applicable.
swiftString
The bank account SWIFT code, if applicable.

Bban

The BBAN type details.

Fields
bsbString
The Bank-State-Branch or BSB number.
bankIdString
The bank ID.
bankCodeString
The bank code.
branchIdString
The bank branch ID.
branchCodeString
The bank branch code.
accountNumberString
The bank account number.
accountSuffixString
The bank account suffix.
institutionNumberString
The bank institution number
transitNumberString
The bank transit number.
registrationNumberString
The bank registration number.
routingCodeString
The bank routing code.
sortCodeString
The bank sort code.
purposeOfPaymentString
The bank purpose of payment code.

Bid

Represents a bid sent on a job.

Fields
idID!
The ID of the bid.
statusBidStatus!
The status of the bid.
jobJob!
The job which the bid was made on.
conversationConversation!
The conversation which contains the bid.
messageMessage!
The message with the bid.
workerWorker!
The worker that this bid belongs to.
supplierAccount
The supplier account for this bid, if applicable.

BidPaginator

A paginated list of Bid items.

Fields
paginatorInfoPaginatorInfo!
Pagination information about the list of items.
data[Bid!]!
A list of Bid items.

BusinessEntity

A business entity.

Fields
idID!
The ID of the business entity.
typeBusinessEntityType!
The company name for the business entity.
nameString!
The company name for the business entity.
companyNameString
The company name for the business entity.
companyNumberString
The company number for the business entity.
taxNumberString
The tax number for the business entity.

BusinessEntityPaginator

A paginated list of BusinessEntity items.

Fields
paginatorInfoPaginatorInfo!
Pagination information about the list of items.
data[BusinessEntity!]!
A list of BusinessEntity items.

Company

A company.

Fields
idID!
The ID of the company.
nameString!
The name of the company.
currencyString!
The company preferred currency.
marketMarketCode!
The market that the company is in.
avatarURL
The avatar (or profile picture) for the company.
profileProfile
The profile that the company has.
contactInviteUrlString
The company full invite url.
settingsCompanySettings
The settings for the company.
addressAddress
The address of the company.
trustedContactsTrustedContactPaginator!
The trusted contacts that the company has.
teamMembersUserPaginator!
The team members that the company has.
teamMembersAndOwnersUserPaginator!
The team members and owners that the company has.
organisationsOrganisationPaginator!
The organisations that a company is a part of.
customFieldsCustomFieldPaginator!
The custom fields that the company owns.

CompanyPaginator

A paginated list of Company items.

Fields
paginatorInfoPaginatorInfo!
Pagination information about the list of items.
data[Company!]!
A list of Company items.

CompanyRecruiter

A company recruiter relationship.

Fields
idID!
The ID of the company recruiter.
emailString
The mail of the recruiter.
statusContactStatusEnum!
Status of the company recruiter.
tokenString
The token used to invite the recruiter.
messageString
The message sent to the recruiter when inviting them.
recruiterFeeFloat
The fee of the recruiter for the relationship.
recruiterOwnershipDaysInt
The days of ownership of the recruiter.
recruiterOwnershipDaysLeftInt!
The amount of days left of the ownership.
recruiterRecruiter!
The company recruiter recruiter.
companyCompany!
The company recruiter company.
tags[Tag!]!
The tags applied to the relationship.
externalIdentifierString
An identifier associated with the company recruiter from an external system.

CompanyRecruiterPaginator

A paginated list of CompanyRecruiter items.

Fields
paginatorInfoPaginatorInfo!
Pagination information about the list of items.
data[CompanyRecruiter!]!
A list of CompanyRecruiter items.

CompanySettings

Company settings.

Fields
projectTrackingBoolean
Whether project tracking is enabled.
requiredJobBudgetBoolean
Whether job budget is required.
multiCurrencyContractsDisabledBoolean
Whether a company has enabled multi currency contracts.
staffingAgencyManagesWorkerBoolean
Whether a company has enabled manging of workers by staffing agencies.

Contract

A contract.

Fields
idID!
The ID of the contract.
jobNameString!
The name of the contract that the job is for.
jobDescriptionString!
The description of the contract that the job is for.
locationPreferenceLocationPreference!
The location preference of the contract.
statusContractStatus!
The status of the contract.
startDateDate
The date that the contract started.
endDateDate
The date that the contract ended.
addressString
The address of the contract.
currencyCurrency!
The type of currency.
rateTypeRateType
The unit of time when payment is due.
rateFloat
The payment amount per specified rate type.
purchaseOrderNumberString
The Purchase Order (PO) number.
companyCvrString
The company’s Central Virksomhed (Company) Registration (CVR) number.

For more information, visit: https://datacvr.virk.dk
pdfUrlURL
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.
paymentTermMethodPaymentTermMethod!
The method of payment over the specified term.
paymentTermInt!
The term that the payment will be made within, in days.

Example paymentTerm: 10 means Worksome will pay the freelancers approved bills within 10 days.
termsAcceptedBoolean!
Whether the contract’s terms have been accepted.
termsAcceptedAtDateTime
The date that the terms were accepted.
workerAcceptedAtDateTime
The date that the terms were accepted by a worker.
workerSignatureString
The submitted signature of the accepted worker.
jobJob!
The job for which the contract is for.
workerWorker!
The worker for which the contract is for.
companyCompany!
The company for which the contract is for.
businessEntityBusinessEntity
The business entity associated with the contract.

ContractPaginator

A paginated list of Contract items.

Fields
paginatorInfoPaginatorInfo!
Pagination information about the list of items.
data[Contract!]!
A list of Contract items.

Conversation

A conversation between a company and a worker.

Fields
idID!
The ID of the conversation.
subjectString!
The subject line of the conversation.
jobJob
The job that the conversation is related to.
latestMessageMessage
The latest message sent in the conversation.
urlURL!
The URL for the conversation.
createdAtDate!
The date that the conversation was created.
closedAtDate
The date that the conversation was closed.
messagesMessagePaginator!
The messages in the conversation.
participantsParticipantPaginator!
The participants involved in the conversation.

ConversationPaginator

A paginated list of Conversation items.

Fields
paginatorInfoPaginatorInfo!
Pagination information about the list of items.
data[Conversation!]!
A list of Conversation items.

Country

A country.

Fields
isoCodeString!
The ISO 3166 alpha-2 code.

This is a two-letter country identifier (e.g. US).
nameString
The full name of the country.

CreateCustomTimeSheetResponse

The response from creating a custom timesheet.

Fields
providedRegistrationsInt!
The number of timesheet registrations that were detected.
successfulRegistrationsInt!
The number of timesheet registrations that were successfully parsed.

CreateExportResponse

A response with data from the export creation.

Fields
statusExportResponseStatus!
The status of the export.
messageString!
A message explaining the result of the export.

CustomField

A custom field.

Fields
idID!
The ID of the field.
userUser!
The user that created the field.
accountAccount!
The account that the field is owned by.
titleString!
The title of the field.
slugString
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.
descriptionString
The description of the field.
fieldTypeCustomFieldType!
The type of the field.
appliesToTypeSupportingCustomFieldValues!
The type of item that the field applies to.
customFieldOptions[CustomFieldOption!]!
The possible options for the field.
settingsCustomFieldSettings!
Additional custom field settings.

For example, validation rules.
visibilityCustomFieldVisibility!
To which people should the custom field be visible to.
customFieldValues[CustomFieldValue!]!
The custom field related values which were applied on an entity.
isUsedInFieldValuesBoolean!
Whether the field has been applied to an entity supporting custom fields.
ruleWorkflowVariableRule
Access to the approval rule field pivot, containing the operator and rule value.
approvalBoolean!
Whether the field is enabled for approval workflows.
viewerCanUpdateBoolean!
Whether the user querying the field can edit it.
apiOnlyBoolean!
Whether the field is enabled to be updated by the API only.
viewerCanManageFieldValuesBoolean!
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.

CustomFieldOption

A custom field option.

Fields
idID!
The ID of the field option.
customFieldCustomField!
The field that the field option is valid for.
displayOrderInt!
The display order of the field option.

This is an unsigned integer.
valueString!
The value of the field option.

CustomFieldPaginator

A paginated list of CustomField items.

Fields
paginatorInfoPaginatorInfo!
Pagination information about the list of items.
data[CustomField!]!
A list of CustomField items.

CustomFieldSettings

The settings for a custom field.

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

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
idID!
The ID of the field value.
accountAccount!
The account that the field value is owned by.
userUser!
The user who created the field value.
appliesToSupportsCustomFieldValue!
The entity to which the custom field value is applying to.
customFieldCustomField!
The field that the field value is valid for.
customFieldOptionCustomFieldOption
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.
contentString
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.
displayValueString
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, or will return the custom field option value for a single-select value.

Expense

An expense.

Fields
idID!
The ID of the expense.
descriptionString
The description of the expense.
currencyCurrency!
The currency of the expense.
amountFloat!
The amount of the expense.
vendorString!
The vendor of the expense.
expenseAtDateTime!
The date and time that the expense was expensed.
createdAtDateTime!
The date and time that the expense was created.

ExpensePaginator

A paginated list of Expense items.

Fields
paginatorInfoPaginatorInfo!
Pagination information about the list of items.
data[Expense!]!
A list of Expense items.

ExpenseReport

An expense report.

Fields
idID!
The ID of the expense report.
titleString
The title of the expense report.
descriptionString
The description of the expense report.
totalFloat!
The total of the expense report.
isDraftBoolean!
Whether the expense report is a draft.
createdAtDateTime
The date and time that the expense report was created.
expensesExpensePaginator!
The expenses on the expense report.

ExpenseReportPaginator

A paginated list of ExpenseReport items.

Fields
paginatorInfoPaginatorInfo!
Pagination information about the list of items.
data[ExpenseReport!]!
A list of ExpenseReport items.

File

A file.

Fields
idID!
The ID of the file.
nameString!
The name of the file.
sizeInt!
The size of the file in bytes.
mimeTypeString!
The IANA MIME type of the file.
ownerAccount!
The account that the file belongs to.
urlString!
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.

FilePaginator

A paginated list of File items.

Fields
paginatorInfoPaginatorInfo!
Pagination information about the list of items.
data[File!]!
A list of File items.

ForceLogoutPayload

Contains information about the user who was forcefully logged out.

Fields
userUser!
The user.
revokedTokens[Token!]!
The tokens that have been revoked.

Hire

A representation of a hiring on a job between parties.

Usually a hire is between a worker and a company on a job created by a company. A hire is not a legal document, it is simply used to show that the parties have agreed to work together. The contracts which can be found on the hire is however a legal document.

Fields
idID!
The ID of the hire.
numberString!
The unique reference for the hire.
latestContractContract!
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.
activeContractContract
The currently active contract.

This has been accepted by all parties and is the active legal document between them.
companyCompany!
The company which the worker will work with.
jobJob!
The job that the hire is on.
recruiterRecruiter
The recruiter attributed to the hire.
workerWorker!
The worker which the company is hiring.
conversationConversation!
The conversation which the hire is happening on.
createdAtDate!
The date that the hire was created.
dateStartDate Deprecated
The date that the hire started.
dateEndDate Deprecated
The date that the hire ended.
startDateDate
The date that the hire started.
endDateDate
The date that the hire ended.
recruiterOwnershipStartDateDate
The date that recruiter ownership started.
recruiterFeePercentage
The recruiter’s fee.
recruiterOwnershipDaysInt
The number of ownership days for the recruiter.
recruiterOwnershipIsExpiredBoolean
Indicates whether or not the recruiter ownership has expired yet.
recruiterOwnershipDaysLeftInt
Number of days left in the recruiter’s ownership.
currencyString!
The currency of the hire.
rateFloat
The rate for the hire.
rateTypeString
The rate type for the hire.
statusHireStatus!
The hire status for the hire.
offeredAtDate
The date that the hire became active.
externalIdentifierString
An identifier associated with the hire from an external system.
purchaseOrderNumberString
The assigned Purchase Order (PO) number, if one has been added.
recruiterManagesWorkersBoolean
Whether the assigned recruiter manages workers.
contractsContractPaginator!
The contracts for the hire.

These are legal documents, however it can contain old contracts and drafts also.
billsPaymentRequestPaginator! Deprecated
The payment requests created on the hire.
paymentRequestsPaymentRequestPaginator!
The payment requests created on the hire.

HirePaginator

A paginated list of Hire items.

Fields
paginatorInfoPaginatorInfo!
Pagination information about the list of items.
data[Hire!]!
A list of Hire items.

Industry

An industry.

Fields
idID!
The ID of the industry.
nameString!
The name of the industry.

IndustryPaginator

A paginated list of Industry items.

Fields
paginatorInfoPaginatorInfo!
Pagination information about the list of items.
data[Industry!]!
A list of Industry items.

Invoice

An invoice.

An invoice gets created when one or more worker payment requests gets approved by a company user.

The invoice defines the amount due and is to be paid to Worksome by the company.

Fields
idID!
The ID of the invoice.
numberString
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.
pdfUrlURL!
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.
currencyCurrency!
The type of currency.
grossAmountFloat!
The total amount including taxes etc.
grossOpenAmountFloat!
The total amount due on invoice minus credited amounts including taxes etc.
taxAmountFloat!
The total amount of taxes to be paid.
netAmountFloat!
The total amount without taxes.
markedPaidAtDate
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.
dueDateDate!
The date that the invoice should be paid by.
companyCompany!
The company that the invoice is for.
dateDate!
The date that the invoice was created.
isBatchedBoolean!
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.
transactionTypeInvoiceTransactionType!
The type of transaction to be used for the invoice.
isFullyCreditedBoolean!
Checks if the invoice has been fully credited.
creditNotes[Invoice!]!
The credit notes associated with the invoice.
originalInvoiceInvoice
The original invoice credited by this credit note.
rowsInvoiceRowPaginator!
A paginated list of all the rows on the invoice.

This can be used to gather more information about the invoice then just overall amount.

InvoicePaginator

A paginated list of Invoice items.

Fields
paginatorInfoPaginatorInfo!
Pagination information about the list of items.
data[Invoice!]!
A list of Invoice items.

InvoiceRow

A row on the invoice.

Fields
idID!
The ID of the invoice row.
billPaymentRequest Deprecated
The payment request which the row on the invoice is related to.
paymentRequestPaymentRequest
The payment request which the row on the invoice is related to.
workerWorker
The worker that is linked to this row.
customTextString
A custom text which will be shown on the invoice PDF.

InvoiceRowPaginator

A paginated list of InvoiceRow items.

Fields
paginatorInfoPaginatorInfo!
Pagination information about the list of items.
data[InvoiceRow!]!
A list of InvoiceRow items.

Job

A job that a company has created on Worksome.

Fields
idID!
The ID of the job.
nameString!
The name of the job.
skills[Skill!]!
The skills required for the job.
descriptionString
The description of the job.
marketMarketCode!
The market that the job is in.
addressString
The address of the job.
currencyCurrency!
The type of currency.
rateTypeRateType
The unit of time when payment is due.
rateFloat
The payment amount per specified rate type.
minimumRateFloat
The minimum payment amount per specified rate type.
maximumRateFloat
The maximum payment amount per specified rate type.
paymentSchemePaymentScheme
The payment scheme that the job will use.
companyFeeStrictPercentage
The company fee (as a percentage).
workerFeeStrictPercentage
The worker fee (as a percentage).
associationAssociation
The project type of the job.
projectProject
The project the job associated to.
internalBudgetFloat
Internal budget of the project.
spentFloat!
Total job spent.

Only enterprise company owning the job could access the budget.
expectedExperienceLevel[ExpectedExperienceLevel!]!
The expected experience levels required for the job.
locationPreferenceLocationPreference
The location preference of the job.
startDateDate
The date that the job started.
startDateTimeframeJobStartTimeframe
The timeframe within the job is likely to start
endDateTimeframeJobEndTimeframe
The timeframe within the job is likely to end
endDateDate
The date that the job ended.
attachments[File!]!
The files attached to the job.
isExtensionAvailableBoolean
Whether the job can be extended.
evaluationPeriodEvaluationPeriod
The period of time required to reply to candidates.
languages[Language!]!
The languages required for the job.
industries[Industry!]!
The industries that the worker requires experience in for the job.
requiredWorkersInt
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 in this will only be visible to you and your team members, not to workers.
visibility[JobVisibility!]!
The audiences that will be able to see the job listing.
approvedBoolean!
Whether the job has been approved by Worksome.
availableBoolean!
Whether the job is available to receive offers.
pausedBoolean!
Whether the job is currently paused.
completedBoolean!
Whether the job is completed.
publishedBoolean!
Whether the job has been published.
removedBoolean!
Whether the job has been removed/discarded while being published and before having any hires.
removedCauseString
The cause for removal of the Job.
publishedAtDateTime
The date and time that the job was published.
companyCompany!
The company that the job is for.
regionString
The region for the job.
urlURL!
The URL for the job.
viewerCanDeleteBoolean!
Whether the viewer is able to delete the job.
viewerCanEditBoolean!
Whether the viewer is able to edit the job.
viewerCanShareBoolean!
Whether the viewer is able to share the job.
viewerCanCreateJobCandidateBoolean!
Whether the viewer is able to create a job candidate.
viewerCanCreateHireBoolean!
Whether the viewer is able to create a hire on the job.
createdAtDateTime!
The date and time that the job was created.
updatedAtDateTime!
The date and time that the job was updated.
isForContactsBoolean!
Whether the job is shared with contacts.
isForRecruitersBoolean!
Whether the job is shared with recruiters.
isForMarketplaceBoolean!
Whether the job is shared publicly on the marketplace.
externalIdentifierString
An identifier associated with the job from an external system.
hiresHirePaginator!
The hires made on the job.
conversationsConversationPaginator!
The conversations involving the job.
notesNotePaginator!
The notes added to the job.
billsPaymentRequestPaginator! Deprecated
The payment requests created on the job.
paymentRequestsPaymentRequestPaginator!
The payment requests created on the job.
bidsBidPaginator!
The bids submitted for the job.
sharesJobSharePaginator!
The contacts that this job was shared with.

JobCandidate

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

Fields
idID!
The ID of the approvals.
jobJob!
The job for which the worker is a candidate.
workerWorker!
The worker who is a candidate for the Job.
bidBid
The active bid made by the worker for the job.
hireHire
The hire created by the company for the job and worker pairing.
jobShareJobShare
The job share reference if the worker was invited to apply.
sourcingChannelSourcingChannel!
The sourcing channel that the worker came from as a job candidate.
ownerAccount
The owner of the submitted candidate. Only applies if the candidate was submitted.
stepJobCandidateHiringStep!
The step of the hiring process that the job candidate is in.
statusJobCandidateStatus!
The status of the job candidate.
statusReasonJobCandidateStatusReason
When not eligible anymore, indicates why the job candidate is not.
statusCommentString
Added comment regarding the reason for the job candidate not being eligible.
isPreferredBoolean!
Whether the candidate has been selected as preferred.
statusSetByUserUser!
The user that last changed the job candidate status.
stepSetByUserUser!
The user that last changed the job candidate step.
createdAtDateTime!
The date and time that the job candidate was created.
createdByUserUser!
The user that created the job candidate.
updatedAtDateTime
The date and time that the job candidate was last updated.
updatedByUserUser
The user that last updated the job candidate.
viewerCanUpdateStatusBoolean!
Whether the viewer can update the job candidate status.
viewerCanUpdatePreferredBoolean!
Whether the viewer can update the job candidate preferred.

JobCandidatePaginator

A paginated list of JobCandidate items.

Fields
paginatorInfoPaginatorInfo!
Pagination information about the list of items.
data[JobCandidate!]!
A list of JobCandidate items.

JobPaginator

A paginated list of Job items.

Fields
paginatorInfoPaginatorInfo!
Pagination information about the list of items.
data[Job!]!
A list of Job items.

JobShare

The contacts that the job was shared with.

Fields
idID!
The ID of the job share.
accountJobShareableAccount!
The account that the job share belongs to.
isActiveBoolean!
Whether the job share is active.
jobJob!
The job that the job share is related to.

JobSharePaginator

A paginated list of JobShare items.

Fields
paginatorInfoPaginatorInfo!
Pagination information about the list of items.
data[JobShare!]!
A list of JobShare items.

Language

A language that is required for a job.

Fields
nameLanguageName!
The name of the language.
experienceFluency!
The required level of the language.

Link

A link on a profile.

Fields
titleString!
The title of the link.
urlURL!
The URL of the link.

Market

A market.

Fields
codeMarketCode!
The market code.
nameString!
The name of the market.

Message

A message as part of a conversation.

Fields
idID!
The ID of the message.
bodyString
The body of the message.
authorUser
The author of the message.
urlURL!
The URL for the profile.

MessagePaginator

A paginated list of Message items.

Fields
paginatorInfoPaginatorInfo!
Pagination information about the list of items.
data[Message!]!
A list of Message items.

MultiFactorPaginator

A paginated list of MultiFactor items.

Fields
paginatorInfoPaginatorInfo!
Pagination information about the list of items.
data[MultiFactor!]!
A list of MultiFactor items.

Note

A note for an entity.

Fields
idID!
The ID of the note.
titleString!
The title of the note.
bodyString!
The body of the note.
authorUser!
The author of the note.
notableNotable!
The entity that the note belongs to.
accountAccount!
The account that the note belongs to.
createdAtDateTime!
The date and time that the note was created.
updatedAtDateTime!
The date and time that the note was updated.
viewerCanUpdateBoolean!
Whether the viewer is able to update the note.
viewerCanDeleteBoolean!
Whether the viewer is able to delete the note.

NotePaginator

A paginated list of Note items.

Fields
paginatorInfoPaginatorInfo!
Pagination information about the list of items.
data[Note!]!
A list of Note items.

Organisation

An organisation.

Fields
idID!
The ID of the organisation.
nameString!
The name of the organisation.
marketMarketCode!
The market that the organisation is in.
avatarURL
The avatar (or profile picture) for the organisation.
divisionsCompanyPaginator!
The divisions that an organisation contains.

OrganisationPaginator

A paginated list of Organisation items.

Fields
paginatorInfoPaginatorInfo!
Pagination information about the list of items.
data[Organisation!]!
A list of Organisation items.

Overtime

An overtime.

Fields
idID!
The ID of the overtime.
typeOvertimeType!
The type of the overtime.
durationFloat!
The duration of the overtime.
rateFloat!
The rate of the overtime.
rateMultiplierFloat!
The rate multiplier for the overtime.
totalInt!
The total of the overtime.
workerWorker
The worker that the overtime is for.
paymentRequestPaymentRequest
The payment request on which the overtime is charged.
timesheetTimesheet!
The timesheet which prompted the creation of overtime.
contributingPaymentRequestNumbers[ID!]!
The payment request numbers which contain contributing timesheets.
createdAtDateTime!
The date and time that the overtime was created.
updatedAtDateTime!
The date and time that the overtime was updated.

OvertimePaginator

A paginated list of Overtime items.

Fields
paginatorInfoPaginatorInfo!
Pagination information about the list of items.
data[Overtime!]!
A list of Overtime items.

PaginatorInfo

Information about pagination using a fully featured paginator.

Fields
countInt!
Number of items in the current page.
currentPageInt!
Index of the current page.
firstItemInt
Index of the first item in the current page.
hasMorePagesBoolean!
Are there more pages after this one?
lastItemInt
Index of the last item in the current page.
lastPageInt!
Index of the last available page.
perPageInt!
Number of items per page.
totalInt!
Number of total available items.

Participant

A participant in a conversation.

Fields
idID!
The ID of the participant.
conversationConversation!
The conversation that the participant is a part of.
accountAccount!
The account of the participant.

ParticipantPaginator

A paginated list of Participant items.

Fields
paginatorInfoPaginatorInfo!
Pagination information about the list of items.
data[Participant!]!
A list of Participant items.

PaymentRequest

A payment request.

Fields
idID!
The ID of the payment request.
workerWorker!
The worker attached to the payment request.
recruiterRecruiter
The Recruiter, if any, attached to the payment request.
companyCompany!
The Company attached to the payment request.
numberString!
The unique reference for the payment request.
purchaseOrderNumberString
The purchase order number assigned to the payment request.
startDateDate
The date that the billing period started.
endDateDate
The date that the billing period ended.
currencyCurrency!
The currency used for this payment request.
rateFloat
The charged rate for this payment request.
rateTypeRateType
The rate type required for this payment request.
rateTypeNameString!
The human friendly rate type required for this payment request.
ratetypeNameSlashString
The abbreviated human friendly rate type required for this payment request.
rateQuantityFloat!
The quantity of the selected rate type for the payment request.

The rate type can be seen by looking at Bill.rateType and the rate can be seen by looking at Bill.rate.
serviceAmountFloat!
The fee for using the Worksome Platform. This will change depending on who is viewing the api.
expensesAmountFloat!
The total amount of expenses reported on the payment request.
netAmountFloat!
The total amount excluding taxes.
grossAmountFloat!
The total amount including taxes.
recruiterFeeAmountFloat!
The agreed fee on the payment request between the company and recruiter.

Only the company and recruiter can see this.
employmentCostAmountFloat!
The employment cost. The fee for payrolling a Worker.

Only the Company can see this.
billedAmountFloat!
The total amount excluding fees and expenses.
dateDate!
The date that the payment request was created.
manuallyApprovedAtDate
The date that the bill was manually approved.
approvedByUser
The user that approved the payment request.
autoApprovedAtDate
The date that the bill was automatically approved (if applicable).
rejectedAtDate
The date that the bill was rejected (if applicable).
prepaidAtDate
The date that the bill was prepaid (if applicable).
issuedAtDate
The date that the bill was issued (if applicable).
hireHire
The hire attached to the payment request.
jobJob!
The job attached to the payment request.
messageMessage
The message attached to the payment request.
commentsString
The comments relevant to the payment request.
timesheetTimesheet
The timesheet attached to the payment request.
filesFilePaginator!
The files attached to the payment request.

There could potentially be a timesheet stored as a separate file.
expenseReportsExpenseReportPaginator!
The expense reports for the payment request.
overtimesOvertimePaginator!
The overtimes for the payment request.

PaymentRequestPaginator

A paginated list of PaymentRequest items.

Fields
paginatorInfoPaginatorInfo!
Pagination information about the list of items.
data[PaymentRequest!]!
A list of PaymentRequest items.

Profile

A profile.

Fields
idID!
The ID of the profile.
urlURL!
The URL for the profile.
links[Link!]!
The links for the profile

Project

A project with a budget containing one or more jobs.

Fields
idID!
The ID of the project.
nameString!
The name of the project.
descriptionString
The description of the project.
currencyCurrency!
The currency used for this project.
creatorUser!
The creator of the project.
companyCompany!
The company that the project is for.
internalBudgetDecimal
The total internal budget for the project.
allocatedBudgetDecimal!
The sum of all associated job budgets that have been allocated to the internal budget of the project.
spentDecimal!
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.
endDateDate
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.
externalIdentifierString
An identifier associated with the project from an external system.
jobsJobPaginator!
Jobs added to this project.

ProjectPaginator

A paginated list of Project items.

Fields
paginatorInfoPaginatorInfo!
Pagination information about the list of items.
data[Project!]!
A list of Project items.

Recruiter

A recruiter.

Fields
idID!
The ID of the recruiter.
nameString!
The name of the recruiter.
marketMarket!
The market that the recruiter is in.
initialsString!
The initials of the recruiter
avatarURL
The avatar (or profile picture) for the recruiter.

RecruiterCandidate

A recruiter candidate relationship.

Fields
idID!
The ID of the recruiter candidate.
recruiterRecruiter!
The recruiter of the relationship.
workerWorker!
The candidate in the relationship.
emailString
The email of the candidate.
statusContactStatusEnum!
The status of the candidate relationship.
tokenString
The token used to invite the candidate.
rateFloat
The rate of the candidate.
jobTitleString
The candidate job title
links[String!]!
The links attached to the relationship.
tags[Tag!]!
The tags applied to the relationship.
filesFilePaginator!
The files attached to the relationship.

RecruiterCandidatePaginator

A paginated list of RecruiterCandidate items.

Fields
paginatorInfoPaginatorInfo!
Pagination information about the list of items.
data[RecruiterCandidate!]!
A list of RecruiterCandidate items.

RecruiterPaginator

A paginated list of Recruiter items.

Fields
paginatorInfoPaginatorInfo!
Pagination information about the list of items.
data[Recruiter!]!
A list of Recruiter items.

Skill

A skill that is required for a job.

Fields
idID!
The ID of the skill.
nameString!
The name of the skill.

SkillPaginator

A paginated list of Skill items.

Fields
paginatorInfoPaginatorInfo!
Pagination information about the list of items.
data[Skill!]!
A list of Skill items.

SmsCreateMultiFactorPayload

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

Fields
multiFactorSmsMultiFactor!
The newly-created SMS multi factor.

SmsMultiFactor

An SMS multi-factor authentication implementation.

Fields
idID!
The ID of the SMS multi-factor authentication implementation.
nameString!
The name of the SMS multi-factor authentication implementation.
phoneNumberE164PhoneNumber!
The phone number for the SMS multi-factor authentication implementation.
statusStatus!
The status of the SMS multi-factor authentication implementation.
ownerUser!
The owner of the SMS multi-factor authentication implementation.
verifiedAtDateTime
When the SMS multi-factor authentication implementation was verified.
createdAtDateTime!
When the SMS multi-factor authentication implementation was created.
updatedAtDateTime!
When the SMS multi-factor authentication implementation was updated.

Tag

A tag.

Fields
idID!
The ID of the tag.
nameString
The name of the tag.

TagPaginator

A paginated list of Tag items.

Fields
paginatorInfoPaginatorInfo!
Pagination information about the list of items.
data[Tag!]!
A list of Tag items.

TemporaryFileUploadResponse

The details for a temporary file upload.

Fields
idID!
The ID of the temporary file.
nameString!
The name of the file to be uploaded.
urlURL!
The temporary URL to upload the file to.

The temporary URL will expire after 1 week.

Timesheet

A timesheet.

Fields
idID!
The ID of the timesheet.
workerWorker
The worker that the timesheet belongs to.
hireHire
The hire that the timesheet belongs to.
sourceTimesheetSource!
The source of timesheet.
startDateDate
The start date of timesheet.
endDateDate
The end date of timesheet.
createdAtDateTime!
The date and time that the timesheet was created.
paymentRequestsPaymentRequestPaginator!
The payment requests created on the timesheet.
registrationsTimesheetRegistrationPaginator!
The timesheet registrations.
overtimesOvertimePaginator!
The overtimes that the timesheet belongs to.

TimesheetPaginator

A paginated list of Timesheet items.

Fields
paginatorInfoPaginatorInfo!
Pagination information about the list of items.
data[Timesheet!]!
A list of Timesheet items.

TimesheetRegistration

A registration for a timesheet.

Fields
idID!
The ID of the timesheet registration.
typeTimesheetRegistrationType!
The type of the timesheet registration.
dateDate!
The date of the timesheet registration.
startTimeTime
The start time of the timesheet registration.
endTimeTime
The end time of the timesheet registration.
durationFloat!
The duration of the timesheet registration.
unitTimesheetRegistrationDurationUnit!
The unit of measurement for the timesheet registration.
commentsString
The comments for the timesheet registration.
invoiceReferenceNumberString
The invoice reference number associated with the timesheet registration.
externalIdentifierString
An identifier associated with the timesheet registration from an external system.
isBillableBoolean
Whether the timesheet registration is billable.

TimesheetRegistrationPaginator

A paginated list of TimesheetRegistration items.

Fields
paginatorInfoPaginatorInfo!
Pagination information about the list of items.
data[TimesheetRegistration!]!
A list of TimesheetRegistration items.

Token

Contains information about an authentication token.

Fields
jtiString!
The access token JTI (JWT ID).

TotpCreateMultiFactorPayload

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

Fields
multiFactorTotpMultiFactor!
The newly-created TOTP multi factor.
secretString!
The secret for the newly-created TOTP multi factor.
qrCodeURL!
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.

TotpMultiFactor

A TOTP multi-factor authentication implementation.

Fields
idID!
The ID of the TOTP multi-factor authentication implementation.
nameString!
The name of the TOTP multi-factor authentication implementation.
statusStatus!
The status of the TOTP multi-factor authentication implementation.
ownerUser!
The owner of the TOTP multi-factor authentication implementation.
verifiedAtDateTime
When the TOTP multi-factor authentication implementation was verified.
createdAtDateTime!
When the TOTP multi-factor authentication implementation was created.
updatedAtDateTime!
When the TOTP multi-factor authentication implementation was updated.

TrustedContact

A trusted contact.

Fields
idID!
The ID of the trusted contact.
workerWorker!
The trusted contact worker.
companyCompany!
The trusted contact company.
invitedByUserUser
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.
viewerCanApproveBoolean!
Whether the viewer is able to approve the trusted contact.
viewerCanUpdateBoolean!
Whether the viewer is able to update the trusted contact.
viewerCanDeleteBoolean!
Whether the viewer is able to delete 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.
statusContactStatusEnum!
Status of the trusted contact.
statusUpdatedAtDate!
The date that the status of the trusted contact was last updated.
invitedAtDate!
The date that the trusted contact was invited.
externalIdentifierString
An identifier associated with the trusted contact from an external system.
customFieldValues[CustomFieldValue!]!
The custom fields values for the trusted contact.

These are not ready for production yet and are behind the TrustedContactCustomFields feature flag.
tagsTagPaginator! Deprecated
The tags for a trusted contact.
notesNotePaginator!
Notes added to the trusted contact.

TrustedContactPaginator

A paginated list of TrustedContact items.

Fields
paginatorInfoPaginatorInfo!
Pagination information about the list of items.
data[TrustedContact!]!
A list of TrustedContact items.

User

Account of a person who utilizes this application.

Fields
idID!
Unique primary key.
nameString!
Non-unique name.
emailString!
Unique email address.
emailVerifiedAtDateTime
When the email was verified.
createdAtDateTime!
When the account was created.
updatedAtDateTime!
When the account was last updated.
canCreatePasswordBoolean!
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.
missingAuthenticationBoolean!
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.
hasVerifiedEmailBoolean!
Checks whether the user has verified their email or not.
avatarURL
The avatar (or profile picture) for the user.

UserGroup

A user group.

Fields
idID!
The ID of the group.
nameString!
The name of the group.
descriptionString
The description of the group.
companyCompany!
The company that the group is for.
statusUserGroupStatus!
The status of the user group.
usersUserPaginator!
The users of the group.

UserGroupPaginator

A paginated list of UserGroup items.

Fields
paginatorInfoPaginatorInfo!
Pagination information about the list of items.
data[UserGroup!]!
A list of UserGroup items.

UserPaginator

A paginated list of User items.

Fields
paginatorInfoPaginatorInfo!
Pagination information about the list of items.
data[User!]!
A list of User items.

Vendor

A vendor.

Fields
idID!
The ID of the vendor.
nameString!
The name of the vendor.
marketMarketCode!
The market that the vendor is in.
avatarURL
The avatar (or profile picture) for the vendor.

Webhook

The webhook definition.

Fields
idID!
The ID of the webhook.
titleString!
The title of the webhook.
descriptionString
The description of the webhook.
urlString!
The URL of the webhook.
secretString
The secret of the webhook.
isActiveBoolean
Whether the webhook is active or not.
clientIdString
The client ID of the webhook, when using OAuth.
clientSecretString
The client secret of the webhook, when using OAuth.
clientUrlString
The client URL of the webhook, when using OAuth.
createdAtDateTime!
The date and time that the webhook was created.
updatedAtDateTime!
The date and time that the webhook was updated.

WebhookPaginator

A paginated list of Webhook items.

Fields
paginatorInfoPaginatorInfo!
Pagination information about the list of items.
data[Webhook!]!
A list of Webhook items.

Worker

A worker.

Fields
idID!
The ID of the worker.
nameString!
The name of the worker.
firstNameString!
The first name of the worker.
lastNameString!
The last name of the worker.
middleNameString
The middle name of the worker.
emailString
The email of the worker.
phoneString
The phone of the worker.
avatarURL
The avatar (or profile picture) for the worker.
addressAddress
The address that the worker is registered to.
marketMarket!
The market that the worker is in.
skills[Skill!]!
The skills that the worker has.
profileProfile
The profile that the worker has.
jobTitleString
The job title that the worker has.
initialsString!
The initials for the worker name.
currencyString!
The currency that the worker uses.
dayRateFloat
The daily rate for the worker.
rtwVerifiedAtDateTime
Right to work verification and background checks have been made for this worker at this date.
rtwExpiresAtDateTime
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!]!
The hires associated with the worker that has an attribution.
primaryBusinessEntityBusinessEntity
The business entity that the worker uses.
totalPaidFloat!
The total amount received/paid by the given company.
viewerIsClientBoolean
Whether the worker is a trusted contact for the current viewer.

Only companies can see this.
viewerCanContactBoolean!
Whether the viewer is able to contact the trusted contact.
viewerCanOfferJobBoolean!
Whether the viewer is able to offer jobs to the trusted contact
businessEntitiesBusinessEntityPaginator!
The business entities that the worker has.
hiresHirePaginator!
The hires associated with the worker.

Workflow

The workflow definition.

Fields
idID!
The ID of the workflow.
nodes[Nodeable!]!
The nodes that are attached to this workflow.

WorkflowPaginator

A paginated list of Workflow items.

Fields
paginatorInfoPaginatorInfo!
Pagination information about the list of items.
data[Workflow!]!
A list of Workflow items.

WorkflowVariableOption

The workflow variable option.

Fields
displayOrderInt!
The display order of the option.
valueString!
The value of the option.

WorkflowVariableOptionType

The workflow variable for a variable of type option.

Fields
idID!
The ID of the workflow variable.
titleString!
The title of the variable.
descriptionString
The description of the variable.
operators[WorkflowVariableOperator!]!
Operators that can be used with this variable.
options[WorkflowVariableOption!]!
The options that can be used with this variable.

WorkflowVariablePaginator

A paginated list of WorkflowVariable items.

Fields
paginatorInfoPaginatorInfo!
Pagination information about the list of items.
data[WorkflowVariable!]!
A list of WorkflowVariable items.

WorkflowVariableRule

The workflow variable rule definition.

Fields
idID!
The ID of the rule.
fieldIdString!
The ID of the field which is either a string or id of CustomField model.
approvalRuleApprovalRule!
The rule that the variable is connected to.
variableWorkflowVariable!
The variable that the rule is connected to.
operatorWorkflowVariableOperator!
The operator that the rule is connected to.
valueString!
The value the rule would be compared to.
createdAtDate!
The date that the rule was created.
updatedAtDate!
The date that the rule was updated.

WorkflowVariableStringType

The workflow variable for a variable of type string.

Fields
idID!
The ID of the workflow variable.
titleString!
The title of the variable.
descriptionString
The description of the variable.
operators[WorkflowVariableOperator!]!
Operators that can be used with this variable.