Queries
Queries are a type that defines what data you are able to request from the GraphQL API.
accounts
Type: [Account!]!
Gives a list of all accounts which the current authentication has access to.
approvalRule
Type: ApprovalRule
Get a specific approval rule.
approval
Type: Approval
Get a specific approval.
approver
Type: Approver
Get a specific approver.
approvalApprovable
Type: ApprovalApprovable
Get approvable approval.
bid
Type: Bid
A specific bid which the user has access to.
bill
Type: Bill
Retrieve a single bill.
company
Type: Company
Retrieve a company.
companyRecruiter
Type: CompanyRecruiter
Retrieve a single company recruiter.
contract
Type: Contract
Retrieve a single contract.
conversation
Type: Conversation
Retrieve a single conversation
file
Type: File
Retrieve a single file.
hire
Type: Hire
Used for getting a specific hire.
All parties of the hire can use this field for seeing their hire.
industry
Type: Industry
Retrieve a single industry.
customField
Type: CustomField
Retrieve a single custom field.
invoice
Type: Invoice
Retrieve a single invoice.
invoiceRow
Type: InvoiceRow
Retrieve a single invoice row.
job
Type: Job
Retrieve a single job.
project
Type: Project
Retrieve a single project.
trustedContact
Type: TrustedContact
Retrieve a single trusted contact.
organisationTrustedContact
Type: TrustedContact
Retrieve a single organisation trusted contact.
userGroup
Type: UserGroup
Retrieve a single user group.
viewer
Type: User!
The authenticated user that is viewing the API.
worker
Type: Worker
Retrieve a single worker.
workflow
Type: Workflow
Get a specific workflow.
approvalRules
Type: ApprovalRulePaginator!
Get all approval rules.
approvals
Type: ApprovalPaginator!
Get all approvals.
approvers
Type: ApproverPaginator!
Get all approvers.
approvalApprovables
Type: ApprovalApprovablePaginator!
Get all approvable approvals.
bids
Type: BidPaginator!
A list of all bids which the viewer has access to.
companyRecruiters
Type: CompanyRecruiterPaginator!
Retrieve a list of company recruiters.
contracts
Type: ContractPaginator!
Retrieve an array of contracts.
conversations
Type: ConversationPaginator!
Retrieve a list of conversations
files
Type: FilePaginator!
Retrieve a list of files.
hires
Type: HirePaginator!
Used for getting all hires.
All parties of the hire can use this field for seeing their hires.
industries
Type: IndustryPaginator!
Retrieve a list of industries.
customFields
Type: CustomFieldPaginator!
Retrieve a list of custom fields.
invoices
Type: InvoicePaginator!
Retrieve an array of invoices.
jobs
Type: JobPaginator!
Retrieve an array of jobs.
projects
Type: ProjectPaginator!
Retrieve a list of projects.
recruiters
Type: RecruiterPaginator!
Search recruiters.
trustedContacts
Type: TrustedContactPaginator!
Retrieve a list of trusted contacts.
organisationTrustedContacts
Type: TrustedContactPaginator!
Retrieve a list of organisation trusted contacts.
userGroups
Type: UserGroupPaginator!
Retrieve a list of user groups.
workflows
Type: WorkflowPaginator!
Get all workflows.
multiFactor
Type: MultiFactor
Retrieve a specific multi-factor authentication implementation.
profile
Type: User!
Accessing the currently logged in user.
multiFactors
Type: MultiFactorPaginator!
Retrieve all multi-factor authentication implementation.