Skip to main content

List programs

POST 
/program/list

Lists the current company's programs (the impersonated user's company when impersonating) with their auto-enrollment rules and enrollment counts by status. Requires the program:list permission. By default, counts include every enrolled user, and filtering them with teamIds also requires stats:list for those teams. Set scopeEnrollmentsToVisibleTeams to count only users who are not deleted and are on teams you can see with stats:list, which this option then requires: company-wide stats:list counts every team, or only teamIds when given; narrower stats:list counts only your visible teams (zero when you have none), and teamIds outside them is an error. In a company that uses its own team-visibility rules for reports, those rules decide the visible teams instead of stats:list: requested teamIds outside them are dropped (zero counts when none remain), a company admin with no visible teams gets company-wide counts, and any other user who is not on a team gets a not-authorized error.

Request​

Responses​

Success