API FAQs

How do I sync learners from my system to Foundry?

Depending on your setup, there are several ways to keep learner data accurate and up to date in Foundry using the API. The best approach depends on how your system manages user records and how often changes occur.

In general, API integrations are used to:

• Create new users
• Update existing user information
• Keep learner attributes aligned between systems

What are the recommendations for managing categories and labels?

The API integration supports multiple ways to manage a user’s custom categories and labels. Depending on how your integration is designed, you may use one, two, or all of the following approaches:

• Assign categories and labels when users are created
• Update categories and labels when user records change
• Use categories and labels as triggers for automated assignments

Your chosen approach should align with how your organization structures learner data and assignments in Foundry.

How do I assign courses to users using the API?

Course assignments are managed through automated assignments in Foundry, not directly through the API.

Start by creating an automated assignment in your Foundry account, or review existing automated assignments. Automated assignments add users to courses based on specific criteria, such as:

• Custom categories
• Locations

Take note of the filters used in each automated assignment.

When users are added or updated through the API, ensure the appropriate category and/or location values are set. Once those values match the assignment criteria, Foundry automatically assigns the correct courses.

With this setup:

• The API only manages user properties
• Foundry handles course assignment logic
• Your integration does not need to map courses or assign them individually

I received the error “Too Many Requests.” What does this mean?

This error indicates that your integration has reached the API rate limit.

For more information on this error and how to resolve it, see API Response Error 429: Too Many Requests.

What instructions should I follow if I use Workday Studio?

If you are connecting Workday Studio to the Foundry API, you can download a CLAR file developed by a ComplyEQ partner.

This file is intended as a starter template only. It demonstrates key concepts such as:

• Authentication
• Token management
• Basic integration structure

It is not a complete solution and should be adapted to meet your organization’s specific needs.