811spotter GraphQL
The 811spotter API provides access to tickets, jobs, call center accounts and more
API Endpoints
https://api.811spotter.com/graphql
Headers
# Your API token must be included in all API calls.
Authorization: Bearer <YOUR_TOKEN_HERE>
Queries
callCenter
Response
Returns a CallCenter!
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query callCenter($id: ID!) {
callCenter(id: $id) {
anonymousTicketFetching
createdAt
daysWarning
expirationDependentOnActivity
hasExpirationTime
hasRevisions
id
isRemarksDuringRenewals
name
state
supportsAccounts
systemName
ticketUrlTemplate
timezone
updatedAt
}
}
Variables
{"id": 4}
Response
{
"data": {
"callCenter": {
"anonymousTicketFetching": true,
"createdAt": ISO8601DateTime,
"daysWarning": 123,
"expirationDependentOnActivity": true,
"hasExpirationTime": false,
"hasRevisions": true,
"id": "4",
"isRemarksDuringRenewals": false,
"name": "xyz789",
"state": "xyz789",
"supportsAccounts": false,
"systemName": "ARIZONA",
"ticketUrlTemplate": "abc123",
"timezone": "abc123",
"updatedAt": ISO8601DateTime
}
}
}
callCenterAccount
Response
Returns a CallCenterAccount!
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query callCenterAccount($id: ID!) {
callCenterAccount(id: $id) {
active
callCenter {
...CallCenterFragment
}
callCenterId
companyId
createdAt
emails
errorCode
id
status
updatedAt
userId
username
}
}
Variables
{"id": "4"}
Response
{
"data": {
"callCenterAccount": {
"active": true,
"callCenter": CallCenter,
"callCenterId": "4",
"companyId": 4,
"createdAt": ISO8601DateTime,
"emails": ["xyz789"],
"errorCode": "xyz789",
"id": 4,
"status": "VERIFYING_CREDENTIALS",
"updatedAt": ISO8601DateTime,
"userId": "4",
"username": "abc123"
}
}
}
callCenterAccounts
Response
Returns a CallCenterAccountConnection!
Arguments
| Name | Description |
|---|---|
filter - CallCenterAccountsFilterInput
|
|
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. |
Example
Query
query callCenterAccounts(
$filter: CallCenterAccountsFilterInput,
$after: String,
$before: String,
$first: Int,
$last: Int
) {
callCenterAccounts(
filter: $filter,
after: $after,
before: $before,
first: $first,
last: $last
) {
edges {
...CallCenterAccountEdgeFragment
}
nodes {
...CallCenterAccountFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"filter": CallCenterAccountsFilterInput,
"after": "xyz789",
"before": "xyz789",
"first": 123,
"last": 123
}
Response
{
"data": {
"callCenterAccounts": {
"edges": [CallCenterAccountEdge],
"nodes": [CallCenterAccount],
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
callCenters
Response
Returns a CallCenterConnection!
Arguments
| Name | Description |
|---|---|
filter - CallCentersFilterInput
|
|
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. |
Example
Query
query callCenters(
$filter: CallCentersFilterInput,
$after: String,
$before: String,
$first: Int,
$last: Int
) {
callCenters(
filter: $filter,
after: $after,
before: $before,
first: $first,
last: $last
) {
edges {
...CallCenterEdgeFragment
}
nodes {
...CallCenterFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"filter": CallCentersFilterInput,
"after": "xyz789",
"before": "abc123",
"first": 987,
"last": 123
}
Response
{
"data": {
"callCenters": {
"edges": [CallCenterEdge],
"nodes": [CallCenter],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
job
Example
Query
query job($id: ID!) {
job(id: $id) {
address1
address2
city
companyId
createdAt
externalId
id
name
number
numberWithName
office {
...OfficeFragment
}
officeId
phase
state
status
ticketRequiredDatetime
updatedAt
zip
}
}
Variables
{"id": 4}
Response
{
"data": {
"job": {
"address1": "abc123",
"address2": "abc123",
"city": "xyz789",
"companyId": "4",
"createdAt": ISO8601DateTime,
"externalId": "abc123",
"id": "4",
"name": "abc123",
"number": "xyz789",
"numberWithName": "abc123",
"office": Office,
"officeId": "4",
"phase": "NEW",
"state": "abc123",
"status": "CLOSED",
"ticketRequiredDatetime": ISO8601DateTime,
"updatedAt": ISO8601DateTime,
"zip": "abc123"
}
}
}
jobs
Response
Returns a JobConnection!
Arguments
| Name | Description |
|---|---|
filter - JobsFilterInput
|
|
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. |
Example
Query
query jobs(
$filter: JobsFilterInput,
$after: String,
$before: String,
$first: Int,
$last: Int
) {
jobs(
filter: $filter,
after: $after,
before: $before,
first: $first,
last: $last
) {
edges {
...JobEdgeFragment
}
nodes {
...JobFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"filter": JobsFilterInput,
"after": "abc123",
"before": "abc123",
"first": 123,
"last": 987
}
Response
{
"data": {
"jobs": {
"edges": [JobEdge],
"nodes": [Job],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
office
Example
Query
query office($id: ID!) {
office(id: $id) {
addressCity
addressCountry
addressState
addressStreet
addressZip
autoRenewMode
createdAt
defaultUserId
emails
emailsList
id
jobs {
...JobConnectionFragment
}
jobsCount
name
onsiteActivity
ticketsCount
updatedAt
usersCount
}
}
Variables
{"id": "4"}
Response
{
"data": {
"office": {
"addressCity": "abc123",
"addressCountry": "xyz789",
"addressState": "xyz789",
"addressStreet": "xyz789",
"addressZip": "abc123",
"autoRenewMode": "DISABLED",
"createdAt": ISO8601DateTime,
"defaultUserId": "4",
"emails": ["xyz789"],
"emailsList": "abc123",
"id": "4",
"jobs": JobConnection,
"jobsCount": 123,
"name": "abc123",
"onsiteActivity": "DISABLED",
"ticketsCount": 987,
"updatedAt": ISO8601DateTime,
"usersCount": 123
}
}
}
offices
Response
Returns an OfficeConnection!
Arguments
| Name | Description |
|---|---|
filter - OfficesFilterInput
|
|
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. |
Example
Query
query offices(
$filter: OfficesFilterInput,
$after: String,
$before: String,
$first: Int,
$last: Int
) {
offices(
filter: $filter,
after: $after,
before: $before,
first: $first,
last: $last
) {
edges {
...OfficeEdgeFragment
}
nodes {
...OfficeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"filter": OfficesFilterInput,
"after": "abc123",
"before": "abc123",
"first": 987,
"last": 987
}
Response
{
"data": {
"offices": {
"edges": [OfficeEdge],
"nodes": [Office],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
ticket
Response
Returns a Ticket!
Arguments
| Name | Description |
|---|---|
id - ID
|
|
number - String
|
|
callCenter - CallCenterName
|
Example
Query
query ticket(
$id: ID,
$number: String,
$callCenter: CallCenterName
) {
ticket(
id: $id,
number: $number,
callCenter: $callCenter
) {
callCenter {
...CallCenterFragment
}
callCenterAccountId
callCenterId
createdAt
creationDate
expirationDate
id
latestRevision {
...TicketRevisionFragment
}
latestRevisionId
legalStartDate
locationCity
locationCounty
locationCrossStreet1
locationCrossStreet2
locationDescription
locationState
locationStreet
locationSubdivision
locationZip
map
number
remarksByDate
renewalDate
revisions {
...TicketRevisionConnectionFragment
}
startDate
status
ticketChain {
...TicketChainFragment
}
ticketChainId
ticketChainPosition
type
updatedAt
}
}
Variables
{
"id": 4,
"number": "xyz789",
"callCenter": "ARIZONA"
}
Response
{
"data": {
"ticket": {
"callCenter": CallCenter,
"callCenterAccountId": 4,
"callCenterId": "4",
"createdAt": ISO8601DateTime,
"creationDate": ISO8601DateTime,
"expirationDate": ISO8601DateTime,
"id": 4,
"latestRevision": TicketRevision,
"latestRevisionId": 4,
"legalStartDate": ISO8601DateTime,
"locationCity": "abc123",
"locationCounty": "xyz789",
"locationCrossStreet1": "abc123",
"locationCrossStreet2": "abc123",
"locationDescription": "xyz789",
"locationState": "abc123",
"locationStreet": "xyz789",
"locationSubdivision": "abc123",
"locationZip": "xyz789",
"map": {},
"number": "xyz789",
"remarksByDate": ISO8601DateTime,
"renewalDate": ISO8601DateTime,
"revisions": TicketRevisionConnection,
"startDate": ISO8601DateTime,
"status": "ACTIVE",
"ticketChain": TicketChain,
"ticketChainId": 4,
"ticketChainPosition": 987,
"type": "abc123",
"updatedAt": ISO8601DateTime
}
}
}
ticketChain
Response
Returns a TicketChain!
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query ticketChain($id: ID!) {
ticketChain(id: $id) {
callCenterId
createdAt
id
isCompleted
job {
...JobFragment
}
jobId
lastTicket {
...TicketFragment
}
lastTicketId
office {
...OfficeFragment
}
officeId
renewUntilArchived
renewUntilDate
renewalAction
tickets {
...TicketConnectionFragment
}
ticketsCount
updatedAt
userId
}
}
Variables
{"id": "4"}
Response
{
"data": {
"ticketChain": {
"callCenterId": 4,
"createdAt": ISO8601DateTime,
"id": 4,
"isCompleted": true,
"job": Job,
"jobId": "4",
"lastTicket": Ticket,
"lastTicketId": 4,
"office": Office,
"officeId": "4",
"renewUntilArchived": true,
"renewUntilDate": ISO8601DateTime,
"renewalAction": "NA",
"tickets": TicketConnection,
"ticketsCount": 987,
"updatedAt": ISO8601DateTime,
"userId": 4
}
}
}
ticketChains
Response
Returns a TicketChainConnection!
Arguments
| Name | Description |
|---|---|
filter - TicketChainsFilterInput
|
|
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. |
Example
Query
query ticketChains(
$filter: TicketChainsFilterInput,
$after: String,
$before: String,
$first: Int,
$last: Int
) {
ticketChains(
filter: $filter,
after: $after,
before: $before,
first: $first,
last: $last
) {
edges {
...TicketChainEdgeFragment
}
nodes {
...TicketChainFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"filter": TicketChainsFilterInput,
"after": "abc123",
"before": "xyz789",
"first": 987,
"last": 987
}
Response
{
"data": {
"ticketChains": {
"edges": [TicketChainEdge],
"nodes": [TicketChain],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
ticketRevision
Response
Returns a TicketRevision!
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query ticketRevision($id: ID!) {
ticketRevision(id: $id) {
createdAt
creationDate
expirationDate
id
legalStartDate
number
priority
renewalDate
responses {
...TicketRevisionResponseConnectionFragment
}
startDate
ticket {
...TicketFragment
}
ticketId
type
updatedAt
}
}
Variables
{"id": "4"}
Response
{
"data": {
"ticketRevision": {
"createdAt": ISO8601DateTime,
"creationDate": ISO8601DateTime,
"expirationDate": ISO8601DateTime,
"id": 4,
"legalStartDate": ISO8601DateTime,
"number": "xyz789",
"priority": "abc123",
"renewalDate": ISO8601DateTime,
"responses": TicketRevisionResponseConnection,
"startDate": ISO8601DateTime,
"ticket": Ticket,
"ticketId": "4",
"type": "abc123",
"updatedAt": ISO8601DateTime
}
}
}
ticketRevisionResponse
Response
Returns a TicketRevisionResponse!
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query ticketRevisionResponse($id: ID!) {
ticketRevisionResponse(id: $id) {
digStatus
id
isActive
isLatest
marksVisible
member {
...MemberFragment
}
memberId
responseCode {
...ResponseCodeFragment
}
responseCodeId
responseComment
responseDate
responseDescription
responseOverride
responseOverrideAt
responseOverrideCarryForward
responseOverrideKey
ticketRevision {
...TicketRevisionFragment
}
ticketRevisionId
}
}
Variables
{"id": "4"}
Response
{
"data": {
"ticketRevisionResponse": {
"digStatus": "SUCCESS",
"id": "4",
"isActive": true,
"isLatest": true,
"marksVisible": false,
"member": Member,
"memberId": "4",
"responseCode": ResponseCode,
"responseCodeId": 4,
"responseComment": "abc123",
"responseDate": ISO8601DateTime,
"responseDescription": "abc123",
"responseOverride": {},
"responseOverrideAt": ISO8601DateTime,
"responseOverrideCarryForward": false,
"responseOverrideKey": "CLEAR_NO_CONFLICT",
"ticketRevision": TicketRevision,
"ticketRevisionId": 4
}
}
}
ticketRevisionResponses
Response
Returns a TicketRevisionResponseConnection!
Arguments
| Name | Description |
|---|---|
filter - TicketRevisionResponsesFilterInput
|
|
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. |
Example
Query
query ticketRevisionResponses(
$filter: TicketRevisionResponsesFilterInput,
$after: String,
$before: String,
$first: Int,
$last: Int
) {
ticketRevisionResponses(
filter: $filter,
after: $after,
before: $before,
first: $first,
last: $last
) {
edges {
...TicketRevisionResponseEdgeFragment
}
nodes {
...TicketRevisionResponseFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"filter": TicketRevisionResponsesFilterInput,
"after": "xyz789",
"before": "abc123",
"first": 987,
"last": 123
}
Response
{
"data": {
"ticketRevisionResponses": {
"edges": [TicketRevisionResponseEdge],
"nodes": [TicketRevisionResponse],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
ticketRevisions
Response
Returns a TicketRevisionConnection!
Arguments
| Name | Description |
|---|---|
filter - TicketRevisionsFilterInput
|
|
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. |
Example
Query
query ticketRevisions(
$filter: TicketRevisionsFilterInput,
$after: String,
$before: String,
$first: Int,
$last: Int
) {
ticketRevisions(
filter: $filter,
after: $after,
before: $before,
first: $first,
last: $last
) {
edges {
...TicketRevisionEdgeFragment
}
nodes {
...TicketRevisionFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"filter": TicketRevisionsFilterInput,
"after": "xyz789",
"before": "abc123",
"first": 123,
"last": 987
}
Response
{
"data": {
"ticketRevisions": {
"edges": [TicketRevisionEdge],
"nodes": [TicketRevision],
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
tickets
Response
Returns a TicketConnection!
Arguments
| Name | Description |
|---|---|
filter - TicketsFilterInput
|
|
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. |
Example
Query
query tickets(
$filter: TicketsFilterInput,
$after: String,
$before: String,
$first: Int,
$last: Int
) {
tickets(
filter: $filter,
after: $after,
before: $before,
first: $first,
last: $last
) {
edges {
...TicketEdgeFragment
}
nodes {
...TicketFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"filter": TicketsFilterInput,
"after": "abc123",
"before": "abc123",
"first": 123,
"last": 123
}
Response
{
"data": {
"tickets": {
"edges": [TicketEdge],
"nodes": [Ticket],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
Mutations
createJob
Response
Returns a CreateJobPayload
Arguments
| Name | Description |
|---|---|
input - CreateJobInput!
|
Parameters for CreateJob |
Example
Query
mutation createJob($input: CreateJobInput!) {
createJob(input: $input) {
clientMutationId
job {
...JobFragment
}
}
}
Variables
{"input": CreateJobInput}
Response
{
"data": {
"createJob": {
"clientMutationId": "abc123",
"job": Job
}
}
}
deleteJob
Response
Returns a DeleteJobPayload
Arguments
| Name | Description |
|---|---|
input - DeleteJobInput!
|
Parameters for DeleteJob |
Example
Query
mutation deleteJob($input: DeleteJobInput!) {
deleteJob(input: $input) {
clientMutationId
id
}
}
Variables
{"input": DeleteJobInput}
Response
{
"data": {
"deleteJob": {
"clientMutationId": "xyz789",
"id": 4
}
}
}
updateJob
Response
Returns an UpdateJobPayload
Arguments
| Name | Description |
|---|---|
input - UpdateJobInput!
|
Parameters for UpdateJob |
Example
Query
mutation updateJob($input: UpdateJobInput!) {
updateJob(input: $input) {
clientMutationId
job {
...JobFragment
}
}
}
Variables
{"input": UpdateJobInput}
Response
{
"data": {
"updateJob": {
"clientMutationId": "abc123",
"job": Job
}
}
}
Types
AutoRenewMode
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"DISABLED"
Boolean
Description
Represents true or false values.
Example
true
CallCenter
Fields
| Field Name | Description |
|---|---|
anonymousTicketFetching - Boolean!
|
|
createdAt - ISO8601DateTime!
|
|
daysWarning - Int!
|
|
expirationDependentOnActivity - Boolean!
|
|
hasExpirationTime - Boolean!
|
|
hasRevisions - Boolean!
|
|
id - ID!
|
|
isRemarksDuringRenewals - Boolean!
|
|
name - String
|
|
state - String!
|
|
supportsAccounts - Boolean!
|
|
systemName - CallCenterName
|
|
ticketUrlTemplate - String
|
|
timezone - String
|
|
updatedAt - ISO8601DateTime!
|
Example
{
"anonymousTicketFetching": false,
"createdAt": ISO8601DateTime,
"daysWarning": 987,
"expirationDependentOnActivity": false,
"hasExpirationTime": true,
"hasRevisions": false,
"id": 4,
"isRemarksDuringRenewals": true,
"name": "abc123",
"state": "abc123",
"supportsAccounts": false,
"systemName": "ARIZONA",
"ticketUrlTemplate": "xyz789",
"timezone": "abc123",
"updatedAt": ISO8601DateTime
}
CallCenterAccount
Fields
| Field Name | Description |
|---|---|
active - Boolean
|
|
callCenter - CallCenter!
|
|
callCenterId - ID!
|
|
companyId - ID!
|
|
createdAt - ISO8601DateTime!
|
|
emails - [String!]
|
|
errorCode - String
|
|
id - ID!
|
|
status - CallCenterAccountStatus!
|
|
updatedAt - ISO8601DateTime!
|
|
userId - ID
|
|
username - String
|
Example
{
"active": true,
"callCenter": CallCenter,
"callCenterId": 4,
"companyId": "4",
"createdAt": ISO8601DateTime,
"emails": ["xyz789"],
"errorCode": "abc123",
"id": "4",
"status": "VERIFYING_CREDENTIALS",
"updatedAt": ISO8601DateTime,
"userId": "4",
"username": "abc123"
}
CallCenterAccountConnection
Description
The connection type for CallCenterAccount.
Fields
| Field Name | Description |
|---|---|
edges - [CallCenterAccountEdge!]!
|
A list of edges. |
nodes - [CallCenterAccount!]!
|
A list of nodes. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
Total number of items in the connection, ignoring pagination. |
Example
{
"edges": [CallCenterAccountEdge],
"nodes": [CallCenterAccount],
"pageInfo": PageInfo,
"totalCount": 123
}
CallCenterAccountEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
cursor - String!
|
A cursor for use in pagination. |
node - CallCenterAccount
|
The item at the end of the edge. |
Example
{
"cursor": "xyz789",
"node": CallCenterAccount
}
CallCenterAccountStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"VERIFYING_CREDENTIALS"
CallCenterAccountsFilterInput
Fields
| Input Field | Description |
|---|---|
callCenterIdEq - ID
|
|
callCenterIdIn - [ID!]
|
|
userIdEq - ID
|
|
userIdIn - [ID!]
|
|
statusEq - CallCenterAccountStatus
|
|
statusIn - [CallCenterAccountStatus!]
|
|
activeEq - Boolean
|
Example
{
"callCenterIdEq": 4,
"callCenterIdIn": ["4"],
"userIdEq": "4",
"userIdIn": ["4"],
"statusEq": "VERIFYING_CREDENTIALS",
"statusIn": ["VERIFYING_CREDENTIALS"],
"activeEq": true
}
CallCenterConnection
Description
The connection type for CallCenter.
Fields
| Field Name | Description |
|---|---|
edges - [CallCenterEdge!]!
|
A list of edges. |
nodes - [CallCenter!]!
|
A list of nodes. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
Total number of items in the connection, ignoring pagination. |
Example
{
"edges": [CallCenterEdge],
"nodes": [CallCenter],
"pageInfo": PageInfo,
"totalCount": 987
}
CallCenterEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
cursor - String!
|
A cursor for use in pagination. |
node - CallCenter
|
The item at the end of the edge. |
Example
{
"cursor": "abc123",
"node": CallCenter
}
CallCenterName
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ARIZONA"
CallCentersFilterInput
Fields
| Input Field | Description |
|---|---|
systemNameEq - CallCenterName
|
|
systemNameIn - [CallCenterName!]
|
|
stateEq - String
|
|
stateIn - [String!]
|
|
supportsAccountsEq - Boolean
|
Example
{
"systemNameEq": "ARIZONA",
"systemNameIn": ["ARIZONA"],
"stateEq": "xyz789",
"stateIn": ["xyz789"],
"supportsAccountsEq": true
}
CreateJobInput
Description
Autogenerated input type of CreateJob
Example
{
"clientMutationId": "xyz789",
"name": "abc123",
"number": "abc123",
"officeId": "4",
"state": "abc123",
"status": "CLOSED",
"phase": "NEW",
"ticketRequiredDatetime": ISO8601DateTime
}
CreateJobPayload
DeleteJobInput
DeleteJobPayload
DigStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"SUCCESS"
ID
Description
Represents a unique identifier that is Base64 obfuscated. It is often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "VXNlci0xMA==") or integer (such as 4) input value will be accepted as an ID.
Example
"4"
ISO8601DateTime
Description
An ISO 8601-encoded datetime
Example
ISO8601DateTime
Int
Description
Represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
Example
123
JSON
Description
Represents untyped JSON
Example
{}
Job
Fields
| Field Name | Description |
|---|---|
address1 - String
|
|
address2 - String
|
|
city - String
|
|
companyId - ID!
|
|
createdAt - ISO8601DateTime!
|
|
externalId - String
|
|
id - ID!
|
|
name - String
|
|
number - String
|
|
numberWithName - String!
|
|
office - Office!
|
|
officeId - ID!
|
|
phase - JobPhase
|
|
state - String
|
|
status - JobStatus
|
|
ticketRequiredDatetime - ISO8601DateTime
|
|
updatedAt - ISO8601DateTime!
|
|
zip - String
|
Example
{
"address1": "xyz789",
"address2": "abc123",
"city": "xyz789",
"companyId": 4,
"createdAt": ISO8601DateTime,
"externalId": "abc123",
"id": "4",
"name": "abc123",
"number": "abc123",
"numberWithName": "abc123",
"office": Office,
"officeId": 4,
"phase": "NEW",
"state": "xyz789",
"status": "CLOSED",
"ticketRequiredDatetime": ISO8601DateTime,
"updatedAt": ISO8601DateTime,
"zip": "abc123"
}
JobConnection
Description
The connection type for Job.
Fields
| Field Name | Description |
|---|---|
edges - [JobEdge!]!
|
A list of edges. |
nodes - [Job!]!
|
A list of nodes. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
Total number of items in the connection, ignoring pagination. |
Example
{
"edges": [JobEdge],
"nodes": [Job],
"pageInfo": PageInfo,
"totalCount": 123
}
JobEdge
JobPhase
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"NEW"
JobStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"CLOSED"
JobsFilterInput
Fields
| Input Field | Description |
|---|---|
officeIdEq - ID
|
|
officeIdIn - [ID!]
|
|
statusEq - JobStatus
|
|
statusIn - [JobStatus!]
|
|
phaseEq - JobPhase
|
|
phaseIn - [JobPhase!]
|
Example
{
"officeIdEq": 4,
"officeIdIn": [4],
"statusEq": "CLOSED",
"statusIn": ["CLOSED"],
"phaseEq": "NEW",
"phaseIn": ["NEW"]
}
Member
Fields
| Field Name | Description |
|---|---|
callCenterId - ID!
|
|
code - String
|
|
description - String
|
|
id - ID!
|
|
type - String
|
|
uniformColorCode - UniformColorCode
|
|
uniformColorCodes - [UniformColorCode!]!
|
Example
{
"callCenterId": "4",
"code": "abc123",
"description": "xyz789",
"id": 4,
"type": "abc123",
"uniformColorCode": "UNKNOWN",
"uniformColorCodes": ["UNKNOWN"]
}
Office
Fields
| Field Name | Description |
|---|---|
addressCity - String
|
|
addressCountry - String
|
|
addressState - String
|
|
addressStreet - String
|
|
addressZip - String
|
|
autoRenewMode - AutoRenewMode
|
|
createdAt - ISO8601DateTime!
|
|
defaultUserId - ID
|
|
emails - [String!]!
|
|
emailsList - String
|
|
id - ID!
|
|
jobs - JobConnection!
|
|
jobsCount - Int!
|
|
name - String!
|
|
onsiteActivity - OnsiteActivity
|
|
ticketsCount - Int!
|
|
updatedAt - ISO8601DateTime!
|
|
usersCount - Int!
|
|
Example
{
"addressCity": "xyz789",
"addressCountry": "abc123",
"addressState": "xyz789",
"addressStreet": "abc123",
"addressZip": "xyz789",
"autoRenewMode": "DISABLED",
"createdAt": ISO8601DateTime,
"defaultUserId": "4",
"emails": ["xyz789"],
"emailsList": "xyz789",
"id": "4",
"jobs": JobConnection,
"jobsCount": 123,
"name": "xyz789",
"onsiteActivity": "DISABLED",
"ticketsCount": 987,
"updatedAt": ISO8601DateTime,
"usersCount": 987
}
OfficeConnection
Description
The connection type for Office.
Fields
| Field Name | Description |
|---|---|
edges - [OfficeEdge!]!
|
A list of edges. |
nodes - [Office!]!
|
A list of nodes. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
Total number of items in the connection, ignoring pagination. |
Example
{
"edges": [OfficeEdge],
"nodes": [Office],
"pageInfo": PageInfo,
"totalCount": 123
}
OfficeEdge
OfficesFilterInput
Fields
| Input Field | Description |
|---|---|
idEq - ID
|
|
idIn - [ID!]
|
|
nameEq - String
|
|
nameIn - [String!]
|
|
defaultUserIdEq - ID
|
|
defaultUserIdIn - [ID!]
|
|
autoRenewModeEq - AutoRenewMode
|
|
autoRenewModeIn - [AutoRenewMode!]
|
|
onsiteActivityEq - OnsiteActivity
|
|
onsiteActivityIn - [OnsiteActivity!]
|
Example
{
"idEq": "4",
"idIn": ["4"],
"nameEq": "xyz789",
"nameIn": ["xyz789"],
"defaultUserIdEq": "4",
"defaultUserIdIn": ["4"],
"autoRenewModeEq": "DISABLED",
"autoRenewModeIn": ["DISABLED"],
"onsiteActivityEq": "DISABLED",
"onsiteActivityIn": ["DISABLED"]
}
OnsiteActivity
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"DISABLED"
PageInfo
Description
Information about pagination in a connection.
Fields
| Field Name | Description |
|---|---|
endCursor - String
|
When paginating forwards, the cursor to continue. |
hasNextPage - Boolean!
|
When paginating forwards, are there more items? |
hasPreviousPage - Boolean!
|
When paginating backwards, are there more items? |
startCursor - String
|
When paginating backwards, the cursor to continue. |
Example
{
"endCursor": "xyz789",
"hasNextPage": true,
"hasPreviousPage": false,
"startCursor": "xyz789"
}
ResponseCode
Example
{
"description": "abc123",
"digStatus": "SUCCESS",
"group": "CA_NV_NORFIELD_AND_CA_PELICAN_AND_CA_DIGALERT",
"hasMarkings": 987,
"id": "4",
"isNonResponse": false,
"number": "xyz789"
}
ResponseCodeGroup
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"CA_NV_NORFIELD_AND_CA_PELICAN_AND_CA_DIGALERT"
ResponseOverrideKey
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"CLEAR_NO_CONFLICT"
String
Description
Represents textual data as UTF-8 character sequences. This type is most often used by GraphQL to represent free-form human-readable text.
Example
"xyz789"
Ticket
Fields
| Field Name | Description |
|---|---|
callCenter - CallCenter!
|
|
callCenterAccountId - ID
|
|
callCenterId - ID!
|
|
createdAt - ISO8601DateTime!
|
|
creationDate - ISO8601DateTime
|
|
expirationDate - ISO8601DateTime
|
|
id - ID!
|
|
latestRevision - TicketRevision
|
|
latestRevisionId - ID
|
|
legalStartDate - ISO8601DateTime
|
|
locationCity - String
|
|
locationCounty - String
|
|
locationCrossStreet1 - String
|
|
locationCrossStreet2 - String
|
|
locationDescription - String
|
|
locationState - String
|
|
locationStreet - String
|
|
locationSubdivision - String
|
|
locationZip - String
|
|
map - JSON
|
|
number - String!
|
|
remarksByDate - ISO8601DateTime
|
|
renewalDate - ISO8601DateTime
|
|
revisions - TicketRevisionConnection!
|
|
startDate - ISO8601DateTime
|
|
status - TicketStatus
|
|
ticketChain - TicketChain!
|
|
ticketChainId - ID!
|
|
ticketChainPosition - Int!
|
|
type - String
|
|
updatedAt - ISO8601DateTime!
|
|
Example
{
"callCenter": CallCenter,
"callCenterAccountId": 4,
"callCenterId": 4,
"createdAt": ISO8601DateTime,
"creationDate": ISO8601DateTime,
"expirationDate": ISO8601DateTime,
"id": "4",
"latestRevision": TicketRevision,
"latestRevisionId": 4,
"legalStartDate": ISO8601DateTime,
"locationCity": "abc123",
"locationCounty": "abc123",
"locationCrossStreet1": "xyz789",
"locationCrossStreet2": "xyz789",
"locationDescription": "abc123",
"locationState": "abc123",
"locationStreet": "xyz789",
"locationSubdivision": "xyz789",
"locationZip": "abc123",
"map": {},
"number": "xyz789",
"remarksByDate": ISO8601DateTime,
"renewalDate": ISO8601DateTime,
"revisions": TicketRevisionConnection,
"startDate": ISO8601DateTime,
"status": "ACTIVE",
"ticketChain": TicketChain,
"ticketChainId": "4",
"ticketChainPosition": 987,
"type": "xyz789",
"updatedAt": ISO8601DateTime
}
TicketChain
Fields
| Field Name | Description |
|---|---|
callCenterId - ID!
|
|
createdAt - ISO8601DateTime!
|
|
id - ID!
|
|
isCompleted - Boolean
|
|
job - Job
|
|
jobId - ID
|
|
lastTicket - Ticket
|
|
lastTicketId - ID
|
|
office - Office!
|
|
officeId - ID!
|
|
renewUntilArchived - Boolean
|
|
renewUntilDate - ISO8601DateTime
|
|
renewalAction - TicketChainRenewalAction!
|
|
tickets - TicketConnection!
|
|
ticketsCount - Int!
|
|
updatedAt - ISO8601DateTime!
|
|
userId - ID!
|
|
Example
{
"callCenterId": "4",
"createdAt": ISO8601DateTime,
"id": "4",
"isCompleted": false,
"job": Job,
"jobId": "4",
"lastTicket": Ticket,
"lastTicketId": "4",
"office": Office,
"officeId": 4,
"renewUntilArchived": false,
"renewUntilDate": ISO8601DateTime,
"renewalAction": "NA",
"tickets": TicketConnection,
"ticketsCount": 123,
"updatedAt": ISO8601DateTime,
"userId": 4
}
TicketChainConnection
Description
The connection type for TicketChain.
Fields
| Field Name | Description |
|---|---|
edges - [TicketChainEdge!]!
|
A list of edges. |
nodes - [TicketChain!]!
|
A list of nodes. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
Total number of items in the connection, ignoring pagination. |
Example
{
"edges": [TicketChainEdge],
"nodes": [TicketChain],
"pageInfo": PageInfo,
"totalCount": 987
}
TicketChainEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
cursor - String!
|
A cursor for use in pagination. |
node - TicketChain
|
The item at the end of the edge. |
Example
{
"cursor": "abc123",
"node": TicketChain
}
TicketChainRenewalAction
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NA"
TicketChainsFilterInput
Fields
| Input Field | Description |
|---|---|
idEq - ID
|
|
idIn - [ID!]
|
|
officeIdEq - ID
|
|
officeIdIn - [ID!]
|
|
userIdEq - ID
|
|
userIdIn - [ID!]
|
|
jobIdEq - ID
|
|
jobIdIn - [ID!]
|
|
callCenterIdEq - ID
|
|
callCenterIdIn - [ID!]
|
|
lastTicketIdEq - ID
|
|
lastTicketIdIn - [ID!]
|
|
renewalActionEq - TicketChainRenewalAction
|
|
renewalActionIn - [TicketChainRenewalAction!]
|
|
isCompletedEq - Boolean
|
|
renewUntilDateGte - ISO8601DateTime
|
|
renewUntilDateLte - ISO8601DateTime
|
Example
{
"idEq": "4",
"idIn": ["4"],
"officeIdEq": "4",
"officeIdIn": ["4"],
"userIdEq": 4,
"userIdIn": ["4"],
"jobIdEq": 4,
"jobIdIn": [4],
"callCenterIdEq": 4,
"callCenterIdIn": ["4"],
"lastTicketIdEq": 4,
"lastTicketIdIn": [4],
"renewalActionEq": "NA",
"renewalActionIn": ["NA"],
"isCompletedEq": true,
"renewUntilDateGte": ISO8601DateTime,
"renewUntilDateLte": ISO8601DateTime
}
TicketConnection
Description
The connection type for Ticket.
Fields
| Field Name | Description |
|---|---|
edges - [TicketEdge!]!
|
A list of edges. |
nodes - [Ticket!]!
|
A list of nodes. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
Total number of items in the connection, ignoring pagination. |
Example
{
"edges": [TicketEdge],
"nodes": [Ticket],
"pageInfo": PageInfo,
"totalCount": 987
}
TicketEdge
TicketRevision
Fields
| Field Name | Description |
|---|---|
createdAt - ISO8601DateTime!
|
|
creationDate - ISO8601DateTime
|
|
expirationDate - ISO8601DateTime
|
|
id - ID!
|
|
legalStartDate - ISO8601DateTime
|
|
number - String
|
|
priority - String
|
|
renewalDate - ISO8601DateTime
|
|
responses - TicketRevisionResponseConnection!
|
|
startDate - ISO8601DateTime
|
|
ticket - Ticket!
|
|
ticketId - ID!
|
|
type - String
|
|
updatedAt - ISO8601DateTime!
|
|
Example
{
"createdAt": ISO8601DateTime,
"creationDate": ISO8601DateTime,
"expirationDate": ISO8601DateTime,
"id": "4",
"legalStartDate": ISO8601DateTime,
"number": "xyz789",
"priority": "abc123",
"renewalDate": ISO8601DateTime,
"responses": TicketRevisionResponseConnection,
"startDate": ISO8601DateTime,
"ticket": Ticket,
"ticketId": "4",
"type": "abc123",
"updatedAt": ISO8601DateTime
}
TicketRevisionConnection
Description
The connection type for TicketRevision.
Fields
| Field Name | Description |
|---|---|
edges - [TicketRevisionEdge!]!
|
A list of edges. |
nodes - [TicketRevision!]!
|
A list of nodes. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
Total number of items in the connection, ignoring pagination. |
Example
{
"edges": [TicketRevisionEdge],
"nodes": [TicketRevision],
"pageInfo": PageInfo,
"totalCount": 123
}
TicketRevisionEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
cursor - String!
|
A cursor for use in pagination. |
node - TicketRevision
|
The item at the end of the edge. |
Example
{
"cursor": "abc123",
"node": TicketRevision
}
TicketRevisionResponse
Fields
| Field Name | Description |
|---|---|
digStatus - DigStatus
|
|
id - ID!
|
|
isActive - Boolean!
|
|
isLatest - Boolean!
|
|
marksVisible - Boolean
|
|
member - Member!
|
|
memberId - ID!
|
|
responseCode - ResponseCode
|
|
responseCodeId - ID
|
|
responseComment - String
|
|
responseDate - ISO8601DateTime
|
|
responseDescription - String
|
|
responseOverride - JSON
|
|
responseOverrideAt - ISO8601DateTime
|
|
responseOverrideCarryForward - Boolean!
|
|
responseOverrideKey - ResponseOverrideKey
|
|
ticketRevision - TicketRevision!
|
|
ticketRevisionId - ID!
|
Example
{
"digStatus": "SUCCESS",
"id": "4",
"isActive": true,
"isLatest": true,
"marksVisible": false,
"member": Member,
"memberId": 4,
"responseCode": ResponseCode,
"responseCodeId": "4",
"responseComment": "xyz789",
"responseDate": ISO8601DateTime,
"responseDescription": "xyz789",
"responseOverride": {},
"responseOverrideAt": ISO8601DateTime,
"responseOverrideCarryForward": true,
"responseOverrideKey": "CLEAR_NO_CONFLICT",
"ticketRevision": TicketRevision,
"ticketRevisionId": 4
}
TicketRevisionResponseConnection
Description
The connection type for TicketRevisionResponse.
Fields
| Field Name | Description |
|---|---|
edges - [TicketRevisionResponseEdge!]!
|
A list of edges. |
nodes - [TicketRevisionResponse!]!
|
A list of nodes. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
Total number of items in the connection, ignoring pagination. |
Example
{
"edges": [TicketRevisionResponseEdge],
"nodes": [TicketRevisionResponse],
"pageInfo": PageInfo,
"totalCount": 987
}
TicketRevisionResponseEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
cursor - String!
|
A cursor for use in pagination. |
node - TicketRevisionResponse
|
The item at the end of the edge. |
Example
{
"cursor": "abc123",
"node": TicketRevisionResponse
}
TicketRevisionResponsesFilterInput
Example
{
"idEq": 4,
"idIn": ["4"],
"ticketRevisionIdEq": "4",
"ticketRevisionIdIn": ["4"],
"memberIdEq": 4,
"memberIdIn": [4],
"responseCodeIdEq": "4",
"responseCodeIdIn": [4],
"responseDateGte": ISO8601DateTime,
"responseDateLte": ISO8601DateTime,
"isActiveEq": false,
"isLatestEq": true
}
TicketRevisionsFilterInput
Fields
| Input Field | Description |
|---|---|
idEq - ID
|
|
idIn - [ID!]
|
|
ticketIdEq - ID
|
|
ticketIdIn - [ID!]
|
|
numberEq - String
|
|
numberIn - [String!]
|
|
typeEq - String
|
|
typeIn - [String!]
|
|
creationDateGte - ISO8601DateTime
|
|
creationDateLte - ISO8601DateTime
|
|
legalStartDateGte - ISO8601DateTime
|
|
legalStartDateLte - ISO8601DateTime
|
|
expirationDateGte - ISO8601DateTime
|
|
expirationDateLte - ISO8601DateTime
|
Example
{
"idEq": 4,
"idIn": ["4"],
"ticketIdEq": "4",
"ticketIdIn": [4],
"numberEq": "abc123",
"numberIn": ["abc123"],
"typeEq": "xyz789",
"typeIn": ["xyz789"],
"creationDateGte": ISO8601DateTime,
"creationDateLte": ISO8601DateTime,
"legalStartDateGte": ISO8601DateTime,
"legalStartDateLte": ISO8601DateTime,
"expirationDateGte": ISO8601DateTime,
"expirationDateLte": ISO8601DateTime
}
TicketStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"ACTIVE"
TicketsFilterInput
Fields
| Input Field | Description |
|---|---|
idEq - ID
|
|
idIn - [ID!]
|
|
ticketChainIdEq - ID
|
|
ticketChainIdIn - [ID!]
|
|
numberEq - String
|
|
numberIn - [String!]
|
|
statusEq - TicketStatus
|
|
statusIn - [TicketStatus!]
|
|
typeEq - String
|
|
typeIn - [String!]
|
|
callCenterIdEq - ID
|
|
callCenterIdIn - [ID!]
|
|
callCenterAccountIdEq - ID
|
|
callCenterAccountIdIn - [ID!]
|
|
latestRevisionIdEq - ID
|
|
latestRevisionIdIn - [ID!]
|
|
creationDateGte - ISO8601DateTime
|
|
creationDateLte - ISO8601DateTime
|
|
legalStartDateGte - ISO8601DateTime
|
|
legalStartDateLte - ISO8601DateTime
|
|
expirationDateGte - ISO8601DateTime
|
|
expirationDateLte - ISO8601DateTime
|
Example
{
"idEq": "4",
"idIn": ["4"],
"ticketChainIdEq": "4",
"ticketChainIdIn": [4],
"numberEq": "xyz789",
"numberIn": ["abc123"],
"statusEq": "ACTIVE",
"statusIn": ["ACTIVE"],
"typeEq": "xyz789",
"typeIn": ["abc123"],
"callCenterIdEq": 4,
"callCenterIdIn": ["4"],
"callCenterAccountIdEq": "4",
"callCenterAccountIdIn": ["4"],
"latestRevisionIdEq": 4,
"latestRevisionIdIn": [4],
"creationDateGte": ISO8601DateTime,
"creationDateLte": ISO8601DateTime,
"legalStartDateGte": ISO8601DateTime,
"legalStartDateLte": ISO8601DateTime,
"expirationDateGte": ISO8601DateTime,
"expirationDateLte": ISO8601DateTime
}
UniformColorCode
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"UNKNOWN"
UpdateJobInput
Description
Autogenerated input type of UpdateJob
Example
{
"clientMutationId": "xyz789",
"id": "4",
"name": "abc123",
"number": "xyz789",
"officeId": 4,
"state": "xyz789",
"status": "CLOSED",
"phase": "NEW",
"ticketRequiredDatetime": ISO8601DateTime
}