GraphQL API Reference

Job Fields

Key fields on the Job type. Use the playground to explore the complete schema.

Resolve — Lazy-loaded Fields

For performance, the users, locations, and discounts fields on jobs are not populated by default. Querying them without resolve always returns null. Pass the field names you want populated in the resolve array:

// Variables:
{
  "resolve": ["users", "locations", "discounts"]
}

// Query:
query ($resolve: [String]) {
  jobs(resolve: $resolve) {
    jobs {
      users {
        user {
          givenName
          familyName
          email
          phone
        }
        role
      }
      locations {
        location {
          addressLineOne
          city
          countryJurisdiction
          areaCode
          coordinates { latitude longitude }
        }
        locationType
      }
    }
  }
}

Updating Jobs

The updateJobs mutation accepts an array of update inputs — you can update multiple jobs in one request. The only required field is jobId.

mutation ($updateJobs: [UpdateJobInput]) {
  updateJobs(updateJobs: $updateJobs) {
    isSuccess
  }
}

// Variables:
{
  "updateJobs": [
    {
      "jobId": "7af1bc10-e356-11ef-8bf8-7dd6e69e92c7",
      "stage": "booking",
      "timeline": "2026-09-15"
    }
  ]
}

Adding and removing users

{
  "updateJobs": [
    {
      "jobId": "7af1bc10-...",
      "addUsers": [
        { "userId": "user-uuid", "role": "customer" }
      ],
      "removeUsers": ["other-user-uuid"]
    }
  ]
}

Adding and removing locations

{
  "updateJobs": [
    {
      "jobId": "7af1bc10-...",
      "addLocations": [
        {
          "locationId": "location-uuid",
          "locationType": "start"   // "start" | "end" | "dock"
        }
      ],
      "removeLocations": ["other-location-uuid"]
    }
  ]
}

Calendar Events

Calendar events represent appointments, moves, estimates, and invoiceable service windows. Many operations (charges, invoices) require an event ID. Events have a type and a status lifecycle.

Create an event

mutation ($calendarEvents: [createCalendarEventInput]!) {
  createCalendarEvent(calendarEvents: $calendarEvents) {
    events { id }
  }
}

// Variables:
{
  "calendarEvents": [
    {
      "title": "Move day",
      "type": "move",
      "jobId": "7af1bc10-...",
      "status": "required",
      "start": 1756396800,    // Unix timestamp (seconds)
      "end": 1756411200
    }
  ]
}

Update an event (mark as completed, set times)

mutation ($edit: editCalendarEventInput!, $ids: [String!]) {
  editCalendarEvent(edit: $edit, ids: $ids)
}

// Variables:
{
  "ids": ["event-uuid"],
  "edit": {
    "status": "completed",
    "start": 1756396800,
    "end": 1756411200
  }
}

Remove an event

mutation ($ids: [String!]!) {
  removeCalendarEvent(ids: $ids)
}

// Variables:
{ "ids": ["event-uuid"] }

Transactions

Transactions represent payments, refunds, and deposits. Before creating a transaction, query the available payment types on the zone.

Step 1 — Query payment types

query {
  getConfigValues(keys: ["payment-type.*"]) {
    id
    value   // JSON string containing name, enabled, etc.
  }
}

Step 2 — Create a transaction

mutation ($amount: Int!, $customerId: String!, $jobId: String!,
         $invoiceId: String, $type: TransactionType!,
         $paymentTypeId: String!, $stage: TransactionStage,
         $metadata: Metadata, $disableSendReceipt: Boolean) {
  createTransaction(
    amount: $amount
    customerId: $customerId
    jobId: $jobId
    invoiceId: $invoiceId
    type: $type
    paymentTypeId: $paymentTypeId
    stage: $stage
    metadata: $metadata
    disableSendReceipt: $disableSendReceipt
  ) {
    transaction { id }
  }
}

// Variables:
{
  "amount": 35000,                          // in cents = $350.00
  "jobId": "7af1bc10-...",
  "customerId": "customer-user-uuid",
  "invoiceId": "invoice-uuid",              // required for "payment" and "refund"
  "type": "payment",                        // "payment" | "refund" | "deposit"
  "stage": "paid",
  "paymentTypeId": "payment-type-config-id",
  "disableSendReceipt": false,
  "metadata": { "origin": "my-integration" }
}