This article provides guidance for troubleshooting common errors encountered when using the Service Fusion Open API. It focuses on identifying the root cause of API failures and applying the correct resolution based on error type, authentication, or data behavior.
Best Suited for:
- Users troubleshooting API integrations
- Administrators managing API credentials
- Partners diagnosing integration failures
Best Practices for Preventing Errors:
- Validate request payloads before submission
- Monitor token expiration and refresh regularly
- Test integrations in a controlled environment before deployment
- Review API documentation prior to implementing new features
Common Error Types:
500 Server Errors:
A 500 error indicates that the request reached Service Fusion but could not be processed.
Common causes:
- Malformed request body
- Unsupported field combinations
- Incorrect data structure
Resolution steps:
- Verify the request payload matches API documentation
- Confirm required fields are included
- Re‑submit the request after validating formatting
When contacting Support, include:
- Request URL and method
- Request headers (with tokens removed)
- Request body
- Response body and timestamp
- Client ID
401 Unauthorized Errors:
A 401 error indicates an authentication issue.
Common causes:
- Missing access token
- Expired access token
- Incorrect token format
Resolution steps:
- Generate a new access token using your Client ID and Client Secret
- Confirm the token is included in the Authorization: Bearer header
- Verify the token has not expired
403 Forbidden Errors:
A 403 error indicates a permissions issue.
Common causes:
- Account is not on the Pro plan
- Incorrect OAuth grant type used
- Endpoint access restrictions
Resolution steps:
- Confirm the account is on the Pro plan
- Verify the correct authentication method is being used
- Review endpoint permissions in the documentation
Data and Response Issues:
Stale or Delayed Data:
API responses may occasionally return outdated information.
Common causes:
- Temporary caching of expanded resources
- Delay in syncing sub‑resources (e.g., job visits)
Resolution steps:
- Wait a few seconds and re‑query the endpoint
- Confirm whether the delayed field is part of an expanded resource
Null or Missing Data:
Fields may return null values when data is not present.
Common causes:
- Field is not populated in the Service Fusion application
- Field is not supported by the API
Resolution steps:
- Verify the field has data in the Service Fusion UI
- Confirm the field is supported in the API documentation
Pagination Issues:
Incomplete Results:
API responses may return fewer records than expected.
Common causes:
- Default pagination limits
Resolution steps:
- Use the page and per‑page parameters
- Continue requesting additional pages until no results remain
Authentication Issues:
Invalid or Expired Credentials:
Authentication failures can stop integrations from functioning.
Common causes:
- Rotated Client Secret
- Invalid credentials stored in the integration
Resolution steps:
- Verify the Client Secret matches the current value in API Access
- Update credentials in your integration if they have changed
- Regenerate credentials if necessary
Integration Failures After Working Previously:
Unexpected Integration Breaks:
Integrations that previously worked may stop functioning.
Common causes:
- Deprecated API actions
- Credential rotation
- Changes in integration logic
Resolution steps:
- Review API documentation for updated endpoints
- Confirm credentials have not been regenerated
- Validate request structure against current documentation