Attention: SAP Field Service Management documentation is now available at the SAP Help Portal. On 31 December 2020, docs.coresystems will no longer be available. Until that time, documentation will NOT be updated in docs.coresystems.


The SAP FSM API is an easy, yet powerful mechanism which provides full access to the data stored on the coresuite Cloud. Data is represented in form of more than 100 domain objects. The API is based on RESTful approach for web services and uses JSON format for object representation.

The access to the data is restricted by authentication and authorization mechanism which ensures that the data can be accessed by authorized persons only. On top of that all communications between the API client and API server is encoded with SSL.

  • Introduction

    This section provides an overview of all sections contained in the API documentation.

  • Reference

    This section includes example requests.

  • Integration Guidelines

    This section includes real world use cases involving connectors.

  • OAuth 2.0 API

    This section details the Oauth 2.0 API..

  • Query API

    This section details how to write queries against the API.

  • Reporting API

    This section covers the Reporting API.

  • Data Model

    This section explores the Data Model and constituent Data Transfer Objects (DTOs) in detail.

  • User API

    This section covers the User API, which is independent from the Data API and Query API.


    A nodejs-based SDK that can be used to integrate with FSM.

  • Additional SDK resources

    Additional NodeJS SDK resources for FSM integration.

  • Streaming API

    This section details the Streaming API, which can be used by third-party applications to receive notificatons regarding the creation, update, and deletion of Service Calls and Activities

  • Service API v2

    This section details the Service API v2, which enables customers with external systems to make requests from a third-party application to SAP Field Service Management, where they can be planned and released to technicians.

  • Bulk API

    This section details the Bulk API, which is an extension of the Data API v4 used to create/update and delete resources in bulk.

  • Rating API

    This section details the Rating API, which enabled customers with external systems to create and manage user records and user access rights for SAP FSM applications.

  • Best Matching Technician API

    This section details the Best Matching Technician API, which enables customers to automatically find the best matching technician for an activity/service call.

  • Re-Optimization API

    This section details the Re-Optimization API, which can be used to asynchronously reschedule assigned jobs in an autonomous and optimized manner.

  • Error Codes

    This section covers all API error codes in detail.