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.

Example

query Accounts {
  accounts {
    __typename
    # ...plus the fields you need
  }
}

approval

Type: Approval

Get a specific approval flow by ID.

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

Arguments
`id`ID! The ID of the approval flow.

Example

query Approval {
  approval(id: "abc123") {
    __typename
    # ...plus the fields you need
  }
}

approvalApprovable

Type: ApprovalApprovable

Get a specific approval request by ID.

Arguments
`id`ID! The ID of the approval request.

Example

query ApprovalApprovable {
  approvalApprovable(id: "abc123") {
    __typename
    # ...plus the fields you need
  }
}

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.
`requiresAction`Boolean 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.
`approvable`ID 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.
`first`Int! Limits number of fetched items.
`page`Int The offset from which items are returned.

Example

query ApprovalApprovables {
  approvalApprovables(accounts: ["abc123"], requiresAction: true, requiresActionUsers: ["abc123"], approvals: ["abc123"], approvable: "abc123", approvalRules: ["abc123"], orderBy: [{
    # ApprovalApprovablesOrderByClauseInput fields
  }], first: 10, page: 10) {
    __typename
    # ...plus the fields you need
  }
}

approvalRule

Type: ApprovalRule

Get a specific approval rule by ID.

Arguments
`id`ID! The ID of the approval rule.

Example

query ApprovalRule {
  approvalRule(id: "abc123") {
    __typename
    # ...plus the fields you need
  }
}

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.
`first`Int! Limits number of fetched items.
`page`Int The offset from which items are returned.

Example

query ApprovalRules {
  approvalRules(accounts: ["abc123"], first: 10, page: 10) {
    __typename
    # ...plus the fields you need
  }
}

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.
`first`Int! Limits number of fetched items.
`page`Int The offset from which items are returned.

Example

query ApprovalStates {
  approvalStates(accounts: ["abc123"], status: [UNKNOWN], users: ["abc123"], first: 10, page: 10) {
    __typename
    # ...plus the fields you need
  }
}

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.
`search`String Search approvals by name or description.
`first`Int! Limits number of fetched items.
`page`Int The offset from which items are returned.

Example

query Approvals {
  approvals(accounts: ["abc123"], search: "example", first: 10, page: 10) {
    __typename
    # ...plus the fields you need
  }
}

approver

Type: Approver

Get a specific approver assignment by ID.

Arguments
`id`ID! The ID of the approver.

Example

query Approver {
  approver(id: "abc123") {
    __typename
    # ...plus the fields you need
  }
}

approvers

Type: ApproverPaginator!

List approver assignments, optionally filtered by approval rule.

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

Example

query Approvers {
  approvers(accounts: ["abc123"], approvalRule: "abc123", first: 10, page: 10) {
    __typename
    # ...plus the fields you need
  }
}

batch

Type: Batch

Get a specific batch.

Arguments
`id`ID! The ID of the batch.

Example

query Batch {
  batch(id: "abc123") {
    __typename
    # ...plus the fields you need
  }
}

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.
`first`Int! Limits number of fetched items.
`page`Int The offset from which items are returned.

Example

query Batches {
  batches(accounts: ["abc123"], types: [PARTNER_PAYMENT_REQUESTS], containsItemsWithStatus: [PROCESSING], first: 10, page: 10) {
    __typename
    # ...plus the fields you need
  }
}

bid

Type: Bid

Get a specific bid which the user has access to.

Arguments
`id`ID! The ID of the bid.

Example

query Bid {
  bid(id: "abc123") {
    __typename
    # ...plus the fields you need
  }
}

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.
`job`ID Filter the bids based on a job.
`accounts`[ID!] Filter the bid based on one or more accounts.
`companies`[ID!] Filter the bids based on one or more companies.
`orderBy`[BidOrderByClauseInput!] Order the bids by the specified field and direction.
`first`Int! Limits number of fetched items.
`page`Int The offset from which items are returned.

Example

query Bids {
  bids(statuses: [OPEN], job: "abc123", accounts: ["abc123"], companies: ["abc123"], orderBy: [{
    # BidOrderByClauseInput fields
  }], first: 10, page: 10) {
    __typename
    # ...plus the fields you need
  }
}

classification

Type: Classification

Get a specific classification by ID.

Arguments
`id`ID! The ID of the classification to retrieve

Example

query Classification {
  classification(id: "abc123") {
    __typename
    # ...plus the fields you need
  }
}

classifications

Type: ClassificationPaginator!

Get all classifications for a specific hire.

Arguments
`hire`ID! The ID of the hire to get classifications for
`first`Int! Limits number of fetched items.
`page`Int The offset from which items are returned.

Example

query Classifications {
  classifications(hire: "abc123", first: 10, page: 10) {
    __typename
    # ...plus the fields you need
  }
}

clientRelation

Type: ClientRelation

Experimental. Get one client relation of the viewer’s supplier accounts: a supplier company’s relation or a staffing agency’s client link, whichever kind the ID is.

Arguments
`id`ID! The ID of a company supplier relation or of a staffing agency’s client link.

Example

query ClientRelation {
  clientRelation(id: "abc123") {
    __typename
    # ...plus the fields you need
  }
}

clientRelationCounterpartOwners

Type: OwnerPaginator!

Experimental. The other side’s people assigned to one client relation. On a supplier company’s relation: the people its staffing agencies assigned to their links at that client. On a staffing agency’s managed link: the people the managing company assigned to its own relation with that client. Empty for a direct agency link.

Arguments
`accounts`[ID!] Only when the relation belongs to these supplier company or staffing agency accounts. Without it, any such account the viewer belongs to.
`client`ID! The client relation: a CompanySupplier or a SupplierClient.
`search`String Search people by name or email.
`staffingAgencies`[ID!] Only show recruiters of these staffing agencies. Ignored on a staffing agency’s link.
`assignedAtDateRange`DateRangeInput Only show people assigned within the given date range.
`orderBy`[ClientRelationAgencyOwnerOrderByClauseInput!] Supply a list of column/order pairs for sorting, applied in the provided order.
`first`Int! Limits number of fetched items.
`page`Int The offset from which items are returned.

Example

