Oracle Field Service Cloud

Supergood | Oracle Field Service Cloud API

Alex Klarfeld

Alex Klarfeld

— 6 min read
Supergood | Oracle Field Service Cloud API

Programmatically access Oracle Field Service Cloud scheduling, activities, routing, and capacity with a stable REST API. Supergood builds and operates production-grade, unofficial Oracle Field Service Cloud integrations so your team can automate field operations without heavy custom engineering.

Plain English: Oracle Field Service Cloud is field service management software used by utilities, telecommunications providers, manufacturers, and home services companies to plan, schedule, route, and execute technician work. An unofficial API lets you programmatically pull and update activities (work orders), appointments, technician resources, daily routes, capacity and time slots, parts usage, status events, and attachments.

For a tech company integrating with Oracle Field Service Cloud, this means you can ingest real-time job and route data to power dispatch dashboards, offer in-app appointment booking with capacity checks, sync completed work to ERP/CRM (e.g., NetSuite, Salesforce), automate status changes from your product, push parts/materials consumption, and keep mobile and back-office systems aligned.

What is Oracle Field Service Cloud?

Oracle Field Service Cloud (OFSC) is a cloud platform for managing end-to-end field service operations. It focuses on time-based, predictive routing and capacity planning to ensure the right technician is scheduled with the right skills at the right time. Teams use OFSC to create and dispatch activities, optimize routes, communicate with customers, capture on-site outcomes, and measure field performance.

Core product areas include:

  • Scheduling & Dispatch (activities, appointments, buckets/territories)
  • Capacity & Forecasting (time slots, quotas, work types)
  • Routing & Optimization (time-based predictive routing, travel estimates)
  • Mobile Workforce (status transitions, forms, signatures, photos)
  • Resources & Skills (technicians, calendars, shifts, work skills)
  • Inventory & Parts (consumption, returns, transfers)
  • Customer Communications (notifications, ETAs, appointment confirmations)

Common data entities:

  • Activities/Work Orders (metadata, time windows, status lifecycle)
  • Resources/Technicians (skills, calendars, shifts, home locations)
  • Buckets/Territories and Work Zones
  • Capacity Time Slots and Work Types
  • Routes and Sequenced Activity Lists
  • Customers and Service Locations
  • Status Events (dispatched, en_route, arrived, started, completed, cancelled)
  • Attachments, Photos, and Signatures
  • Inventory Items and Parts Usage

The Oracle Field Service Cloud Integration Challenge

Field service organizations rely on OFSC daily, but turning portal-based workflows into API-driven automation can be challenging:

  • Complex scheduling constructs: buckets, territories, skills, time windows, and quotas shape what can be booked
  • Enterprise security: SSO, MFA, and strict role-based controls complicate headless automation
  • Mobile-first operations: status transitions, photos, and signatures originate from technician devices
  • Routing dynamics: predictive routing updates ETAs and sequences during the day
  • Data fragmentation: capacity, routing, and activity details live across multiple views and exports

How Supergood Creates Oracle Field Service Cloud APIs

Supergood reverse-engineers authenticated browser flows and network interactions to deliver a resilient API endpoint layer for your Oracle Field Service Cloud tenant.

  • Handles username/password, SSO/OAuth, and MFA (SMS, email, TOTP) securely
  • Maintains session continuity with automated refresh and change detection
  • Normalizes responses so you can integrate once and rely on consistent objects across modules
  • Aligns with customer entitlements and role-based permissions to ensure compliant access
  • Respects OFSC status lifecycle and routing constraints to avoid scheduling conflicts

Use Cases

Activity and Appointment Sync

  • Mirror activities, customers, and addresses into your internal systems
  • Keep appointment windows, statuses, and assigned resources current for analytics and dispatch
  • Normalize time zones and timestamps for multi-region operations

Scheduling and Capacity Automation

  • Offer in-app booking with capacity checks and required skills
  • Create activities automatically from orders, tickets, or IoT signals
  • Enforce time windows and route-friendly durations to improve on-time arrival

Route and Location Intelligence

  • Ingest daily routes per technician with travel estimates and ETAs
  • Update location pings to power live maps and customer ETAs
  • Detect route deviations and trigger alerts or re-optimization

Field Execution and Parts

  • Push status changes (dispatched, en_route, arrived, completed)
  • Record parts consumption and serials from your product
  • Upload photos, documents, and signatures to activities

