Team Structure Import Setup via REST HTTP/SSL Endpoint

This method for passing us your org structure allows you to send us your structure and also allows you to request status updates using two endpoints. One for sending us your users and teams CSV files and one for asynchronously requesting status updates on the sync job in progress.


Production Endpoint

https://integrations-api.pluralsight.com


Authentication options

Basic Authentication

Username: pluralsight

Password: [insert-your-api-key-here]

Bearer Authentication

Set Authentication header to “Bearer [insert-your-api-key-here]”


POST /sync-users

You will provide two CSV files containing your org structure: users and teams. Once we successfully have both files, we will begin the process of syncing your team structure into Pluralsight and a statusURL will be returned to you for requesting the status of your sync.

By default, the sync process is run as a "dry run", meaning the operations to sync your structure into Pluralsight would be generated and stored but not applied. This allows for a review of the data to ensure everything would appear the way you expected. To apply the operations, a dryRun parameter in the URL will need to be set to false. See the "Turning off Dry Run" section below.

You will also have the option to run the sync process without inviting managers to Pluralsight via email. All of the other operations would be applied and you would be able to view your team structure within Pluralsight but managers that are not already in Pluralsight would not be sent an email to invite them and will not be added to the team.


Headers

Content-Type: text/csv

Content-Disposition: attachment; filename="teams.csv" or Content-Disposition: attachment; filename="users.csv"


Body

You must provide either the users CSV file or the teams CSV file one at a time. Details follow.


Users CSV File

File Name: users.csv

File Data:

  • Required headers:
    • 'id', 'email', 'first_name', 'last_name', 'team_id'
  • All users must have a unique id and a unique email

Teams CSV File

File Name: teams.csv

File Data:

  • Required headers within the csv:
    • 'id', 'name', 'manager_ids', 'parent_team_id'
  • All teams must have a unique id and a unique name

Note: If your team names are not unique, the import process will add your managers name and the teams unique id to the end of the team name. For example... Team Name (John Smith - 12345).


Please Note: The use of special characters in files (Quotation marks, commas, symbols, etc.) can possibly cause errors while parsing. We recommend that you remove any special characters from your files to ensure your file gets processed successfully.


To view URL parameter options and the possible HTTP responses, navigate to the URL Parameters and Responses page.