Queries

Queries are a type that defines what data you are able to request from the GraphQL API.

accounts

Type: [Account!]!

Get a list of accounts which the current authentication has access to.

approval

Type: Approval

Get a specific approval flow by ID.

Requires the manage-approvals team permission on the owning company.

Arguments
idID!
The ID of the approval flow.

approvalApprovable

Type: ApprovalApprovable

Get a specific approval request by ID.

Arguments
idID!
The ID of the approval request.

approvalApprovables

Type: ApprovalApprovablePaginator!

List approval requests — the runtime instances created when a trigger fires.

Use filters to find requests that need action, belong to specific approvals, or relate to specific items (e.g. a particular hire).

Arguments
accounts[ID!]
Filter by the accounts that own the parent approval flows.
requiresActionBoolean
When true, only return approval requests that still need action from any approver.
requiresActionUsers[ID!]
Only return approval requests that need action from specific users.
approvals[ID!]
Filter by the parent approval flows.
approvableID
Filter by the item being approved (e.g. a specific hire).
approvalRules[ID!]
Filter by specific approval rules.
orderBy[ApprovalApprovablesOrderByClauseInput!]
Order the results by the given field and direction.
firstInt!
Limits number of fetched items.
pageInt
The offset from which items are returned.

approvalRule

Type: ApprovalRule

Get a specific approval rule by ID.

Arguments
idID!
The ID of the approval rule.

approvalRules

Type: ApprovalRulePaginator!

List all approval rules accessible to the authenticated user.

Arguments
accounts[ID!]
Filter rules by the accounts that own their parent approval flows.
firstInt!
Limits number of fetched items.
pageInt
The offset from which items are returned.

approvalStates

Type: ApprovalStatePaginator!

List all approval actions (approvals, rejections, change requests) across approval requests.

Use this to build an audit trail of all approval activity for a company.

Arguments
accounts[ID!]
Filter by the accounts that own the parent approval flows.
status[ApprovalApprovableState!]
Filter by the type of action taken (e.g. only show rejections).
users[ID!]
Filter by the users who took the action.
firstInt!
Limits number of fetched items.
pageInt
The offset from which items are returned.

approvals

Type: ApprovalPaginator!

List all approval flows accessible to the authenticated user.

Requires the manage-approvals team permission.

Arguments
accounts[ID!]
Filter approvals by the accounts that own them.
searchString
Search approvals by name or description.
firstInt!
Limits number of fetched items.
pageInt
The offset from which items are returned.

approver

Type: Approver

Get a specific approver assignment by ID.

Arguments
idID!
The ID of the approver.

approvers

Type: ApproverPaginator!

List approver assignments, optionally filtered by approval rule.

Arguments
accounts[ID!]
Filter by the accounts that own the parent approval flows.
approvalRuleID
Filter to only show approvers assigned to a specific rule.
firstInt!
Limits number of fetched items.
pageInt
The offset from which items are returned.

batch

Type: Batch

Get a specific batch.

Arguments
idID!
The ID of the batch.

batches

Type: BatchPaginator!

Get a list of batches.

Arguments
accounts[ID!]
Only show batches for the specified accounts.
types[BatchType!]
Only show batches of the specified types.
containsItemsWithStatus[BatchItemStatus!]
Only show batches that contain at least one item of the specified statuses.
firstInt!
Limits number of fetched items.
pageInt
The offset from which items are returned.

bid

Type: Bid

Get a specific bid which the user has access to.

Arguments
idID!
The ID of the bid.

bids

Type: BidPaginator!

Get a list of all bids which the viewer has access to.

Arguments
statuses[BidStatus!]
Filter the bids based on one or more statuses.
jobID
Filter the bids based on a job.
accounts[ID!]
Filter the bid based on one or more accounts.
firstInt!
Limits number of fetched items.
pageInt
The offset from which items are returned.

classification

Type: Classification

Get a specific classification by ID.

Arguments
idID!
The ID of the classification to retrieve

classifications

Type: ClassificationPaginator!

Get all classifications for a specific hire.

Arguments
hireID!
The ID of the hire to get classifications for
firstInt!
Limits number of fetched items.
pageInt
The offset from which items are returned.

companies

Type: CompanyPaginator!

Get a list of companies that the authenticated user has access to.