Available Endpoints

Authentication

POST /sessions: Establish a session using credentials. Supergood manages MFA (SMS, email, TOTP) and SSO/OAuth when enabled. Returns a short-lived auth token maintained by the platform.

curl --request POST \
  --url https://api.supergood.ai/integrations/<integration_id>/sessions \
  --header 'Authorization: Basic <Base64 encoded token>' \
  --header 'Content-Type: application/json' \
  --data '{
    "username": "[email protected]",
    "password": "<password>",
    "mfa": { "type": "totp", "code": "123456" }
  }'

Example response

{
  "authToken": "eyJhbGciOi...",
  "expiresIn": 3600,
  "user": {
    "id": "u_2ab97f",
    "name": "Dispatch Supervisor",
    "entitlements": ["activities", "resources", "capacity", "routing"]
  }
}

POST /sessions/refresh: Refresh an existing token to keep sessions uninterrupted.

Activities

GET /activities: List activities with filters and summary details.

Query parameters

  • resourceId: string
  • bucketId: string
  • status: open | scheduled | en_route | arrived | started | completed | cancelled
  • dateFrom, dateTo: ISO 8601 timestamps for scheduled window
  • workTypeId: string
  • customerPhone: string
  • page, pageSize: integers for pagination

Example response

{
  "items": [
    {
      "activityId": "act_9f31c2",
      "activityType": "installation",
      "workOrderNumber": "WO-2026-0142",
      "status": "scheduled",
      "customer": {
        "name": "Alicia Gomez",
        "phone": "+1-404-555-0174"
      },
      "address": {
        "line1": "2450 Peachtree Rd NE",
        "city": "Atlanta",
        "region": "GA",
        "postalCode": "30305",
        "country": "US"
      },
      "coordinates": { "lat": 33.8161, "lng": -84.3723 },
      "timeWindowStart": "2026-02-01T14:00:00Z",
      "timeWindowEnd": "2026-02-01T16:00:00Z",
      "estimatedDurationMinutes": 90,
      "resourceId": "res_5810c1",
      "requiredSkills": ["fiber_install"],
      "createdAt": "2026-01-22T09:15:12Z",
      "updatedAt": "2026-01-23T08:02:45Z"
    }
  ],
  "page": 1,
  "pageSize": 50,
  "total": 1
}

Create Activity

POST /activities: Create a new activity (work order) with customer and scheduling metadata.

curl --request POST \
  --url https://api.supergood.ai/integrations/<integration_id>/activities \
  --header 'Authorization: Bearer <authToken>' \
  --header 'Content-Type: application/json' \
  --data '{
    "activityType": "repair",
    "workOrderNumber": "WO-2026-0201",
    "customer": {
      "name": "Greenway Cafe",
      "phone": "+1-415-555-0138"
    },
    "address": {
      "line1": "1447 Mission St",
      "city": "San Francisco",
      "region": "CA",
      "postalCode": "94103",
      "country": "US"
    },
    "timeWindowStart": "2026-02-03T17:00:00Z",
    "timeWindowEnd": "2026-02-03T19:00:00Z",
    "estimatedDurationMinutes": 120,
    "requiredSkills": ["hvac_repair"],
    "preferredResourceId": "res_34af8d",
    "notes": "Unit intermittently shutting down; customer reports error code E17.",
    "externalRefId": "ticket-8942"
  }'

Example response

{
  "activityId": "act_21b77d",
  "status": "scheduled",
  "resourceId": "res_34af8d",
  "createdAt": "2026-01-23T12:41:09Z"
}

Activity Status

PATCH /activities/{activityId}/status: Update an activity lifecycle status and capture on-site details.

curl --request PATCH \
  --url https://api.supergood.ai/integrations/<integration_id>/activities/act_21b77d/status \
  --header 'Authorization: Bearer <authToken>' \
  --header 'Content-Type: application/json' \
  --data '{
    "status": "completed",
    "timestamp": "2026-02-03T18:42:00Z",
    "location": { "lat": 37.7739, "lng": -122.4212 },
    "laborMinutes": 95,
    "resolutionCode": "repaired",
    "partsUsed": [
      { "partNumber": "HVAC-CAP-45uF", "quantity": 1, "serialNumber": "SN-45U-0042" }
    ],
    "attachments": [
      { "fileName": "unit_photo.jpg", "uploadToken": "upl_d8f12a" },
      { "fileName": "customer_signature.png", "uploadToken": "upl_71b903" }
    ],
    "notes": "Replaced capacitor; unit running within spec; advised annual maintenance."
  }'