query ClientRelationCounterpartOwners {
  clientRelationCounterpartOwners(accounts: ["abc123"], client: "abc123", search: "example", staffingAgencies: ["abc123"], assignedAtDateRange: {
    # DateRangeInput fields
  }, orderBy: [{
    # ClientRelationAgencyOwnerOrderByClauseInput fields
  }], first: 10, page: 10) {
    __typename
    # ...plus the fields you need
  }
}

clientRelationOwners

Type: OwnerPaginator!

The viewer’s own team members assigned to one client relation: a supplier company’s or a staffing agency’s.

Arguments
`accounts`[ID!] Only when the relation belongs to these supplier company or staffing agency accounts. Without it, any such account the viewer belongs to.
`client`ID! Experimental. The client relation to list the assigned team members of: a CompanySupplier or a SupplierClient.
`search`String Search people by name or email.
`assignedAtDateRange`DateRangeInput Only show people assigned within the given date range.
`orderBy`[ClientRelationOwnerOrderByClauseInput!] Supply a list of column/order pairs for sorting, applied in the provided order.
`first`Int! Limits number of fetched items.
`page`Int The offset from which items are returned.

Example

query ClientRelationOwners {
  clientRelationOwners(accounts: ["abc123"], client: "abc123", search: "example", assignedAtDateRange: {
    # DateRangeInput fields
  }, orderBy: [{
    # ClientRelationOwnerOrderByClauseInput fields
  }], first: 10, page: 10) {
    __typename
    # ...plus the fields you need
  }
}

clientRelationRegions

Type: [MarketWithRegions!]!

Experimental. The markets of the viewer’s clients, with all of their regions: the clients of its supplier companies and of its staffing agencies.

Arguments
`accounts`[ID!] Only the clients of these accounts. Without it, every account the viewer belongs to.

Example

query ClientRelationRegions {
  clientRelationRegions(accounts: ["abc123"]) {
    __typename
    # ...plus the fields you need
  }
}

clientRelationTeam

Type: CompanyTeamMemberPaginator!

The client company’s team behind one relation: its owner and the members who have accepted.

Arguments
`accounts`[ID!] Only when the relation belongs to these supplier company accounts. Without it, any supplier company the viewer belongs to.
`client`ID! The client relation whose client company’s team to list.
`search`String Search people by name or email.
`accountRoles`[CompanyTeamRole!] Only show people with one of these account roles.
`hasPhone`Boolean Only show people with (or without) a phone number.
`orderBy`[ClientRelationTeamOrderByClauseInput!] Supply a list of column/order pairs for sorting, applied in the provided order.
`first`Int! Limits number of fetched items.
`page`Int The offset from which items are returned.

Example

query ClientRelationTeam {
  clientRelationTeam(accounts: ["abc123"], client: "abc123", search: "example", accountRoles: [OWNER], hasPhone: true, orderBy: [{
    # ClientRelationTeamOrderByClauseInput fields
  }], first: 10, page: 10) {
    __typename
    # ...plus the fields you need
  }
}

clientSuppliers

Type: SupplierClientPaginator!

The suppliers contracted for one of the company’s clients.

Arguments
`accounts`[ID!] Only show links managed by these company accounts. Without it, every company the viewer manages staffing agencies for.
`client`ID! The client company to list contracted suppliers for.
`search`String Supply an input string which will be used to search through supplier names.
`supplierStatuses`[RecruiterStatus!] Filter by the status of the supplier relation itself.
`linkedAtDateRange`DateRangeInput Filter by the date the supplier was linked to this client.
`orderBy`[SupplierClientOrderByClauseInput!] Supply a list of column/order pairs for sorting, ordering will be applied in the provided order.
`first`Int! Limits number of fetched items.
`page`Int The offset from which items are returned.

Example

query ClientSuppliers {
  clientSuppliers(accounts: ["abc123"], client: "abc123", search: "example", supplierStatuses: [ACTIVE], linkedAtDateRange: {
    # DateRangeInput fields
  }, orderBy: [{
    # SupplierClientOrderByClauseInput fields
  }], first: 10, page: 10) {
    __typename
    # ...plus the fields you need
  }
}

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.
`first`Int! Limits number of fetched items.
`page`Int The offset from which items are returned.

Example

query Companies {
  companies(externalIdentifiers: ["example"], first: 10, page: 10) {
    __typename
    # ...plus the fields you need
  }
}

company

Type: Company

Get a specific company.

Arguments
`id`ID! The ID of the company.

Example

query Company {
  company(id: "abc123") {
    __typename
    # ...plus the fields you need
  }
}

companyClients

Type: CompanySupplierPaginator!

Get a list of clients the authenticated company accounts supply to.

The rows companySuppliers also returns, limited to those where the viewer’s company is the supplier.

Arguments
`accounts`[ID!] Only show the clients of these supplier company accounts. Without it, clients of every supplier company the viewer belongs to are shown.
`search`String Search clients by company name.
`clientRegions`MarketRegionInput Filter clients by market and optionally narrow by specific regions.
`createdAtDateRange`DateRangeInput Only show clients whose relationship was established within the given date range.
`paymentTermsFollowsClient`Boolean Only show clients whose supplier hires copy (or do not copy) the client’s payment terms.
`hasLinkedStaffingAgencies`Boolean Only show clients with (or without) staffing agencies linked to them by the supplier.
`linkedStaffingAgencies`[ID!] Only show clients linked to any of the given staffing-agency relations.
`owners`[ID!] Only show clients owned by any of the given users.
`orderBy`[CompanyClientOrderByClauseInput!] Supply a list of column/order pairs for sorting, applied in the provided order.
`first`Int! Limits number of fetched items.
`page`Int The offset from which items are returned.

Example

query CompanyClients {
  companyClients(accounts: ["abc123"], search: "example", clientRegions: {
    # MarketRegionInput fields
  }, createdAtDateRange: {
    # DateRangeInput fields
  }, paymentTermsFollowsClient: true, hasLinkedStaffingAgencies: true, linkedStaffingAgencies: ["abc123"], owners: ["abc123"], orderBy: [{
    # CompanyClientOrderByClauseInput fields
  }], first: 10, page: 10) {
    __typename
    # ...plus the fields you need
  }
}

