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
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. |
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 |
planLevel |
[CompanyPlanLevel!]
|
|
productPlan |
[String!]
|
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 |
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 |
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 |
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 |
refSearch |
String
|
|
reference |
[String!]
|
|
region |
[ID!]
|
|
search |
String
|
|
since |
ISO8601DateTime
|
|
unit |
[ID!]
|
|
until |
ISO8601DateTime
|
|
updatedSince |
ISO8601DateTime
|
|
updatedUntil |
ISO8601DateTime
|
|
user |
[ID!]
|
|
workflowFilter |
[String]
|
|
workflowName |
String
|
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 |
search |
String
|
|
subject |
String
|
|
type |
[EmailTemplateType!]
|
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 |
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 |
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 |
refSearch |
String
|
|
reference |
[String!]
|
|
region |
[ID!]
|
|
search |
String
|
|
since |
ISO8601DateTime
|
|
unit |
[ID!]
|
|
until |
ISO8601DateTime
|
|
updatedSince |
ISO8601DateTime
|
|
updatedUntil |
ISO8601DateTime
|
|
user |
[ID!]
|
|
workflowFilter |
[String]
|
|
workflowName |
String
|
LocationConnection!
)
Find Locations
Argument | Type | Description |
---|---|---|
active |
Boolean
|
The default value is |
activeCompany |
Boolean
|
|
activeRegion |
Boolean
|
The default value is |
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 |
region |
[ID!]
|
|
search |
String
|
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
|
RegionConnection!
)
Find Regions
Argument | Type | Description |
---|---|---|
active |
Boolean
|
The default value is |
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 |
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 |
priority |
[Int!]
|
|
search |
String
|
|
since |
ISO8601DateTime
|
|
status |
[TaskStatus!]
|
|
type |
String
|
|
unit |
[ID!]
|
|
until |
ISO8601DateTime
|
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 |
refSearch |
String
|
|
region |
[ID!]
|
|
salesStatus |
[UnitSalesStatus!]
|
|
search |
String
|
|
since |
ISO8601DateTime
|
|
status |
[UnitStatus!]
|
|
until |
ISO8601DateTime
|
|
year |
NumericRange
|
UserConnection!
)
Find Users
Argument | Type | Description |
---|---|---|
active |
Boolean
|
The default value is |
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 |
orderBy |
UserOrder
|
The default value is |
phoneNumber |
String
|
|
region |
[ID!]
|
|
role |
[UserRole!]
|
|
search |
String
|
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 |
search |
String
|
|
serviceManager |
[ID!]
|
|
serviceType |
[String!]
|
|
since |
ISO8601DateTime
|
|
status |
[String!]
|
|
tech |
[ID!]
|
|
unit |
[ID]
|
|
until |
ISO8601DateTime
|
|
updatedSince |
ISO8601DateTime
|
|
updatedUntil |
ISO8601DateTime
|
|
woNumber |
String
|
Fields
AnalyticsAcuantReport!
)
Argument | Type | Description |
---|---|---|
companyId |
ID
|
|
orderBy |
OrderDirection
|
|
since |
ISO8601DateTime
|
The default value is |
until |
ISO8601DateTime
|
The default value is |
AnalyticsByDate!
)
Argument | Type | Description |
---|---|---|
period |
Int!
|
Days ago (integer) |
AnalyticsByLocation!
)
Argument | Type | Description |
---|---|---|
period |
Int!
|
Days ago (integer) |
AnalyticsByUsage!
)
Argument | Type | Description |
---|---|---|
period |
Int!
|
Days ago (integer) |
AnalyticsByUser!
)
Argument | Type | Description |
---|---|---|
period |
Int!
|
Days ago (integer) |
AnalyticsInspectionTotals!
)
Argument | Type | Description |
---|---|---|
period |
Int!
|
Days ago (integer) |
[String!]!
)
Returns all plan levels on Chargify
EmailTemplate!
)
Find a Email Template by ID
Argument | Type | Description |
---|---|---|
locale |
String
|
|
type |
EmailTemplateType!
|
Department!
)
Find a Department by ID
Argument | Type | Description |
---|---|---|
id |
ID!
|
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!
)
Find a Email Template by ID
Argument | Type | Description |
---|---|---|
id |
ID!
|
AnalyticsEmployeeUsage!
)
Argument | Type | Description |
---|---|---|
companyId |
ID
|
|
orderBy |
OrderDirection
|
|
since |
ISO8601DateTime
|
The default value is |
until |
ISO8601DateTime
|
The default value is |
EsignEnvelope!
)
Find an Envelope by ID
Argument | Type | Description |
---|---|---|
id |
ID!
|
EsignSignature!
)
Find a Signature by ID
Argument | Type | Description |
---|---|---|
id |
ID!
|
AnalyticsServiceEstimates!
)
Argument | Type | Description |
---|---|---|
period |
Int!
|
Days ago (integer) |
FormTemplate!
)
Find a Form Template by ID
Argument | Type | Description |
---|---|---|
id |
ID!
|
[String!]!
)
Returns all company industries
Inspection
)
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
|
[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
|
MessageTemplate!
)
String
)
Allows for syncing published unit data
Argument | Type | Description |
---|---|---|
id |
ID
|
Unit ID |
[String!]!
)
Returns all sales statuses
AnalyticsServiceEmployees!
)
Argument | Type | Description |
---|---|---|
period |
Int!
|
Days ago (integer) |
AnalyticsServiceLocations!
)
Argument | Type | Description |
---|---|---|
period |
Int!
|
Days ago (integer) |
AnalyticsServiceTotals!
)
Argument | Type | Description |
---|---|---|
period |
Int!
|
Days ago (integer) |
[String!]!
)
Returns valid service types - 'Shop' and 'Field'
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
|
JSON!
)
Returns all techs in hash format: { tech_id: TECH_NAME, }
Transaction!
)
Find a single Transaction by ID
Argument | Type | Description |
---|---|---|
id |
ID!
|
Unit!
)
[String!]!
)
Returns all unit categories
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
|
IntegrationsUnitMailImport!
)
Find a UnitMailImport Integration by ID
Argument | Type | Description |
---|---|---|
id |
ID!
|
[String!]!
)
Returns all unit makes
[String!]!
)
Returns all unit models
[String!]!
)
Returns all unit statuses
User!
)
UserCounts!
)
WorkOrder!
)
Find a WorkOrder by ID
Argument | Type | Description |
---|---|---|
id |
ID!
|
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
|