Arguments
externalIdentifiers[String!]
Only show companies with the specified external identifier.
firstInt!
Limits number of fetched items.
pageInt
The offset from which items are returned.

company

Type: Company

Get a specific company.

Arguments
idID!
The ID of the company.

companyRecruiter

Type: CompanyRecruiter

Get a specific company recruiter.

Arguments
idID!
The ID of the company recruiter.

companyRecruiters

Type: CompanyRecruiterPaginator!

Get a list of company recruiters.

Arguments
accounts[ID!]
Supply which accounts to see recruiters for.

If no accounts are supplied then all authenticated accounts will be used.
searchString
Supply an input string which will be used to search through.
statuses[RecruiterStatus!]
Supply a list of statuses to filter recruiters by.
tags[String!]
Supply a list of tags to filter recruiters by.
markets[String!]
Supply a list of markets to filter recruiters by.
orderBy[RecruiterOrderByClauseInput!]
Supply a list of column/order pairs for sorting, ordering will be applied in the provided order.
externalIdentifiers[String!]
Only show company recruiters with the specified external identifier.
customFields[CustomFieldTypeValueInput!]
Filter by custom fields attached to the company recruiters.
firstInt!
Limits number of fetched items.
pageInt
The offset from which items are returned.

compliance

Type: [Compliance!]!

Get compliance requirements for a specific hire.

Returns all compliance requirements that apply to the given hire, or only the specified compliances if the names argument is provided.

Arguments
idID!
The ID of the hire to get compliance requirements for
names[ComplianceName!]
Optional compliance names to filter for specific compliances

contract

Type: Contract

Get a specific contract.

Arguments
idID!
The ID of the contract.

contracts

Type: ContractPaginator!

Get a list of contracts.

Arguments
accounts[ID!]
Only show contracts created by a specific account.
currencies[Currency!]
Only show contracts using the specified currencies.
statuses[ContractStatus!]
Only show contracts with the specified statuses.
locationPreferences[LocationPreference!]
Only show contracts with the specified location preferences.
firstInt!
Limits number of fetched items.
pageInt
The offset from which items are returned.

conversation

Type: Conversation

Get a specific conversation.

Arguments
idID!
The ID of the conversation.

conversations

Type: ConversationPaginator!

Get a list of conversations.

Arguments
accounts[ID!]
Supply which accounts to see conversations for.

If no accounts are supplied then all authenticated accounts will be used. If multiple accounts are used only conversations for those accounts will be shown.
isOpenBoolean
If the conversation is open or closed. If not supplied show all conversations.
firstInt!
Limits number of fetched items.
pageInt
The offset from which items are returned.

customField

Type: CustomField

Get a specific custom field.

Arguments
idID!
The custom field ID.

customFields

Type: CustomFieldPaginator!

Get a list of custom fields.

Arguments
accounts[ID!]
Supply which accounts to see fields for.

If no accounts are supplied, then all authenticated accounts will be used.
approvalBoolean
Supply to select fields with approval workflow enabled or disabled.
appliesTo[TypeSupportingCustomFieldValues!]
A list of entity types supporting custom fields.
firstInt!
Limits number of fetched items.
pageInt
The offset from which items are returned.

employment

Type: Employment

Get a specific employment.

Arguments
idID!
The ID of the employment.

employments

Type: EmploymentPaginator!

Get a list of employments.

Arguments
accounts[ID!]
Only show employments related to a specific account.
status[EmploymentStatus!]
Filter employments by employment status.
employerRecordStatus[EmployerRecordStatus!]
Filter employments by employer record status.
searchString
Filter by search term against worker name, job title, etc.
orderBy[EmploymentsOrderByClauseInput!]
Order by clause.
startDateRangeDateRangeInput
Filter by start date range.
endDateRangeDateRangeInput
Filter by end date range.
contractType[ContractType!]
Filter by contract types.
locations[String!]
Filter by locations.
companies[ID!]
Filter by companies.
hiringManagers[ID!]
Filter by hiring managers.
rateTypes[RateType!]
Filter by rate type.
previouslyHiredBoolean
Filter by previously hired status.
firstInt!
Limits number of fetched items.
pageInt
The offset from which items are returned.

file

Type: File

Get a specific file.

Arguments
idID!
The ID of the file.

files

Type: FilePaginator!

Get a list of files.