companyRecruiter

Type: CompanyRecruiter

Get a specific company recruiter.

Arguments
`id`ID! The ID of the company recruiter.

Example

query CompanyRecruiter {
  companyRecruiter(id: "abc123") {
    __typename
    # ...plus the fields you need
  }
}

companyRecruiterRegions

Type: [MarketWithRegions!]!

Get distinct regions used by the company’s associated recruiters, grouped by market. Scoped to the authenticated user’s companies.

Example

query CompanyRecruiterRegions {
  companyRecruiterRegions {
    __typename
    # ...plus the fields you need
  }
}

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.
`search`String 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.
`recruiterRegions`MarketRegionInput Filter recruiters by market and optionally narrow by specific regions.
`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.
`verifiedRecruiterReview`VerifiedRecruiterReviewFilterInput Filter staffing agencies by their VerifiedRecruiterCompliance review state.
`endClients`[ID!] Only show staffing agencies linked to any of the given end-client companies.
`first`Int! Limits number of fetched items.
`page`Int The offset from which items are returned.

Example

query CompanyRecruiters {
  companyRecruiters(accounts: ["abc123"], search: "example", statuses: [ACTIVE], tags: ["example"], markets: ["example"], recruiterRegions: {
    # MarketRegionInput fields
  }, orderBy: [{
    # RecruiterOrderByClauseInput fields
  }], externalIdentifiers: ["example"], customFields: [{
    # CustomFieldTypeValueInput fields
  }], verifiedRecruiterReview: {
    # VerifiedRecruiterReviewFilterInput fields
  }, endClients: ["abc123"], first: 10, page: 10) {
    __typename
    # ...plus the fields you need
  }
}

companySupplier

Type: CompanySupplier

Get a specific company supplier.

Arguments
`id`ID! The ID of the company supplier.

Example

query CompanySupplier {
  companySupplier(id: "abc123") {
    __typename
    # ...plus the fields you need
  }
}

companySuppliers

Type: CompanySupplierPaginator!

Get a list of company suppliers for the authenticated company accounts.

Arguments
`accounts`[ID!] Filter by specific company accounts.
`search`String Search suppliers by name.
`first`Int! Limits number of fetched items.
`page`Int The offset from which items are returned.

Example

query CompanySuppliers {
  companySuppliers(accounts: ["abc123"], search: "example", first: 10, page: 10) {
    __typename
    # ...plus the fields you need
  }
}

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
`id`ID! The ID of the hire to get compliance requirements for
`names`[ComplianceName!] Optional compliance names to filter for specific compliances
`cached`Boolean Read strategy for `applicable` / `completed`. Defaults to live computation. Pass `true` to read the persisted compliance status row (falling back to live when no row exists yet). Intended for verification dashboards during the persisted-status rollout; the default will remain live until the persisted rows are proven correct in production.

Example

query Compliance {
  compliance(id: "abc123", names: [ADDRESS], cached: true) {
    __typename
    # ...plus the fields you need
  }
}

contract

Type: Contract

Get a specific contract.

Arguments
`id`ID! The ID of the contract.

Example

query Contract {
  contract(id: "abc123") {
    __typename
    # ...plus the fields you need
  }
}

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.
`first`Int! Limits number of fetched items.
`page`Int The offset from which items are returned.

Example

query Contracts {
  contracts(accounts: ["abc123"], currencies: [AED], statuses: [DRAFT], locationPreferences: [ONSITE_ONLY], first: 10, page: 10) {
    __typename
    # ...plus the fields you need
  }
}

conversation

Type: Conversation

Get a specific conversation.

Arguments
`id`ID! The ID of the conversation.

Example

query Conversation {
  conversation(id: "abc123") {
    __typename
    # ...plus the fields you need
  }
}

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.
`isOpen`Boolean If the conversation is open or closed. If not supplied show all conversations.
`first`Int! Limits number of fetched items.
`page`Int The offset from which items are returned.

Example

query Conversations {
  conversations(accounts: ["abc123"], isOpen: true, first: 10, page: 10) {
    __typename
    # ...plus the fields you need
  }
}

countries

Type: [Country!]!

Get a list of all countries.

Example

query Countries {
  countries {
    __typename
    # ...plus the fields you need
  }
}

customField

Type: CustomField

Get a specific custom field.

Arguments
`id`ID! The custom field ID.

Example

query CustomField {
  customField(id: "abc123") {
    __typename
    # ...plus the fields you need
  }
}

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.
`approval`Boolean Supply to select fields with approval workflow enabled or disabled.
`appliesTo`[TypeSupportingCustomFieldValues!] A list of entity types supporting custom fields.
`includeArchived`Boolean Supply true to also include archived fields. Defaults to excluding them.
`first`Int! Limits number of fetched items.
`page`Int The offset from which items are returned.

Example

query CustomFields {
  customFields(accounts: ["abc123"], approval: true, appliesTo: [JOB], includeArchived: true, first: 10, page: 10) {
    __typename
    # ...plus the fields you need
  }
}

employment

Type: Employment

Get a specific employment.

Arguments
`id`ID! The ID of the employment.

Example

query Employment {
  employment(id: "abc123") {
    __typename
    # ...plus the fields you need
  }
}

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.
`search`String Filter by search term against worker name, job title, etc.
`orderBy`[EmploymentsOrderByClauseInput!] Order by clause.
`startDateRange`DateRangeInput Filter by start date range.
`endDateRange`DateRangeInput 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.
`previouslyHired`Boolean Filter by previously hired status.
`first`Int! Limits number of fetched items.
`page`Int The offset from which items are returned.

Example

query Employments {
  employments(accounts: ["abc123"], status: [DRAFT], employerRecordStatus: [INCOMPLETE], search: "example", orderBy: [{
    # EmploymentsOrderByClauseInput fields
  }], startDateRange: {
    # DateRangeInput fields
  }, endDateRange: {
    # DateRangeInput fields
  }, contractType: [CONTRACT_TYPE_CONTRACTOR], locations: ["example"], companies: ["abc123"], hiringManagers: ["abc123"], rateTypes: [HOURLY], previouslyHired: true, first: 10, page: 10) {
    __typename
    # ...plus the fields you need
  }
}

file

Type: File

Get a specific file.

Arguments
`id`ID! The ID of the file.

Example

query File {
  file(id: "abc123") {
    __typename
    # ...plus the fields you need
  }
}

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.
`first`Int! Limits number of fetched items.
`page`Int The offset from which items are returned.

Example

query Files {
  files(accounts: ["abc123"], mimeTypes: ["example"], first: 10, page: 10) {
    __typename
    # ...plus the fields you need
  }
}

gate

Type: Gate

Get a specific gate for a hire.

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

Arguments
`id`ID! The ID of the hire to get the gate for
`gate`ComplianceName! The name of the compliance gate to retrieve
`cached`Boolean Read strategy for `applicable` / `completed` on the gate and its compliances. Defaults to live; pass `true` to read the persisted status rows with a live fallback.

Example

query Gate {
  gate(id: "abc123", gate: ADDRESS, cached: true) {
    __typename
    # ...plus the fields you need
  }
}

hire

Type: Hire

Get a specific hire.

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

Arguments
`id`ID! The ID of the hire.

Example

query Hire {
  hire(id: "abc123") {
    __typename
    # ...plus the fields you need
  }
}

hireInvitation

Type: HireInvitation

The questions a hire’s company asks its worker, with only the hire details needed to answer them.

Available to the hire’s worker, or the staffing agency managing them. Unlike hire, this also works while the hire is a draft waiting on answers, and never exposes commercial terms.

Arguments
`id`ID! The ID of the hire.

Example

query HireInvitation {
  hireInvitation(id: "abc123") {
    __typename
    # ...plus the fields you need
  }
}

hireInvitations

Type: [HireInvitation!]!

The draft hires waiting on answers from the viewer (the worker, or the staffing agency managing them).

Example

query HireInvitations {
  hireInvitations {
    __typename
    # ...plus the fields you need
  }
}

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.
`search`String 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.
`recruiterOwnershipIsExpired`Boolean Filter hires by if recruiter ownership is active.
`companies`[ID!] Filter hires by company ids.
`endClients`[ID!] Experimental. Only hires at these end clients, including placements made through a managed service provider for one of them.
`workers`[ID!] Filter hires by worker ids.
`staffingAgencies`[ID!] Filter hires by the staffing agencies that supplied them. Includes hires supplied through a managed service provider, where the staffing agency is recorded on the provider’s copy of the hire rather than on this one.
`recruiters`[ID!] Filter hires by the staffing agency recorded on the hire itself. Unlike `staffingAgencies`, this ignores hires supplied through a managed service provider, where the staffing agency is recorded only on the provider’s copy. Both return the same hires for work supplied directly.
`startDateRange`DateRangeInput Filter hires by hire start date.
`endDateRange`DateRangeInput Filter hires by hire end date.
`startsAfter`Date Filter hires that start after the specified date.
`endsAfter`Date Filter hires that end after the specified date.
`createdAtDateRange`DateRangeInput 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.
`checklistStatus`[ChecklistStatus!] Experimental. Only hires with a checklist in one of these statuses.
`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.
`includeDeleted`Boolean Deprecated Include soft deleted hires.
`jobOwners`[ID!] Deprecated Filter hires by job owner.
`owners`[ID!] Filter hires by owner.
`hasPaymentRequests`Boolean Filter hires by if there are associated payment requests.
`missingPaymentRequestDateRange`DateRangeInput Only show hires with no payment request submitted within the given date range, including hires that have never submitted one at all.
`hasRecruiterAttribution`Boolean Filter hires by if there are recruiter attribution or not.
`eligibleForPaymentRequests`Boolean Only show hires that can be selected when creating a payment request.
`jobs`[ID!] Only show hires that belong to one or more specific jobs.
`supplierAccounts`[ID!] Filter hires by supplier accounts (Company or Recruiter acting as supplier).
`first`Int! Limits number of fetched items.
`page`Int The offset from which items are returned.

