SAP SuccessFactors

SAP SuccessFactors is a cloud-based human capital management (HCM) suite that covers core HR, payroll, talent management, learning, recruiting, performance, and workforce analytics for enterprises. The SuccessFactors HXM Suite OData APIs (v2 and v4) provide CRUD access to Employee Central, Recruiting, Onboarding, Learning, and other HCM modules using OAuth 2.0 or HTTP Basic authentication.

2 APIs 0 Features

HCMHRHuman ResourcesTalent ManagementPayrollEnterpriseSAP

APIs

SAP SuccessFactors OData V4 API

OData V4 REST API for HXM Suite providing CRUD access to Employee Central, talent management, learning, and platform entities. Authentication uses OAuth 2.0 SAML bearer assertio...

SAP SuccessFactors OData V2 API

OData V2 REST API for HXM Suite covering Employee Central, Recruiting, Onboarding, Compensation, Learning, and platform foundation objects. Authentication uses OAuth 2.0 or HTTP...

Collections

SAP SuccessFactors HXM Suite OData API

OPEN

Resources

👥

GitHubOrganization

Sources

opencollection: 1.0.0
info:
  name: SAP SuccessFactors HXM Suite OData API
  version: v2
request:
  auth:
    type: oauth2
    flow: client_credentials
    accessTokenUrl: https://api.successfactors.com/oauth/token
    credentials:
      clientId: '{{clientId}}'
      clientSecret: '{{clientSecret}}'
items:
- info:
    name: Exchange a SAML assertion for an OAuth 2.0 access token
    type: http
  http:
    method: POST
    url: https://{apiServer}/odata/v2/oauth/token
    body:
      type: form-urlencoded
      data:
      - name: grant_type
        value: ''
      - name: assertion
        value: ''
      - name: client_id
        value: ''
      - name: company_id
        value: ''
      - name: user_id
        value: ''
      - name: new_token
        value: ''
  docs: 'Issues an OAuth 2.0 access token using the SAML 2.0 bearer

    assertion flow against the SuccessFactors tenant.

    '
- info:
    name: List users
    type: http
  http:
    method: GET
    url: https://{apiServer}/odata/v2/User
    params:
    - name: $select
      value: ''
      type: query
    - name: $filter
      value: ''
      type: query
    - name: $top
      value: ''
      type: query
    - name: $skip
      value: ''
      type: query
    - name: $format
      value: ''
      type: query
  docs: List users
- info:
    name: Get a user
    type: http
  http:
    method: GET
    url: https://{apiServer}/odata/v2/User(':userId')
    params:
    - name: userId
      value: ''
      type: path
    - name: $select
      value: ''
      type: query
    - name: $format
      value: ''
      type: query
  docs: Get a user
- info:
    name: List Employee Central persons
    type: http
  http:
    method: GET
    url: https://{apiServer}/odata/v2/PerPerson
    params:
    - name: $select
      value: ''
      type: query
    - name: $filter
      value: ''
      type: query
    - name: $top
      value: ''
      type: query
    - name: $skip
      value: ''
      type: query
    - name: $format
      value: ''
      type: query
  docs: List Employee Central persons
- info:
    name: List employment records
    type: http
  http:
    method: GET
    url: https://{apiServer}/odata/v2/EmpEmployment
    params:
    - name: $select
      value: ''
      type: query
    - name: $filter
      value: ''
      type: query
    - name: $top
      value: ''
      type: query
    - name: $skip
      value: ''
      type: query
    - name: $format
      value: ''
      type: query
  docs: List employment records
- info:
    name: Create an employment record
    type: http
  http:
    method: POST
    url: https://{apiServer}/odata/v2/EmpEmployment
    body:
      type: json
      data: '{}'
  docs: Create an employment record
- info:
    name: List job records
    type: http
  http:
    method: GET
    url: https://{apiServer}/odata/v2/EmpJob
    params:
    - name: $select
      value: ''
      type: query
    - name: $filter
      value: ''
      type: query
    - name: $top
      value: ''
      type: query
    - name: $skip
      value: ''
      type: query
    - name: $format
      value: ''
      type: query
  docs: List job records
- info:
    name: List foundation company objects
    type: http
  http:
    method: GET
    url: https://{apiServer}/odata/v2/FOCompany
    params:
    - name: $select
      value: ''
      type: query
    - name: $filter
      value: ''
      type: query
    - name: $top
      value: ''
      type: query
    - name: $skip
      value: ''
      type: query
    - name: $format
      value: ''
      type: query
  docs: List foundation company objects
- info:
    name: Upsert one or more OData entities
    type: http
  http:
    method: POST
    url: https://{apiServer}/odata/v2/upsert
    body:
      type: json
      data: '{}'
  docs: 'OData v2 batch-style upsert endpoint for create-or-update across

    multiple Employee Central entities.

    '
bundled: true