Arguments
accounts[ID!]
Only show files for the specified accounts.

If no accounts supplied then all authenticated accounts will be used.
mimeTypes[String!]
Only show files with the given IANA MIME types.
firstInt!
Limits number of fetched items.
pageInt
The offset from which items are returned.

gate

Type: Gate

Get a specific gate for a hire.

Returns the gate containing compliance requirements grouped by a specific compliance name.

Arguments
idID!
The ID of the hire to get the gate for
gateComplianceName!
The name of the compliance gate to retrieve

hire

Type: Hire

Get a specific hire.

All parties of the hire can use this field for seeing their hire.

Arguments
idID!
The ID of the hire.

hires

Type: HirePaginator!

Get a list of hires.

All parties of the hire can use this field for seeing their hires.

Arguments
accounts[ID!]
Filter the hires based on one or more accounts.
searchString
Search hires.
status[HireActiveStatus!]
Filter hires by hire status.
orderBy[HiresOrderByClauseInput!]
Order the results by the hire id, company name, job name, or worker name.
recruiterOwnershipIsExpiredBoolean
Filter hires by if recruiter ownership is active.
companies[ID!]
Filter hires by company ids.
workers[ID!]
Filter hires by worker ids.
startDateRangeDateRangeInput
Filter hires by hire start date.
endDateRangeDateRangeInput
Filter hires by hire end date.
startsAfterDate
Filter hires that start after the specified date.
endsAfterDate
Filter hires that end after the specified date.
createdAtDateRangeDateRangeInput
Filter hires by hire by the date the hire was created.
externalIdentifiers[String!]
Only show hires with the specified external identifier.
contractStatus[ContractStatus!]
Filter hires by hire contract status.
contractType[ContractType!]
Filter hires by hire contract type.
engagementType[EngagementType!]
Filter hires by engagement type.
engagementTypeSetup[EngagementTypeSetup!]
Filter hires by engagement type setup.
usesClassification[ClassificationUsage!]
Filter hires by classification usage status.
activeStatus[HireActiveStatus!]
Filter hires by active status.
includeDeletedBoolean Deprecated
Include soft deleted hires.
jobOwners[ID!] Deprecated
Filter hires by job owner.
owners[ID!]
Filter hires by owner.
hasPaymentRequestsBoolean
Filter hires by if there are associated payment requests.
hasRecruiterAttributionBoolean
Filter hires by if there are recruiter attribution or not.
jobs[ID!]
Only show hires that belong to one or more specific jobs.
firstInt!
Limits number of fetched items.
pageInt
The offset from which items are returned.

incomingJobs

Type: JobPaginator!

Jobs shared with a linked account that do not yet have a derived version.

Arguments
searchString
Search job posts by title or description.
orderBy[JobsOrderByClauseInput!]
Order the results.
firstInt!
Limits number of fetched items.
pageInt
The offset from which items are returned.

industries

Type: IndustryPaginator!

Get a list of industries.

Arguments
firstInt!
Limits number of fetched items.
pageInt
The offset from which items are returned.

industry

Type: Industry

Get a specific industry.

Arguments
idID!
The ID of the industry.

inheritedCustomFields

Type: CustomFieldPaginator!

Get a list of inherited custom fields.

Arguments
accounts[ID!]
Supply which accounts to see fields for.

If no accounts are supplied, then all authenticated accounts will be used.
approvalBoolean
Supply to select fields with approval workflow enabled or disabled.
appliesTo[TypeSupportingCustomFieldValues!]
A list of entity types supporting custom fields.
firstInt!
Limits number of fetched items.
pageInt
The offset from which items are returned.

invoice

Type: Invoice

Get a specific invoice.

Arguments
numberString!
The invoice number on the PDF.

invoiceRow

Type: InvoiceRow

Get a specific invoice row.

Arguments
idID!
The ID of the invoice row.

invoices

Type: InvoicePaginator!

Get a list of invoices.

Arguments
accounts[ID!]
Only show invoices for the specified accounts.