Example

query Hires {
  hires(accounts: ["abc123"], search: "example", status: [DRAFT], orderBy: [{
    # HiresOrderByClauseInput fields
  }], recruiterOwnershipIsExpired: true, companies: ["abc123"], endClients: ["abc123"], workers: ["abc123"], staffingAgencies: ["abc123"], recruiters: ["abc123"], startDateRange: {
    # DateRangeInput fields
  }, endDateRange: {
    # DateRangeInput fields
  }, startsAfter: "...", endsAfter: "...", createdAtDateRange: {
    # DateRangeInput fields
  }, externalIdentifiers: ["example"], contractStatus: [DRAFT], checklistStatus: [COMPLETE], contractType: [CONTRACT_TYPE_CONTRACTOR], engagementType: [PAYROLL], engagementTypeSetup: [W2], usesClassification: [NOT_USING], activeStatus: [DRAFT], includeDeleted: true, jobOwners: ["abc123"], owners: ["abc123"], hasPaymentRequests: true, missingPaymentRequestDateRange: {
    # DateRangeInput fields
  }, hasRecruiterAttribution: true, eligibleForPaymentRequests: true, jobs: ["abc123"], supplierAccounts: ["abc123"], first: 10, page: 10) {
    __typename
    # ...plus the fields you need
  }
}

incomingJobs

Type: JobPaginator!

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

Arguments
`search`String Search job posts by title or description.
`orderBy`[JobsOrderByClauseInput!] Order the results.
`first`Int! Limits number of fetched items.
`page`Int The offset from which items are returned.

Example

query IncomingJobs {
  incomingJobs(search: "example", orderBy: [{
    # JobsOrderByClauseInput fields
  }], first: 10, page: 10) {
    __typename
    # ...plus the fields you need
  }
}

industries

Type: IndustryPaginator!

Get a list of industries.

Arguments
`first`Int! Limits number of fetched items.
`page`Int The offset from which items are returned.

Example

query Industries {
  industries(first: 10, page: 10) {
    __typename
    # ...plus the fields you need
  }
}

industry

Type: Industry

Get a specific industry.

Arguments
`id`ID! The ID of the industry.

Example