Example response

{
  "activityId": "act_21b77d",
  "status": "completed",
  "completedAt": "2026-02-03T18:42:00Z",
  "updatedAt": "2026-02-03T18:42:10Z"
}

Routes

GET /routes/{date}: Fetch the sequenced route for a resource on a given date, including planned times and travel estimates.

Query parameters

  • resourceId: string (required)
  • includeETA: boolean
curl --request GET \
  --url "https://api.supergood.ai/integrations/<integration_id>/routes/2026-02-03?resourceId=res_34af8d&includeETA=true" \
  --header 'Authorization: Bearer <authToken>'

Example response

{
  "resourceId": "res_34af8d",
  "date": "2026-02-03",
  "items": [
    {
      "sequence": 1,
      "activityId": "act_19ea90",
      "plannedStart": "2026-02-03T16:00:00Z",
      "plannedEnd": "2026-02-03T17:30:00Z",
      "status": "completed",
      "travelDistanceKm": 6.2,
      "travelTimeMinutes": 18,
      "eta": null
    },
    {
      "sequence": 2,
      "activityId": "act_21b77d",
      "plannedStart": "2026-02-03T17:00:00Z",
      "plannedEnd": "2026-02-03T19:00:00Z",
      "status": "completed",
      "travelDistanceKm": 3.9,
      "travelTimeMinutes": 12,
      "eta": "2026-02-03T17:08:00Z"
    }
  ],
  "updatedAt": "2026-02-03T15:35:22Z"
}

Get full API Specs →

Technical Specifications

  • Authentication: Username/password with MFA (SMS, email, TOTP) and SSO/OAuth where enabled; supports service accounts or customer-managed credentials
  • Response format: JSON with consistent resource schemas and pagination across modules
  • Rate limits: Tuned for enterprise throughput while honoring customer entitlements and usage controls
  • Session management: Automatic reauth and cookie/session rotation with health checks
  • Data freshness: Near real-time retrieval of activities, capacity, routes, and resource objects
  • Security: Encrypted transport, scoped tokens, and audit logging; respects Oracle role-based permissions
  • Webhooks: Optional asynchronous delivery for long-running workflows (e.g., re-optimization events, completion approvals)

Performance Characteristics

  • Latency: Sub-second responses for list/detail queries under normal load
  • Throughput: Designed for high-volume activity sync and route retrieval
  • Reliability: Retry logic, backoff, and idempotency keys minimize duplicate actions
  • Adaptation: Continuous monitoring for UI/API changes with rapid adapter updates

Getting Started

  1. Schedule Integration Assessment

Book a 30-minute session to confirm your modules, licensing, and authentication model.

  1. Supergood Builds and Validates Your API

We deliver a hardened Oracle Field Service Cloud adapter tailored to your workflows and entitlements.

  1. Deploy with Monitoring

Go live with continuous monitoring and automatic adjustments as Oracle evolves.

Schedule Integration Call →

Frequently Asked Questions

Q: Which Oracle Field Service Cloud modules can this integration cover?

Supergood supports workflows across commonly used areas such as Activities (work orders), Scheduling/Capacity (time slots, quotas), Routing, Resources/Technicians (skills, calendars), and Inventory/Parts usage, subject to your licensing and entitlements. We scope coverage during integration assessment.

Q: How are MFA and SSO handled for automation?

We support username/password + MFA (SMS, email, TOTP) and can operate behind SSO/OAuth when enabled. Sessions are refreshed automatically with secure challenge handling.

Q: Can you book appointments and push schedules from our product?

Yes. We can perform capacity checks, create activities with time windows and required skills, and assign them to resources or buckets while complying with routing and quota constraints.

Q: Do you support attachments, photos, and signatures from mobile?

Yes. We support downloading activity artifacts and uploading attachments via signed uploads, with checksum validation and time-limited URLs.

Ready to automate your Oracle Field Service Cloud workflows?

Supergood can have your Oracle Field Service Cloud integration live in days with no ongoing engineering maintenance.

Get Started →

Read more