If no accounts are supplied then all authenticated accounts will be used.
status[InvoiceStatus!]
Only show invoices which have the supplied status.
transactionTypes[InvoiceTransactionType!]
Only show invoices with the given transaction types.
searchString
Filter invoices by PO number, invoice number, worker name, or amount.
hasPurchaseOrderNumberBoolean
Limit to invoices that either have or do not have payment requests with Purchase Order numbers.
currency[Currency!]
Filter invoices by currency.
externalIdentifiers[String!]
Only show invoices with the specified external identifiers.
orderBy[QueryInvoicesOrderByOrderByClause!]
Order the results by the invoice date, number, total or due date.
firstInt!
Limits number of fetched items.
pageInt
The offset from which items are returned.

job

Type: Job

Get a specific job.

Arguments
idID!
The ID of the job.

jobCandidate

Type: JobCandidate

Get a specific job candidate.

Arguments
idID!
The ID of the job candidate.

jobCandidates

Type: JobCandidatePaginator!

Get a list of job candidates.

Arguments
jobs[ID!]
Only return job candidates for the specified jobs.
statuses[JobCandidateStatus!]
Only return job candidates for the specified statuses.
steps[JobCandidateHiringStep!]
Only return job candidates for the specified hiring steps.
preferredBoolean
Only return job candidates which are preferred or not.
orderBy[JobCandidateOrderByClauseInput!]
Supply a list of column/order pairs for sorting, ordering will be applied in the provided order.
firstInt!
Limits number of fetched items.
pageInt
The offset from which items are returned.

jobShares

Type: JobSharePaginator!

Get a list of job shares.

Arguments
jobs[ID!]
Only show job shares for specific jobs.
accountTypes[AccountType!]
Only show job shares for specific accounts.
isActiveBoolean
Whether the job share is active.
orderBy[JobShareOrderByClauseInput!]
Order the job shares by the specified field and direction.
firstInt!
Limits number of fetched items.
pageInt
The offset from which items are returned.

jobs

Type: JobPaginator!

Get a list of jobs.

Arguments
accounts[ID!]
Only show jobs created by a specific account.
owners[ID!]
Only show jobs owned by specific users.
markets[MarketCode!]
Only show jobs in the specified markets.
searchString
Search job posts.
currencies[Currency!]
Only show jobs using the specified currencies.
rateTypes[RateType!]
Only show jobs using the specified payment rate types.
paymentSchemes[PaymentScheme!] Deprecated
Only show jobs using the specified payment schemes.
skills[String!]
Only show jobs requiring a set of specific skills. This filter takes a list of skill names, ie “php” for the skill php, or “Graphql api” for the graphql api skill.
experienceLevel[ExpectedExperienceLevel!]
Only show jobs requiring specific experience levels.
associations[Association!]
Only show jobs using the specified project types.
locationPreferences[LocationPreference!]
Only show jobs using the specified location preferences.
availableBoolean
Only show jobs that are either available or not.
publishedBoolean
Only show jobs that are either published or not.
completedBoolean
Only show jobs that have either been completed or not.
removedBoolean
Only show jobs that have either been removed or not.
hasProjectBoolean
Filter for jobs with or without project.
hasHireBoolean
Filter for jobs with or without hires.
hasBidsBoolean
Filter for jobs with or without bids.
externalIdentifiers[String!]
Only show jobs with the specified external identifier.
orderBy[JobsOrderByClauseInput!]
Order the results by the hire id, company name, job name, or worker name.
createdAtDateRangeDateRangeInput
Filter jobs by the date the job was created.
unfilledBoolean
Filter by unfilled jobs.
customFields[CustomFieldTypeValueInput!]
Only show jobs with specific custom field values.
startDateRangeDateRangeInput
Only show jobs with start dates within the specified range.
endDateRangeDateRangeInput
Only show jobs with end dates within the specified range.
isJobPostBoolean
Only show jobs that are job posts.
statuses[JobStatus!]
Filter the jobs by their status
firstInt!
Limits number of fetched items.
pageInt
The offset from which items are returned.

milestone

Type: Milestone

Get a single milestone.

Arguments
idID!
The ID of the milestone.

milestones

Type: MilestonePaginator!

Get a list of milestones.

Arguments
accounts[ID!]
Only show milestones for the specified accounts.

If no accounts are supplied then all authenticated accounts will be used.
hires[ID!]
Only show milestones for the specified hires.
firstInt!
Limits number of fetched items.
pageInt
The offset from which items are returned.

multiFactor

Type: MultiFactor

Retrieve a specific multi-factor authentication implementation.