query Industry {
  industry(id: "abc123") {
    __typename
    # ...plus the fields you need
  }
}

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.
`approval`Boolean Supply to select fields with approval workflow enabled or disabled.
`appliesTo`[TypeSupportingCustomFieldValues!] A list of entity types supporting custom fields.
`includeArchived`Boolean Supply true to also include archived fields. Defaults to excluding them.
`first`Int! Limits number of fetched items.
`page`Int The offset from which items are returned.

Example

query InheritedCustomFields {
  inheritedCustomFields(accounts: ["abc123"], approval: true, appliesTo: [JOB], includeArchived: true, first: 10, page: 10) {
    __typename
    # ...plus the fields you need
  }
}

invoice

Type: Invoice

Get a specific invoice.

Arguments
`id`ID The ID of the invoice. Exactly one of `id` or `number` must be supplied.
`number`String The invoice number on the PDF. Exactly one of `id` or `number` must be supplied.

Example

query Invoice {
  invoice(id: "abc123", number: "example") {
    __typename
    # ...plus the fields you need
  }
}

invoiceRow

Type: InvoiceRow

Get a specific invoice row.

Arguments
`id`ID! The ID of the invoice row.

Example

query InvoiceRow {
  invoiceRow(id: "abc123") {
    __typename
    # ...plus the fields you need
  }
}

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.
`search`String Filter invoices by PO number, invoice number, worker name, or amount.
`hasPurchaseOrderNumber`Boolean 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.
`invoiceDateRange`DateRangeInput Only show invoices whose invoice date falls within the given date range.
`updatedAtRange`DateTimeRangeInput Only show invoices last changed within the given range. Use this to fetch new invoices and credit notes on a schedule: pass the start of the current run as `to` and the start of the previous run as `from`, moved a few minutes earlier so consecutive runs overlap slightly. Times must include fractional seconds and an offset, e.g. `2026-10-14T05:00:00.000000Z` for 07:00 in Amsterdam summer time. Using UTC (`Z`) is recommended. An invoice is only returned once it is booked and has a number and a PDF, which can happen some time after it was created, so filtering on the last change rather than the creation time catches invoices booked late. Later changes, such as a recorded payment, also update this time, so an invoice that was already fetched can be returned again; deduplicate on the invoice `number`. Results are paged by offset, so a change during a run can shift later pages; if `paginatorInfo.total` drops partway through a run, start again from the first page.
`orderBy`[QueryInvoicesOrderByOrderByClause!] Order the results by the creation date, invoice date, number, total or due date.
`first`Int! Limits number of fetched items.
`page`Int The offset from which items are returned.

Example

query Invoices {
  invoices(accounts: ["abc123"], status: [PAID], transactionTypes: [INVOICE], search: "example", hasPurchaseOrderNumber: true, currency: [AED], externalIdentifiers: ["example"], invoiceDateRange: {
    # DateRangeInput fields
  }, updatedAtRange: {
    # DateTimeRangeInput fields
  }, orderBy: [{
    # QueryInvoicesOrderByOrderByClause fields
  }], first: 10, page: 10) {
    __typename
    # ...plus the fields you need
  }
}

job

Type: Job

Get a specific job.

Arguments
`id`ID! The ID of the job.

Example

query Job {
  job(id: "abc123") {
    __typename
    # ...plus the fields you need
  }
}

jobCandidate

Type: JobCandidate

Get a specific job candidate.

Arguments
`id`ID! The ID of the job candidate.

Example

query JobCandidate {
  jobCandidate(id: "abc123") {
    __typename
    # ...plus the fields you need
  }
}

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.
`preferred`Boolean 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.
`first`Int! Limits number of fetched items.
`page`Int The offset from which items are returned.

Example

query JobCandidates {
  jobCandidates(jobs: ["abc123"], statuses: [ELIGIBLE], steps: [SHORTLISTED], preferred: true, orderBy: [{
    # JobCandidateOrderByClauseInput fields
  }], first: 10, page: 10) {
    __typename
    # ...plus the fields you need
  }
}

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.
`isActive`Boolean Whether the job share is active.
`companies`[ID!] Filter the job shares based on one or more companies.
`orderBy`[JobShareOrderByClauseInput!] Order the job shares by the specified field and direction.
`first`Int! Limits number of fetched items.
`page`Int The offset from which items are returned.

Example

query JobShares {
  jobShares(jobs: ["abc123"], accountTypes: [WORKER], isActive: true, companies: ["abc123"], orderBy: [{
    # JobShareOrderByClauseInput fields
  }], first: 10, page: 10) {
    __typename
    # ...plus the fields you need
  }
}

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.
`search`String 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.
`available`Boolean Only show jobs that are either available or not.
`published`Boolean Only show jobs that are either published or not.
`completed`Boolean Only show jobs that have either been completed or not.
`removed`Boolean Only show jobs that have either been removed or not.
`hasProject`Boolean Filter for jobs with or without project.
`hasHire`Boolean Filter for jobs with or without hires.
`hasBids`Boolean 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.
`createdAtDateRange`DateRangeInput Filter jobs by the date the job was created.
`unfilled`Boolean Filter by unfilled jobs.
`customFields`[CustomFieldTypeValueInput!] Only show jobs with specific custom field values.
`startDateRange`DateRangeInput Only show jobs with start dates within the specified range.
`endDateRange`DateRangeInput Only show jobs with end dates within the specified range.
`isJobPost`Boolean Only show jobs that are job posts.
`statuses`[JobStatus!] Filter the jobs by their status
`first`Int! Limits number of fetched items.
`page`Int The offset from which items are returned.

Example

query Jobs {
  jobs(accounts: ["abc123"], owners: ["abc123"], markets: [US], search: "example", currencies: [AED], rateTypes: [HOURLY], paymentSchemes: [ANY], skills: ["example"], experienceLevel: [STUDENT], associations: [SMALL_TASK], locationPreferences: [ONSITE_ONLY], available: true, published: true, completed: true, removed: true, hasProject: true, hasHire: true, hasBids: true, externalIdentifiers: ["example"], orderBy: [{
    # JobsOrderByClauseInput fields
  }], createdAtDateRange: {
    # DateRangeInput fields
  }, unfilled: true, customFields: [{
    # CustomFieldTypeValueInput fields
  }], startDateRange: {
    # DateRangeInput fields
  }, endDateRange: {
    # DateRangeInput fields
  }, isJobPost: true, statuses: [DRAFT], first: 10, page: 10) {
    __typename
    # ...plus the fields you need
  }
}

