Query

Every GraphQL schema has a root type for both queries and mutations. The query type defines GraphQL operations that retrieve data from the server.

Connections

apiKeys (APIKeyConnection!)

Returns all API tokens for company

Argument Type Description
after String

Returns the elements in the list that come after the specified cursor.

before String

Returns the elements in the list that come before the specified cursor.

company ID
first Int

Returns the first n elements from the list.

last Int

Returns the last n elements from the list.

companies (CompanyConnection!)

Find Companies

Argument Type Description
active Boolean
after String

Returns the elements in the list that come after the specified cursor.

before String

Returns the elements in the list that come before the specified cursor.

demo Boolean
first Int

Returns the first n elements from the list.

industry String
last Int

Returns the last n elements from the list.

name String
orderBy CompanyOrder

The default value is {"field"=>"NAME", "direction"=>"ASC"}.

planLevel [CompanyPlanLevel!]
productPlan [String!]
contacts (ContactConnection!)

Find Contacts

Argument Type Description
after String

Returns the elements in the list that come after the specified cursor.

before String

Returns the elements in the list that come before the specified cursor.

company [ID!]
first Int

Returns the first n elements from the list.

last Int

Returns the last n elements from the list.

name String
orderBy ContactOrder

The default value is {"field"=>"CREATED_AT", "direction"=>"DESC"}.

customers (CustomerConnection!)

Find Customers

Argument Type Description
after String

Returns the elements in the list that come after the specified cursor.

before String

Returns the elements in the list that come before the specified cursor.

company [ID!]
externalId String
first Int

Returns the first n elements from the list.

last Int

Returns the last n elements from the list.

name String
orderBy CustomerOrder

The default value is {"field"=>"CREATED_AT", "direction"=>"DESC"}.

departments (DepartmentConnection!)

Find Departments

Argument Type Description
after String

Returns the elements in the list that come after the specified cursor.

before String

Returns the elements in the list that come before the specified cursor.

company [ID!]
first Int

Returns the first n elements from the list.

label String
last Int

Returns the last n elements from the list.

orderBy DepartmentOrder

The default value is {"field"=>"LABEL", "direction"=>"ASC"}.

drafts (DraftConnection!)

Find Drafts

Argument Type Description
after String

Returns the elements in the list that come after the specified cursor.

before String

Returns the elements in the list that come before the specified cursor.

company [ID!]
damage Boolean
deleted Boolean
department [ID]
eventType [InspectionEvent!]
first Int

Returns the first n elements from the list.

formJson String
last Int

Returns the last n elements from the list.

location [ID!]
notationJson String
orderBy DraftOrder

The default value is {"field"=>"CREATED_AT", "direction"=>"DESC"}.

refSearch String
reference [String!]
region [ID!]
search String
since ISO8601DateTime
unit [ID!]
until ISO8601DateTime
updatedSince ISO8601DateTime
updatedUntil ISO8601DateTime
user [ID!]
workflowFilter [String]
workflowName String
emailTemplates (EmailTemplateConnection!)

Find Email Templates

Argument Type Description
after String

Returns the elements in the list that come after the specified cursor.

before String

Returns the elements in the list that come before the specified cursor.

company [ID!]
first Int

Returns the first n elements from the list.

last Int

Returns the last n elements from the list.

locale [String!]
name String
orderBy EmailTemplateOrder

The default value is {"field"=>"NAME", "direction"=>"ASC"}.

search String
subject String
type [EmailTemplateType!]
formTemplates (FormTemplateConnection!)

Find Form Templates

Argument Type Description
after String

Returns the elements in the list that come after the specified cursor.

before String

Returns the elements in the list that come before the specified cursor.

company [ID!]
first Int

Returns the first n elements from the list.

last Int

Returns the last n elements from the list.

name String
orderBy FormTemplateOrder

The default value is {"field"=>"NAME", "direction"=>"ASC"}.

inspections (InspectionConnection!)

Find Inspections

Argument Type Description
after String

Returns the elements in the list that come after the specified cursor.

before String

Returns the elements in the list that come before the specified cursor.

company [ID!]
damage Boolean
deleted Boolean
department [ID]
draft Boolean

The default value is false.

eventType [InspectionEvent!]
first Int