Arguments
idID!
The id for the multi-factor authentication implementation.

multiFactors

Type: MultiFactorPaginator!

Retrieve all multi-factor authentication implementation.

Arguments
statuses[MultiFactorStatus!]
A list of statuses to filter the multi factors on.
channels[MultiFactorChannel!]
A list of channels to filter the multi factors on.
firstInt!
Limits number of fetched items.
pageInt
The offset from which items are returned.

organisation

Type: Organisation

Get a specific organisation.

Arguments
idID!
The ID of the organisation.

organisationTrustedContact

Type: TrustedContact

Get a specific organisation trusted contact.

Arguments
idID!
The ID of the trusted contact.

organisationTrustedContacts

Type: TrustedContactPaginator!

Get a list of organisation trusted contacts.

Arguments
accounts[ID!]
Supply which accounts to see trusted contacts for.

If no accounts are supplied then all authenticated accounts will be used.
workers[ID!]
Supply which workers to see trusted contacts for.
searchString
Supply an input string which will be used to search through.
skills[ID!]
Supply a list of skills IDs to filter trusted contact or associated worker having those.
markets[MarketCode!]
Supply a list of markets codes to filter workers part of related markets.
countries[String!]
Supply a list of country codes to filter workers part of related countries.
states[String!]
Supply a list of states to filter workers in specific states.
invitedByUsersInvitedByInput
Supply a list of user IDs to filter workers by the user who has invited them as trusted contact for the company.
statuses[ContactStatus!]
Supply a list of statuses to filter workers by.
originTrustedContactOrigin
Filter the contacts by their origin. Have they been added or invited
staffingAgencyStatusTrustedContactStaffingAgencyStatus
Filter contacts by whether they have staffing agency ownership or not.
managedStatusTrustedContactManagedStatus
Filter contacts by their managed status (worker, staffing agency, or unmanaged).
hireHistoryHireHistoryFilterInput
Filter contacts by whether they have been previously hired or not.
hireStatusHireStatusFilterInput
Filter contacts by whether they are currently hired or not.
businessSetup[BusinessEntityType!]
Supply a list of business entities to filter workers by.
externalIdentifiers[String!]
Only show trusted contacts with the specified external identifier.
customFields[CustomFieldTypeValueInput!]
Filter by custom fields attached to the TC’s. Freetext CF’s work by fuzzy search in the text. Single select works as inclusive or filters. That is you can chain multiple single select filters in the array to filter by many different CF selected options. This can similarly be done with freetext CF’s.
orderBy[TrustedContactOrderByClauseInput!]
Supply a list of column/order pairs for sorting, ordering will be applied in the provided order.
firstInt!
Limits number of fetched items.
pageInt
The offset from which items are returned.

partner

Type: Partner

Get a specific partner.

Arguments
idID!
The ID of the partner.

paymentRequest

Type: PaymentRequest

Get a specific payment request.

Arguments
idID!
The ID of the payment request.

paymentRequests

Type: PaymentRequestPaginator!

Get a list of payment requests.

Arguments
accounts[ID!]
Only show payment requests for the specified accounts.
currencies[Currency!]
Only show payment requests using the specified currencies.
hasPurchaseOrderNumberBoolean
Only show payment requests that have a Purchase Order number.
hasTimesheetBoolean
Only show payment requests that have a timesheet.
jobs[ID!]
Only show payment requests for the specified jobs.
hires[ID!]
Only show payment requests for the specified hires.
hireOwners[ID!]
Only show payment requests belonging to hires owned by the specified users.
searchString
Only show payment requests that match the search query.
statuses[PaymentRequestStatus!]
Only show payment requests that have the specified statuses.
requestTypes[PaymentRequestType!]
Only show payment requests grouped by request type (time or amount).
workerStatuses[PaymentRequestWorkerStatus!]
Only show payment requests that have the specified worker statuses.
workerPayoutStatuses[PaymentRequestWorkerPayoutStatus!]
Only show payment requests that have the specified worker payout statuses.
isPayrolledBoolean
Only show payment requests by that were processed through payroll (true) or not through payroll (false).