milestone

Type: Milestone

Get a single milestone.

Arguments
`id`ID! The ID of the milestone.

Example

query Milestone {
  milestone(id: "abc123") {
    __typename
    # ...plus the fields you need
  }
}

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.
`first`Int! Limits number of fetched items.
`page`Int The offset from which items are returned.

Example

query Milestones {
  milestones(accounts: ["abc123"], hires: ["abc123"], first: 10, page: 10) {
    __typename
    # ...plus the fields you need
  }
}

multiFactor

Type: MultiFactor

Retrieve a specific multi-factor authentication implementation.

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

Example

query MultiFactor {
  multiFactor(id: "abc123") {
    __typename
    # ...plus the fields you need
  }
}

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.
`first`Int! Limits number of fetched items.
`page`Int The offset from which items are returned.

Example

query MultiFactors {
  multiFactors(statuses: [APPROVED], channels: [EMAIL], first: 10, page: 10) {
    __typename
    # ...plus the fields you need
  }
}

organisation

Type: Organisation

Get a specific organisation.

Arguments
`id`ID! The ID of the organisation.

Example

query Organisation {
  organisation(id: "abc123") {
    __typename
    # ...plus the fields you need
  }
}

organisationTrustedContact

Type: TrustedContact

Get a specific organisation trusted contact.

Arguments
`id`ID! The ID of the trusted contact.

Example