Returns the first n elements from the list.

formJson String
last Int

Returns the last n elements from the list.

location [ID!]
notationJson String
orderBy InspectionOrder

The default value is {"field"=>"CREATED_AT", "direction"=>"DESC"}.

refSearch String
reference [String!]
region [ID!]
search String
since ISO8601DateTime
unit [ID!]
until ISO8601DateTime
updatedSince ISO8601DateTime
updatedUntil ISO8601DateTime
user [ID!]
workflowFilter [String]
workflowName String
locations (LocationConnection!)

Find Locations

Argument Type Description
active Boolean

The default value is true.

activeCompany Boolean
activeRegion Boolean

The default value is true.

after String

Returns the elements in the list that come after the specified cursor.

before String

Returns the elements in the list that come before the specified cursor.

company [ID!]
first Int

Returns the first n elements from the list.

last Int

Returns the last n elements from the list.

name String
orderBy LocationOrder

The default value is {"field"=>"NAME", "direction"=>"ASC"}.

region [ID!]
search String
messageTemplates (MessageTemplateConnection!)

Return message templates with body populated from work order

Argument Type Description
after String

Returns the elements in the list that come after the specified cursor.

before String

Returns the elements in the list that come before the specified cursor.

first Int

Returns the first n elements from the list.

last Int

Returns the last n elements from the list.

status [String]
workOrder ID
regions (RegionConnection!)

Find Regions

Argument Type Description
active Boolean

The default value is true.

after String

Returns the elements in the list that come after the specified cursor.

before String

Returns the elements in the list that come before the specified cursor.

company [ID!]
first Int

Returns the first n elements from the list.

last Int

Returns the last n elements from the list.

name String
orderBy RegionOrder

The default value is {"field"=>"NAME", "direction"=>"ASC"}.

tasks (TaskConnection!)

Find all Tasks

Argument Type Description
after String

Returns the elements in the list that come after the specified cursor.

assignee [ID!]
before String

Returns the elements in the list that come before the specified cursor.

company [ID!]
dueSince ISO8601DateTime
dueUntil ISO8601DateTime
externalId String
first Int

Returns the first n elements from the list.

last Int

Returns the last n elements from the list.

location [ID!]
name String
orderBy TaskOrder

The default value is {"field"=>"CREATED_AT", "direction"=>"DESC"}.

priority [Int!]
search String
since ISO8601DateTime
status [TaskStatus!]
type String
unit [ID!]
until ISO8601DateTime
units (UnitConnection!)

Find Units

Argument Type Description
after String

Returns the elements in the list that come after the specified cursor.

before String

Returns the elements in the list that come before the specified cursor.

category [String!]
company [ID!]
condition [String!]
damage Boolean
externalId String
externalIdEquals String
first Int

Returns the first n elements from the list.

hours NumericRange
inspectedSince ISO8601DateTime
inspectedUntil ISO8601DateTime
last Int

Returns the last n elements from the list.

lastInspectionEvent [InspectionEvent!]
listPrice NumericRange
location [ID!]
make [String!]
model [String!]
offerPrice NumericRange
orderBy UnitOrder

The default value is {"field"=>"CREATED_AT", "direction"=>"DESC"}.

refSearch String
region [ID!]
salesStatus [UnitSalesStatus!]
search String
since ISO8601DateTime
status [UnitStatus!]
until ISO8601DateTime
year NumericRange
users (UserConnection!)

Find Users

Argument Type Description
active Boolean

The default value is true.

after String

Returns the elements in the list that come after the specified cursor.

before String

Returns the elements in the list that come before the specified cursor.

company [ID!]
email String
externalId String
first Int

Returns the first n elements from the list.

firstName String
fullName String
last Int

Returns the last n elements from the list.

lastName String
location [ID!]
name String
oneTimeUser Boolean

The default value is false.

orderBy UserOrder

The default value is {"field"=>"NAME", "direction"=>"ASC"}.

phoneNumber String
region [ID!]
role [UserRole!]
search String
workOrders (WorkOrderConnection!)

Find WorkOrders

Argument Type Description
after String

Returns the elements in the list that come after the specified cursor.

before String

Returns the elements in the list that come before the specified cursor.