This may include payment requests that were paid outside of payroll.
timesheetPeriodDateRangeInput
Only show payment requests that have a timesheet between the specified date range.
rateTypes[RateType!]
Only show payment requests that have the specified rate types.
requestedDateRangeDateRangeInput
Only show payment requests requested within the specified date range.
billingStartDateRangeDateRangeInput
Only show payment requests whose billing period start date falls within the specified range.
billingEndDateRangeDateRangeInput
Only show payment requests whose billing period end date falls within the specified range.
hasExpensesBoolean
Only show payment requests that have expenses (true) or do not have expenses (false).
hasBatchBoolean
Only show payment requests that have a batch (true) or don’t have a batch (false).
batchIds[ID!]
Only show payment requests that belong to the specified batches.
externalIdentifiers[String!]
Only show payment requests with the specified external identifiers.
orderBy[PaymentRequestOrderByClauseInput!]
Order the payment requests by the specified fields.
firstInt!
Limits number of fetched items.
pageInt
The offset from which items are returned.

profile

Type: User!

Deprecated

Get the authenticated user that is viewing the API.

project

Type: Project

Get a specific project.

Arguments
idID!
The ID of the project to view.

projects

Type: ProjectPaginator!

Get a list of projects.

Arguments
accounts[ID!]
Supply which accounts to see projects for.

If no accounts supplied then all authenticated accounts will be used.
searchString
Search between projects by budget, name, description and job name.
status[ProjectStatusFilter!]
Only show projects which have the supplied status.
owners[ID!]
Filter projects by owners ids.
externalIdentifiers[String!]
Only show projects with the specified external identifier.
firstInt!
Limits number of fetched items.
pageInt
The offset from which items are returned.

recruiter

Type: Recruiter

Get a specific recruiter.

Arguments
idID!
The ID of the recruiter.

recruiterCandidate

Type: RecruiterCandidate

Get a specific recruiter candidate.

Arguments
idID!
The ID of the recruiter candidate.

recruiterCandidates

Type: RecruiterCandidatePaginator!

Get a list of recruiter candidates.

Arguments
accounts[ID!]
Supply which accounts to see candidates for.

If no accounts are supplied then all authenticated accounts will be used.
statusContactStatus
Supply to filter for status.
searchString
Supply an input string which will be used to search through.
firstInt!
Limits number of fetched items.
pageInt
The offset from which items are returned.

recruiters

Type: RecruiterPaginator!

Get a list of recruiters.

Arguments
searchString
The search value used to search recruiters.
firstInt!
Limits number of fetched items.
pageInt
The offset from which items are returned.

skills

Type: SkillPaginator!

Get a list of skills.

Arguments
searchString
Supply an input string which will be used to search through.

Search will be performed within all three name, name_en, name_da.
skillableType[SkillableType!]
Supply a list of SkillableType to which skills should have been applied to.
orderBy[SkillOrderByClauseInput!]
Supply a list of column/order pairs for sorting, ordering will be applied in the provided order.
firstInt!
Limits number of fetched items.
pageInt
The offset from which items are returned.

timesheet

Type: Timesheet

Get a specific timesheet.

Arguments
idID!
The ID of the timesheet.

timesheets

Type: TimesheetPaginator!

Get a list of timesheets.

Arguments
accounts[ID!]
Filter the timesheets based on one or more accounts.

If no accounts supplied then all authenticated accounts will be used.
firstInt!
Limits number of fetched items.
pageInt
The offset from which items are returned.

trustedContact

Type: TrustedContact

Get a specific trusted contact.

Arguments
idID!
The ID of the trusted contact.

trustedContacts

Type: TrustedContactPaginator!

Get a list of trusted contacts.

Arguments
accounts[ID!]
Supply which accounts to see trusted contacts for.