query OrganisationTrustedContact {
  organisationTrustedContact(id: "abc123") {
    __typename
    # ...plus the fields you need
  }
}

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.
`search`String 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.
`contactRegions`MarketRegionInput Filter contacts by market and optionally narrow by specific regions.
`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.
`invitedByUsers`InvitedByInput 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.
`origin`TrustedContactOrigin Filter the contacts by their origin. Have they been added or invited
`staffingAgencyStatus`TrustedContactStaffingAgencyStatus Filter contacts by whether they have staffing agency ownership or not.
`managedStatus`TrustedContactManagedStatus Filter contacts by their managed status (worker, staffing agency, or unmanaged).
`hireHistory`HireHistoryFilterInput Filter contacts by whether they have been previously hired or not.
`hireStatus`HireStatusFilterInput 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.
`first`Int! Limits number of fetched items.
`page`Int The offset from which items are returned.

Example

query OrganisationTrustedContacts {
  organisationTrustedContacts(accounts: ["abc123"], workers: ["abc123"], search: "example", skills: ["abc123"], markets: [US], contactRegions: {
    # MarketRegionInput fields
  }, countries: ["example"], states: ["example"], invitedByUsers: {
    # InvitedByInput fields
  }, statuses: [INVITED], origin: INVITED, staffingAgencyStatus: HAS_OWNERSHIP, managedStatus: STAFFING_AGENCY, hireHistory: {
    # HireHistoryFilterInput fields
  }, hireStatus: {
    # HireStatusFilterInput fields
  }, businessSetup: [COMMON], externalIdentifiers: ["example"], customFields: [{
    # CustomFieldTypeValueInput fields
  }], orderBy: [{
    # TrustedContactOrderByClauseInput fields
  }], first: 10, page: 10) {
    __typename
    # ...plus the fields you need
  }
}

partner

Type: Partner

Get a specific partner.

Arguments
`id`ID! The ID of the partner.

Example

query Partner {
  partner(id: "abc123") {
    __typename
    # ...plus the fields you need
  }
}

payItems

Type: PayItemPaginator!

Experimental. Get a list of pay items in the catalogue of the authenticated accounts.

Archived pay items are left out unless includeArchived is true.

Arguments
`accounts`[ID!] Supply which accounts to see pay items for. If no accounts are supplied, then all authenticated accounts will be used.
`includeArchived`Boolean Supply true to include archived pay items.
`first`Int! Limits number of fetched items.
`page`Int The offset from which items are returned.

Example

query PayItems {
  payItems(accounts: ["abc123"], includeArchived: true, first: 10, page: 10) {
    __typename
    # ...plus the fields you need
  }
}

paymentRequest

Type: PaymentRequest

Get a specific payment request.

Arguments
`id`ID! The ID of the payment request.

Example

query PaymentRequest {
  paymentRequest(id: "abc123") {
    __typename
    # ...plus the fields you need
  }
}

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.
`hasPurchaseOrderNumber`Boolean Only show payment requests that have a Purchase Order number.
`hasTimesheet`Boolean 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.
`clients`[ID!] Only show supplier-side payment requests belonging to the given client companies (matched via the hire’s source hire). MSP/supplier view only.
`search`String 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.
`isPayrolled`Boolean 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.
`timesheetPeriod`DateRangeInput 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.
`requestedDateRange`DateRangeInput Only show payment requests requested within the specified date range.
`billingStartDateRange`DateRangeInput Only show payment requests whose billing period start date falls within the specified range.
`billingEndDateRange`DateRangeInput Only show payment requests whose billing period end date falls within the specified range.
`hasExpenses`Boolean Only show payment requests that have expenses (true) or do not have expenses (false).
`hasBatch`Boolean 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.
`viewerRole`PaymentRequestViewerRole Which side of the payment request the viewer is on. Defaults to ANY. Pass PAYER on client-side tables to exclude requests the viewer raised as a supplier. PAYEE is reserved for the supplier-side view. Only filters within the account scope set by the `accounts` arg — without `accounts` there’s nothing for this filter to act on.
`first`Int! Limits number of fetched items.
`page`Int The offset from which items are returned.

Example

query PaymentRequests {
  paymentRequests(accounts: ["abc123"], currencies: [AED], hasPurchaseOrderNumber: true, hasTimesheet: true, jobs: ["abc123"], hires: ["abc123"], hireOwners: ["abc123"], clients: ["abc123"], search: "example", statuses: [APPROVED], requestTypes: [TIME], workerStatuses: [DRAFT], workerPayoutStatuses: [PAID], isPayrolled: true, timesheetPeriod: {
    # DateRangeInput fields
  }, rateTypes: [HOURLY], requestedDateRange: {
    # DateRangeInput fields
  }, billingStartDateRange: {
    # DateRangeInput fields
  }, billingEndDateRange: {
    # DateRangeInput fields
  }, hasExpenses: true, hasBatch: true, batchIds: ["abc123"], externalIdentifiers: ["example"], orderBy: [{
    # PaymentRequestOrderByClauseInput fields
  }], viewerRole: PAYER, first: 10, page: 10) {
    __typename
    # ...plus the fields you need
  }
}

profile

Type: User!

Deprecated

Get the authenticated user that is viewing the API.

Example

query Profile {
  profile {
    __typename
    # ...plus the fields you need
  }
}

project

Type: Project

Get a specific project.

Arguments
`id`ID! The ID of the project to view.

Example

query Project {
  project(id: "abc123") {
    __typename
    # ...plus the fields you need
  }
}

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.
`search`String 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.
`first`Int! Limits number of fetched items.
`page`Int The offset from which items are returned.

Example

query Projects {
  projects(accounts: ["abc123"], search: "example", status: [OPEN], owners: ["abc123"], externalIdentifiers: ["example"], first: 10, page: 10) {
    __typename
    # ...plus the fields you need
  }
}

recruiter

Type: Recruiter

Get a specific recruiter.

Arguments
`id`ID! The ID of the recruiter.

Example

query Recruiter {
  recruiter(id: "abc123") {
    __typename
    # ...plus the fields you need
  }
}

recruiterCandidate

Type: RecruiterCandidate

Get a specific recruiter candidate.

Arguments
`id`ID! The ID of the recruiter candidate.

Example

query RecruiterCandidate {
  recruiterCandidate(id: "abc123") {
    __typename
    # ...plus the fields you need
  }
}

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.
`status`ContactStatus Supply to filter for status.
`search`String Supply an input string which will be used to search through.
`hasPendingActions`Boolean When true, only return candidates with something pending.
`first`Int! Limits number of fetched items.
`page`Int The offset from which items are returned.

Example

query RecruiterCandidates {
  recruiterCandidates(accounts: ["abc123"], status: INVITED, search: "example", hasPendingActions: true, first: 10, page: 10) {
    __typename
    # ...plus the fields you need
  }
}

recruiters

Type: RecruiterPaginator!

Get a list of recruiters.

Arguments
`search`String The search value used to search recruiters.
`first`Int! Limits number of fetched items.
`page`Int The offset from which items are returned.

Example

query Recruiters {
  recruiters(search: "example", first: 10, page: 10) {
    __typename
    # ...plus the fields you need
  }
}

skills

Type: SkillPaginator!

Get a list of skills.

Arguments
`search`String 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.
`first`Int! Limits number of fetched items.
`page`Int The offset from which items are returned.

Example

query Skills {
  skills(search: "example", skillableType: [WORKER], orderBy: [{
    # SkillOrderByClauseInput fields
  }], first: 10, page: 10) {
    __typename
    # ...plus the fields you need
  }
}

staffingAgencyClients

Type: SupplierClientPaginator!

Experimental. The end clients the viewer’s staffing agencies work for: one row per client link, direct or through an MSP.

Arguments
`accounts`[ID!] Only show the clients of these staffing agency accounts. Without it, every staffing agency the viewer belongs to.
`search`String Search clients by company name.
`isDirect`Boolean Only show direct links (true) or links through an MSP (false).
`clientRegions`MarketRegionInput Filter clients by market and optionally narrow by specific regions.
`createdAtDateRange`DateRangeInput Only show links created within the given date range.
`orderBy`[StaffingAgencyClientOrderByClauseInput!] Supply a list of column/order pairs for sorting, applied in the provided order.
`first`Int! Limits number of fetched items.
`page`Int The offset from which items are returned.

Example

query StaffingAgencyClients {
  staffingAgencyClients(accounts: ["abc123"], search: "example", isDirect: true, clientRegions: {
    # MarketRegionInput fields
  }, createdAtDateRange: {
    # DateRangeInput fields
  }, orderBy: [{
    # StaffingAgencyClientOrderByClauseInput fields
  }], first: 10, page: 10) {
    __typename
    # ...plus the fields you need
  }
}

supplierCandidate

Type: SupplierCandidate

Get a specific supplier candidate.

Arguments
`id`ID! The ID of the supplier candidate.

Example

query SupplierCandidate {
  supplierCandidate(id: "abc123") {
    __typename
    # ...plus the fields you need
  }
}

supplierCandidates

Type: SupplierCandidatePaginator!

Get a list of supplier candidates for the authenticated supplier account.

Arguments
`status`ContactStatus Filter by candidate status.
`search`String Search candidates by email, name, or job title.
`first`Int! Limits number of fetched items.
`page`Int The offset from which items are returned.

Example

query SupplierCandidates {
  supplierCandidates(status: INVITED, search: "example", first: 10, page: 10) {
    __typename
    # ...plus the fields you need
  }
}

supplierSharedCustomFields

Type: CustomFieldPaginator!

Get custom fields shared by a supplier with its client companies. Returns only fields where sharedWithClients is true for the given supplier.

Arguments
`supplier`ID! The supplier account whose shared fields to retrieve.
`appliesTo`[TypeSupportingCustomFieldValues!] A list of entity types supporting custom fields.
`first`Int! Limits number of fetched items.
`page`Int The offset from which items are returned.

Example

query SupplierSharedCustomFields {
  supplierSharedCustomFields(supplier: "abc123", appliesTo: [JOB], first: 10, page: 10) {
    __typename
    # ...plus the fields you need
  }
}

timesheet

Type: Timesheet

Get a specific timesheet.

Arguments
`id`ID! The ID of the timesheet.

Example

query Timesheet {
  timesheet(id: "abc123") {
    __typename
    # ...plus the fields you need
  }
}

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.
`first`Int! Limits number of fetched items.
`page`Int The offset from which items are returned.

Example

query Timesheets {
  timesheets(accounts: ["abc123"], first: 10, page: 10) {
    __typename
    # ...plus the fields you need
  }
}

trustedContact

Type: TrustedContact

Get a specific trusted contact.

Arguments
`id`ID! The ID of the trusted contact.

Example

query TrustedContact {
  trustedContact(id: "abc123") {
    __typename
    # ...plus the fields you need
  }
}

trustedContactRegions

Type: [MarketWithRegions!]!

Experimental. The markets of the viewer’s own and organisation-shared trusted contacts, with all of their regions.

Arguments
`accounts`[ID!] Only the trusted contacts of these accounts. Without it, every account the viewer belongs to.

Example

query TrustedContactRegions {
  trustedContactRegions(accounts: ["abc123"]) {
    __typename
    # ...plus the fields you need
  }
}

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.
`search`String 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.
`contactRegions`MarketRegionInput Filter contacts by market and optionally narrow by specific regions.
`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.
`invitedByUsers`InvitedByInput 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.
`origin`TrustedContactOrigin Filter the contacts by their origin. Have they been added or invited.
`staffingAgencyStatus`TrustedContactStaffingAgencyStatus Filter contacts by whether they have staffing agency ownership or not.
`managedStatus`TrustedContactManagedStatus Filter contacts by their managed status (worker, staffing agency, or unmanaged).
`hireHistory`HireHistoryFilterInput Filter contacts by whether they have been previously hired or not.
`hireStatus`HireStatusFilterInput 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.
`createdAtDateRange`DateRangeInput Filter trusted contacts by the date they were created.
`verifiedWorkerReview`VerifiedWorkerReviewFilterInput Filter contacts by their VerifiedWorkerCompliance review state.
`first`Int! Limits number of fetched items.
`page`Int The offset from which items are returned.

