Returns list of employee position information filtered on various parameters

If no pagination parameters specified, the default/max is applied.
Permissions - UKG Pro service account must have "View" role for the "Company Configuration Integration" Api endpoints. Headers - US-Customer-Api-Key, Authorization (base64 encoded {username}:{password}).

/configuration/v1/position endpoint can take following optional parameter:

  • companyId :- Can take in multiple IDs separated by comma. ex: [id1, id2]
  • employeeType :- Can take in multiple IDs separated by comma. ex: [id1, id2]
  • payGroupCode :- Can take in multiple IDs separated by comma. ex: [id1, id2]
  • statusCode :- Can take in multiple IDs separated by comma. ex: [id1, id2]
  • positionCode :- Can take in multiple IDs separated by comma. ex: [id1, id2]
  • projectCode :- Can take in multiple IDs separated by comma. ex: [id1, id2]
  • shiftGroupCode :- Can take in multiple IDs separated by comma. ex: [id1, id2]
  • isProrated
  • isApproved
  • isEligibleForBenefits

    • Correct syntax when using parameters are as follows:
      • Get positions without parameter
        • Example: /configuration/v1/positions
      • Get positions by single companyid
        • Example: /configuration/v1/positions?companyid={companyid}
      • Get positions by multiple companyid
        • Example: /configuration/v1/positions?companyid=[companyid1,companyid2]
      • Get positions by positionsCode
        • Example: configuration/v1/positions?positionCode={positionCode}
      • Get positions by isEligibleForBenefits
        • Example: configuration/v1/positions?isEligibleForBenefits={isEligibleForBenefit}
      • Get positions by employeeType
        • Example: configuration/v1/positions?employeeType={employeeType}
      • Get positions by statusCode
        • Example: configuration/v1/positions?statusCode={statusCode}
      • Get positions by shiftGroupCode
        • Example: configuration/v1/positions?shiftGrouptCode={shiftGrouptCode}
      • Get positions by using all parameter
        • Example: configuration/v1/positions?isApproved={isApproved}&employeeType={employeeType}&shiftGroupCode={shiftGroupCode}&isEligibleForBenefits={isEligibleForBenefits}&isProrated={isProrated}&statusCode={statusCode}&payGroupCode={payGroup}&positionCode={positionCode}&projectCode={projectCode}&companyId={companyId}&page={page}&per_Page={per_Page}
Language
Credentials
Basic
base64
:
URL