If no accounts are supplied then all authenticated accounts will be used.
workers[ID!]
Supply which workers to see trusted contacts for.
searchString
Supply an input string which will be used to search through.
skills[ID!]
Supply a list of skills IDs to filter workers having those.
markets[MarketCode!]
Supply a list of markets codes to filter workers part of related markets.
countries[String!]
Supply a list of country codes to filter workers part of related countries.
states[String!]
Supply a list of states to filter workers in specific states.
invitedByUsersInvitedByInput
Supply a list of user IDs to filter workers by the user who has invited them as trusted contact for the company.
statuses[ContactStatus!]
Supply a list of statuses to filter workers by.
originTrustedContactOrigin
Filter the contacts by their origin. Have they been added or invited.
staffingAgencyStatusTrustedContactStaffingAgencyStatus
Filter contacts by whether they have staffing agency ownership or not.
managedStatusTrustedContactManagedStatus
Filter contacts by their managed status (worker, staffing agency, or unmanaged).
hireHistoryHireHistoryFilterInput
Filter contacts by whether they have been previously hired or not.
hireStatusHireStatusFilterInput
Filter contacts by whether they are currently hired or not.
businessSetup[BusinessEntityType!]
Supply a list of business entities to filter workers by.
externalIdentifiers[String!]
Only show trusted contacts with the specified external identifier.
customFields[CustomFieldTypeValueInput!]
Filter by custom fields attached to the TC’s. Freetext CF’s work by fuzzy search in the text. Single select works as inclusive or filters. That is you can chain multiple single select filters in the array to filter by many different CF selected options. This can similarly be done with freetext CF’s.
orderBy[TrustedContactOrderByClauseInput!]
Supply a list of column/order pairs for sorting, ordering will be applied in the provided order.
createdAtDateRangeDateRangeInput
Filter trusted contacts by the date they were created.
firstInt!
Limits number of fetched items.
pageInt
The offset from which items are returned.

userGroup

Type: UserGroup

Get a specific user group.

Arguments
idID!
The ID of the group to view.

userGroups

Type: UserGroupPaginator!

Get a list of user groups.

Arguments
accounts[ID!]
Supply which accounts to see groups for.

If no accounts supplied then all authenticated accounts will be used.
searchString
Search user groups by name, description and users name, email.
users[ID!]
Filter user groups by users.
status[UserGroupStatus!]
Filter user group by status.
firstInt!
Limits number of fetched items.
pageInt
The offset from which items are returned.

viewer

Type: User!

Get the authenticated user that is viewing the API.

webhook

Type: Webhook

Get a specific webhook.

Arguments
idID!
The ID of the webhook.

webhookEvent

Type: WebhookEvent

Get a specific webhook event.

Arguments
idID!
The ID of the webhook event.

webhookEventLogs

Type: WebhookEventLogPaginator!

Get a list of webhook event logs. They are returned in descending order of creation.

Arguments
webhookIdID
Filter the webhook event logs based on the ID of the webhook.
webhookEventIdID
Filter the webhook event logs based on the ID of the webhook.
accounts[ID!]
Filter the webhook event logss based on one or more accounts.

If no accounts are supplied then all authenticated accounts will be used.
firstInt!
Limits number of fetched items.
pageInt
The offset from which items are returned.

webhookEvents

Type: WebhookEventPaginator!

Get a list of webhook events. They are returned in descending order of creation.

Arguments
webhookIdID
Filter the webhook events based on the ID of the webhook.
firstInt!
Limits number of fetched items.
pageInt
The offset from which items are returned.

webhooks

Type: WebhookPaginator!

Get a list of webhooks.

Arguments
accounts[ID!]
Filter the webhooks based on one or more accounts.

If no accounts are supplied then all authenticated accounts will be used.
firstInt!
Limits number of fetched items.
pageInt
The offset from which items are returned.

worker

Type: Worker

Get a specific worker.

Arguments
idID!
The ID of the worker.

workflow

Type: Workflow

Get a specific workflow by ID.

Requires the manage-approvals team permission on the owning company.

Arguments
idID!
The ID of the workflow (same as the approval ID).

workflowVariables

Type: WorkflowVariablePaginator!

List the available variables that can be used in approval rule conditions.

Variables represent the fields you can evaluate in conditions — for example, hourly rate, budget, or company-defined custom fields. The available variables depend on the trigger type: hire-related triggers expose rate and budget variables, while classification triggers expose the classification result.

Requires the manage-approvals team permission.

Arguments
accounts[ID!]
Filter by the accounts that own the variables (includes company custom fields).
appliesToApprovalTrigger!
The trigger type to get variables for. Different triggers expose different variables.
firstInt!
Limits number of fetched items.
pageInt
The offset from which items are returned.

workflows

Type: WorkflowPaginator!

List all workflows accessible to the authenticated user.

Requires the manage-approvals team permission.

Arguments
accounts[ID!]
Filter workflows by the accounts that own them.
firstInt!
Limits number of fetched items.
pageInt
The offset from which items are returned.