Queries
Queries are a type that defines what data you are able to request from the GraphQL API.
multiFactor
Type: MultiFactor
Retrieve a specific multi-factor authentication implementation.
| Arguments |
idID!
The id for the multi-factor authentication implementation. |
profile
Type: User!
Accessing the currently logged in user.
multiFactors
Type: MultiFactorPaginator!
Retrieve all multi-factor authentication implementation.
| Arguments |
statuses[Status!]
A list of statuses to filter the multi factors on. |
firstInt!
Limits number of fetched items. Maximum allowed value: 30. |
pageInt
The offset from which items are returned. |
accounts
Type: [Account!]!
Get a list of accounts which the current authentication has access to.
approvalRule
Type: ApprovalRule
Get a specific approval rule.
| Arguments |
idID!
The ID of the approval rule to look at. |
approval
Type: Approval
Get a specific approval.
| Arguments |
idID!
The ID of the approval to look at. |
approver
Type: Approver
Get a specific approver.
| Arguments |
idID!
The ID of the approver to look at. |
approvalApprovable
Type: ApprovalApprovable
Get approvable approval.
| Arguments |
idID!
The ID of the approval approvable. |
bid
Type: Bid
Get a specific bid which the user has access to.
| Arguments |
idID!
The ID of the bid. |
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. |
contract
Type: Contract
Get a specific contract.
| Arguments |
idID!
The ID of the contract. |
conversation
Type: Conversation
Get a specific conversation.
| Arguments |
idID!
The ID of the conversation. |
customField
Type: CustomField
Get a specific custom field.
| Arguments |
idID!
The custom field ID. |
file
Type: File
Get a specific file.
| Arguments |
idID!
The ID of the file. |
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. |
industry
Type: Industry
Get a specific industry.
| Arguments |
idID!
The ID of the industry. |
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. |
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. |
paymentRequest
Type: PaymentRequest
Get a specific payment request.
| Arguments |
idID!
The ID of the payment request. |
project
Type: Project
Get a specific project.
| Arguments |
idID!
The ID of the project to view. |
recruiterCandidate
Type: RecruiterCandidate
Get a specific recruiter candidate.
| Arguments |
idID!
The ID of the recruiter candidate. |
timesheet
Type: Timesheet
Get a specific timesheet.
| Arguments |
idID!
The ID of the timesheet. |
trustedContact
Type: TrustedContact
Get a specific trusted contact.
| Arguments |
idID!
The ID of the trusted contact. |
organisationTrustedContact
Type: TrustedContact
Get a specific organisation trusted contact.
| Arguments |
idID!
The ID of the trusted contact. |
userGroup
Type: UserGroup
Get a specific user group.
| Arguments |
idID!
The ID of the group to view. |
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. |
worker
Type: Worker
Get a specific worker.
| Arguments |
idID!
The ID of the worker. |
workflow
Type: Workflow
Get a specific workflow.
| Arguments |
idID!
The ID of the workflow to look at. |
approvalRules
Type: ApprovalRulePaginator!
Get all approval rules.
| Arguments |
accounts[ID!]
Filter the approval rules based on one or more accounts. |
firstInt!
Limits number of fetched items. |
pageInt
The offset from which items are returned. |
approvals
Type: ApprovalPaginator!
Get all approvals.
| Arguments |
accounts[ID!]
Filter the approvals based on one or more accounts. |
searchString
Search approvals by name or description. |
firstInt!
Limits number of fetched items. |
pageInt
The offset from which items are returned. |
approvers
Type: ApproverPaginator!
Get all approvers.
| Arguments |
accounts[ID!]
Filter the approvers based on one or more accounts. |
approvalRuleID
Filter the approvers based on one approval rule. |
firstInt!
Limits number of fetched items. |
pageInt
The offset from which items are returned. |
approvalApprovables
Type: ApprovalApprovablePaginator!
Get all approvable approvals.
| Arguments |
accounts[ID!]
Filter the approval approvable based on one or more accounts. |
requiresActionBoolean
Filter for approval approvables that require actioning. |
requiresActionUsers[ID!]
Filter the approval approvable based on users that need to take action. |
approvals[ID!]
Filter the approval approvables based on one or more approvals. |
approvableID
Filter the approval approvable based on an approvable type. |
approvalRules[ID!]
Filter the approval approvable based on one or more approval rules. |
firstInt!
Limits number of fetched items. |
pageInt
The offset from which items are returned. |
approvalStates
Type: ApprovalStatePaginator!
Get all approval states.
| Arguments |
accounts[ID!]
Filter the approval approvable based on one or more accounts. |
status[ApprovalApprovableState!]
Filter the approval approvable based on one or more approval states. |
users[ID!]
Filter the approval approvable based on one or more users. |
firstInt!
Limits number of fetched items. |
pageInt
The offset from which items are returned. |
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. |
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. |
firstInt!
Limits number of fetched items. |
pageInt
The offset from which items are returned. |
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. |
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. |
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. |
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. |
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. |
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 by hire id, worker name, job name, or company name. |
status[String!]
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. |
createdAtDateRangeDateRangeInput
Filter hires by hire by the date the hire was created. |
externalIdentifiers[String!]
Only show hires with the specified external identifier. |
contractStatus[String!]
Filter hires by hire contract status. |
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. |
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, freelancer 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. |
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. |
jobs
Type: JobPaginator!
Get a list of jobs.
| Arguments |
accounts[ID!]
Only show jobs created by a specific account. |
markets[MarketCode!]
Only show jobs in the specified markets. |
searchString
Search jobs by name or description. |
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. |
associations[Association!]
Only show jobs using the specified project types. |
locationPreferences[LocationPreference!]
Only show jobs using the specified location preferences. |
completedBoolean
Only show jobs that have either been completed or not. |
hasProjectBoolean
Filter for jobs with or without project. |
externalIdentifiers[String!]
Only show jobs with the specified external identifier. |
firstInt!
Limits number of fetched items. |
pageInt
The offset from which items are returned. |
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. |
firstInt!
Limits number of fetched items. |
pageInt
The offset from which items are returned. |
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. |
searchString
Only show payment requests that match the search query. |
statuses[PaymentRequestStatus!]
Only show payment requests that have the specified statuses. |
workerStatuses[PaymentRequestWorkerStatus!]
Only show payment requests that have the specified worker statuses. |
firstInt!
Limits number of fetched items. |
pageInt
The offset from which items are returned. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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 |
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. |
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. |
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. |
workflows
Type: WorkflowPaginator!
Get all workflows.
| Arguments |
accounts[ID!]
Filter the workflows based on one or more accounts. |
firstInt!
Limits number of fetched items. |
pageInt
The offset from which items are returned. |
workflowVariables
Type: WorkflowVariablePaginator!
Get all workflow variables.
| Arguments |
accounts[ID!]
Filter the workflow variables based on one or more accounts. |
appliesToApprovalTrigger!
Filter the workflow variables based on the trigger it applies to. |
firstInt!
Limits number of fetched items. |
pageInt
The offset from which items are returned. |
