WFM Toolkit

WFM API Explorer Documentation

Learn how to set up WFM API access and use the API Explorer tool.

Getting Started with WFM API Access

Before using the API Explorer, API access will need to be configured in whichever tenant you plan on running the APIs against. You will need to have:
  • A user with the proper access created in the application
  • An AuthN Client created that uses the Interactive/Password flow and grant type

Step 1: Create an API Client in WFM

You'll need administrator access to your WFM system to create an API client. Follow these steps:
  1. 1 Log into your WFM tenant
  2. 2
    Navigate to Administration Application Setup Common Setup Client Management
  3. 3 Click the 'Create' button
  4. 4
    Fill in the client details:
    • Name: Something descriptive like "API Explorer Tool"
    • Application Flow: Select "Interactive"
    • Grant Type: Select "Password Flow (ROPC)"
  5. 5 Save
Important
After creating the client, you'll receive a Client ID, Client Secret, Realm, and Organization ID. If the Client Secret does not appear, click the "Refresh" button. Once it generates, save it to a safe place. It will not be generated again.

Step 2: Create or Configure an API User

You'll also need a WFM user account with API access permissions:
  1. 1 Create a new user account or duplicate an existing one
  2. 2
    Assign appropriate access profiles and permissions
    • Function Access Profile: Super Access *
    • Roles (Edit Licenses): Manager, Employee
    • Licenses: Select a license for each product available (i.e. Hourly Timekeeping, Absence, Advanced Scheduling, etc.)
Note
Super Access is suggested above since it is a system default profile that contains access to everything an API user could want or need access to. If it is company policy for an API user to not have access to everything, review this Function Access Profile and slowly remove access as needed.

Step 3: Gather Required Information

Once you have your API client and user set up, collect the following information:

Client Configuration

Client ID
Generated when you created the API client
Example: abc123def456
Client Secret
Secret key generated with the client
Example: xyz789uvw012
Organization ID
Your WFM organization identifier
Example: org_PGHKngyxtxV6kU7Z

WFM User Account

Username
Your API user's username
Example: APIUSER
Password
Your API user's password
Keep this secure
Hostname
Your WFM instance URL
Example: https://host.prd.mykronos.com

Step 4: Using the API Explorer

With your credentials ready, you can now use the API Explorer:

  1. 1
    Open the API Explorer Navigate to the API Explorer tool
  2. 2
    Enter Credentials Fill in all the fields in the "Global Configuration" section
  3. 3
    Authenticate Click "Authenticate" to verify your credentials
  4. 4
    Select Endpoint Choose an API endpoint from the dropdown menu
  5. 5
    Test API Calls Configure any necessary parameters as indicated on the page and click "Execute Request" to send the request and get the data back

Security Best Practices

Credential Storage

Non-sensitive information is temporarily cached in your browser session

Sensitive Data

Client Secret and Password are never stored and must be re-entered each session

Access Tokens

Authentication tokens are stored server-side and cleared on logout

Troubleshooting

Authentication Failed

  • Verify all credentials are entered correctly
  • Check that the hostname includes the protocol (https://)
  • Ensure the API user account is active and has proper permissions
  • Confirm the API client is properly configured in WFM

Connection Errors

  • Verify the hostname URL is correct and accessible
  • Check your network connection

API Permission Errors

  • Check that your API user has the necessary permissions per the endpoint documentation

Need Help?

If you're still having trouble setting up API access:

API Documentation

Refer to the Developer documentation

Support Case

Open a Support Case for assistance with setting up a Client and/or user
WFM Toolkit
© 2025 WFM Toolkit. All rights reserved.