company [ID!]
contact [ID!]
contactSearch String
customer [ID!]
customerSearch String
first Int

Returns the first n elements from the list.

last Int

Returns the last n elements from the list.

lastContactedSince ISO8601DateTime
lastContactedUntil ISO8601DateTime
location [ID!]
make [String!]
model [String!]
orderBy WorkOrderOrder

The default value is {"field"=>"CREATED_AT", "direction"=>"DESC"}.

search String
serviceManager [ID!]
serviceType [String!]
since ISO8601DateTime
status [String!]
tech [ID!]
unit [ID]
until ISO8601DateTime
updatedSince ISO8601DateTime
updatedUntil ISO8601DateTime
woNumber String

Fields

acuantReport (AnalyticsAcuantReport!)
Argument Type Description
companyId ID
orderBy OrderDirection
since ISO8601DateTime

The default value is 2024-04-28T19:03:34Z.

until ISO8601DateTime

The default value is 2025-04-28T19:03:34+00:00.

analyticsByDate (AnalyticsByDate!)
Argument Type Description
period Int!

Days ago (integer)

analyticsByLocation (AnalyticsByLocation!)
Argument Type Description
period Int!

Days ago (integer)

analyticsByUsage (AnalyticsByUsage!)
Argument Type Description
period Int!

Days ago (integer)

analyticsByUser (AnalyticsByUser!)
Argument Type Description
period Int!

Days ago (integer)

analyticsTotals (AnalyticsInspectionTotals!)
Argument Type Description
period Int!

Days ago (integer)

apiKeyCount (Int!)

Returns all API tokens for company

Argument Type Description
company ID
billingProducts ([String!]!)

Returns all plan levels on Chargify

company (Company!)

Find a Company by ID

Argument Type Description
id ID!
contact (Contact!)

Find a Contact by ID

Argument Type Description
id ID!
customer (Customer!)

Find a Customer by ID

Argument Type Description
id ID!
defaultEmailTemplate (EmailTemplate!)

Find a Email Template by ID

Argument Type Description
locale String
type EmailTemplateType!
department (Department!)

Find a Department by ID

Argument Type Description
id ID!
draft (Draft!)

Find a single Draft by ID

Argument Type Description
id ID!
draftCounts (InspectionCounts!)
Argument Type Description
company [ID!]
damage Boolean
deleted Boolean
department [ID]
eventType [InspectionEvent!]
formJson String
location [ID!]
notationJson String
refSearch String
reference [String!]
region [ID!]
search String
since ISO8601DateTime
unit [ID!]
until ISO8601DateTime
updatedSince ISO8601DateTime
updatedUntil ISO8601DateTime
user [ID!]
workflowFilter [String]
workflowName String
emailTemplate (EmailTemplate!)

Find a Email Template by ID

Argument Type Description
id ID!
employeeUsage (AnalyticsEmployeeUsage!)
Argument Type Description
companyId ID
orderBy OrderDirection
since ISO8601DateTime

The default value is 2024-04-28T19:03:34Z.

until ISO8601DateTime

The default value is 2025-04-28T19:03:34+00:00.

envelope (EsignEnvelope!)

Find an Envelope by ID

Argument Type Description
id ID!
esignSignature (EsignSignature!)

Find a Signature by ID

Argument Type Description
id ID!
estimatesByLocation (AnalyticsServiceEstimates!)
Argument Type Description
period Int!

Days ago (integer)

formTemplate (FormTemplate!)

Find a Form Template by ID

Argument Type Description
id ID!
industries ([String!]!)

Returns all company industries

inspection (Inspection)

Find a single Inspection by ID

Argument Type Description
id ID
nonce String
inspectionCounts (InspectionCounts!)
Argument Type Description
company [ID!]
damage Boolean
deleted Boolean
department [ID]
eventType [InspectionEvent!]
formJson String
location [ID!]
notationJson String
refSearch String
reference [String!]
region [ID!]
search String
since ISO8601DateTime
unit [ID!]
until ISO8601DateTime
updatedSince ISO8601DateTime
updatedUntil ISO8601DateTime
user [ID!]
workflowFilter [String]
workflowName String
inspectionFormNames ([String!]!)
Argument Type Description
company [ID!]
damage Boolean
deleted Boolean
department [ID]
eventType [InspectionEvent!]
formJson String
location [ID!]
notationJson String
refSearch String
reference [String!]
region [ID!]
search String
since ISO8601DateTime
unit [ID!]
until ISO8601DateTime
updatedSince ISO8601DateTime
updatedUntil ISO8601DateTime
user [ID!]
workflowFilter [String]
workflowName String
location (Location!)