Example

query TrustedContacts {
  trustedContacts(accounts: ["abc123"], workers: ["abc123"], search: "example", skills: ["abc123"], markets: [US], contactRegions: {
    # MarketRegionInput fields
  }, countries: ["example"], states: ["example"], invitedByUsers: {
    # InvitedByInput fields
  }, statuses: [INVITED], origin: INVITED, staffingAgencyStatus: HAS_OWNERSHIP, managedStatus: STAFFING_AGENCY, hireHistory: {
    # HireHistoryFilterInput fields
  }, hireStatus: {
    # HireStatusFilterInput fields
  }, businessSetup: [COMMON], externalIdentifiers: ["example"], customFields: [{
    # CustomFieldTypeValueInput fields
  }], orderBy: [{
    # TrustedContactOrderByClauseInput fields
  }], createdAtDateRange: {
    # DateRangeInput fields
  }, verifiedWorkerReview: {
    # VerifiedWorkerReviewFilterInput fields
  }, first: 10, page: 10) {
    __typename
    # ...plus the fields you need
  }
}

userGroup

Type: UserGroup

Get a specific user group.

Arguments
`id`ID! The ID of the group to view.

Example

query UserGroup {
  userGroup(id: "abc123") {
    __typename
    # ...plus the fields you need
  }
}

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.
`search`String Search user groups by name, description and users name, email.
`users`[ID!] Filter user groups by users.
`status`[UserGroupStatus!] Filter user group by status.
`first`Int! Limits number of fetched items.
`page`Int The offset from which items are returned.

Example

query UserGroups {
  userGroups(accounts: ["abc123"], search: "example", users: ["abc123"], status: [ACTIVE], first: 10, page: 10) {
    __typename
    # ...plus the fields you need
  }
}

viewer

Type: User!

Get the authenticated user that is viewing the API.

Example

query Viewer {
  viewer {
    __typename
    # ...plus the fields you need
  }
}

webhook

Type: Webhook

Get a specific webhook.

Arguments
`id`ID! The ID of the webhook.

Example

query Webhook {
  webhook(id: "abc123") {
    __typename
    # ...plus the fields you need
  }
}

webhookEvent

Type: WebhookEvent

Get a specific webhook event.

Arguments
`id`ID! The ID of the webhook event.

Example

query WebhookEvent {
  webhookEvent(id: "abc123") {
    __typename
    # ...plus the fields you need
  }
}

webhookEventLogs

Type: WebhookEventLogPaginator!

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

Arguments
`webhookId`ID Filter the webhook event logs based on the ID of the webhook.
`webhookEventId`ID 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.
`first`Int! Limits number of fetched items.
`page`Int The offset from which items are returned.

Example

query WebhookEventLogs {
  webhookEventLogs(webhookId: "abc123", webhookEventId: "abc123", accounts: ["abc123"], first: 10, page: 10) {
    __typename
    # ...plus the fields you need
  }
}

webhookEvents

Type: WebhookEventPaginator!

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

Arguments
`webhookId`ID Filter the webhook events based on the ID of the webhook.
`first`Int! Limits number of fetched items.
`page`Int The offset from which items are returned.

Example

query WebhookEvents {
  webhookEvents(webhookId: "abc123", first: 10, page: 10) {
    __typename
    # ...plus the fields you need
  }
}

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.
`first`Int! Limits number of fetched items.
`page`Int The offset from which items are returned.

Example

query Webhooks {
  webhooks(accounts: ["abc123"], first: 10, page: 10) {
    __typename
    # ...plus the fields you need
  }
}

worker

Type: Worker

Get a specific worker.

Arguments
`id`ID! The ID of the worker.

Example

query Worker {
  worker(id: "abc123") {
    __typename
    # ...plus the fields you need
  }
}

workflow

Type: Workflow

Get a specific workflow by ID.

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

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

Example

query Workflow {
  workflow(id: "abc123") {
    __typename
    # ...plus the fields you need
  }
}

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).
`appliesTo`ApprovalTrigger! The trigger type to get variables for. Different triggers expose different variables.
`first`Int! Limits number of fetched items.
`page`Int The offset from which items are returned.

Example

query WorkflowVariables {
  workflowVariables(accounts: ["abc123"], appliesTo: NONE, first: 10, page: 10) {
    __typename
    # ...plus the fields you need
  }
}

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.
`first`Int! Limits number of fetched items.
`page`Int The offset from which items are returned.

Example

query Workflows {
  workflows(accounts: ["abc123"], first: 10, page: 10) {
    __typename
    # ...plus the fields you need
  }
}