Find a Location by ID

Argument Type Description
id ID!
messageTemplate (MessageTemplate!)

Return message template

Argument Type Description
id ID
workOrder ID
publishedUnitKey (String)

Allows for syncing published unit data

Argument Type Description
id ID

Unit ID

region (Region!)

Find a Region by ID

Argument Type Description
id ID!
salesStatuses ([String!]!)

Returns all sales statuses

serviceEmployees (AnalyticsServiceEmployees!)
Argument Type Description
period Int!

Days ago (integer)

serviceLocations (AnalyticsServiceLocations!)
Argument Type Description
period Int!

Days ago (integer)

serviceTotals (AnalyticsServiceTotals!)
Argument Type Description
period Int!

Days ago (integer)

serviceTypes ([String!]!)

Returns valid service types - 'Shop' and 'Field'

task (Task!)

Find a Task

Argument Type Description
id ID

Search by ID

taskCounts (TaskCounts!)
Argument Type Description
assignee [ID!]
company [ID!]
dueSince ISO8601DateTime
dueUntil ISO8601DateTime
externalId String
location [ID!]
name String
priority [Int!]
search String
since ISO8601DateTime
status [TaskStatus!]
type String
unit [ID!]
until ISO8601DateTime
techs (JSON!)

Returns all techs in hash format: { tech_id: TECH_NAME, }

transaction (Transaction!)

Find a single Transaction by ID

Argument Type Description
id ID!
unit (Unit!)

Find a Unit

Argument Type Description
externalId String

Search by domain-specific identifier

id ID

Search by ID

unitCategories ([String!]!)

Returns all unit categories

unitCounts (UnitCounts!)
Argument Type Description
category [String!]
company [ID!]
condition [String!]
damage Boolean
externalId String
externalIdEquals String
hours NumericRange
inspectedSince ISO8601DateTime
inspectedUntil ISO8601DateTime
lastInspectionEvent [InspectionEvent!]
listPrice NumericRange
location [ID!]
make [String!]
model [String!]
offerPrice NumericRange
refSearch String
region [ID!]
salesStatus [UnitSalesStatus!]
search String
since ISO8601DateTime
status [UnitStatus!]
until ISO8601DateTime
year NumericRange
unitMail (UnitMail!)

Find a single UnitMail by ID

Argument Type Description
id ID!
unitMailImport (IntegrationsUnitMailImport!)

Find a UnitMailImport Integration by ID

Argument Type Description
id ID!
unitMakes ([String!]!)

Returns all unit makes

unitModels ([String!]!)

Returns all unit models

unitStatuses ([String!]!)

Returns all unit statuses

user (User!)

Find a single User

Argument Type Description
externalId String

Search by domain-specific identifier

id ID

Search by ID

userCounts (UserCounts!)
Argument Type Description
active Boolean

The default value is true.

company [ID!]
email String
externalId String
firstName String
fullName String
lastName String
location [ID!]
name String
oneTimeUser Boolean

The default value is false.

phoneNumber String
region [ID!]
role [UserRole!]
search String
userJob (UserJob!)

Find a user job

Argument Type Description
id ID!
workOrder (WorkOrder!)

Find a WorkOrder by ID

Argument Type Description
id ID!
workOrderCounts (WorkOrderCounts!)
Argument Type Description
company [ID!]
contact [ID!]
contactSearch String
customer [ID!]
customerSearch String
lastContactedSince ISO8601DateTime
lastContactedUntil ISO8601DateTime
location [ID!]
make [String!]
model [String!]
search String
serviceManager [ID!]
serviceType [String!]
since ISO8601DateTime
status [String!]
tech [ID!]
unit [ID]
until ISO8601DateTime
updatedSince ISO8601DateTime
updatedUntil ISO8601DateTime
woNumber String
workflow (Workflow!)

Find a Workflow by ID

Argument Type Description
id ID!