How Do I Set Up the User API Integration?

Last updated: November 14, 2026

The User API integration lets your HR system or another tool create and update Ambition users automatically, instead of an admin having to edit profiles manually. You decide which field is used to identify each employee, as well as which Ambition fields the columns or keys correspond to.

Required permissions:

  • The Integrations: Edit permission is required to set up the User API integration.

Turn On the User API Integration

  1. Go to Admin --> Data --> Integrations.

  2. On the Available tab, search for "User API" and click on Enable. Up to three User API integrations can be active.

  3. Optional: Change the default name, User API, in the Integration Name field.

  4. Enter a contact email for integration issues in the Admin Email Address field.

  5. Click on Save.

Choose the File Type

  1. Click on Data Format in the side menu.

  2. Select CSV or JSON. JSON must be flat, with no nested objects.

  3. Click on Save File Format.

Map Your Fields

  1. Update the starter rows for Email, First Name, and Last Name so the API Fields text fields match your column headers or keys exactly, including capitalization. These three fields are required.

  2. Click on Add for each other field you're sending, enter its header or key in the API Fields text field, and select the matching option from the Ambition Fields drop-down menu.

  3. Select the field that identifies each employee from the Unique user ID drop-down menu. Email is the default, but a stable employee ID can be used instead.

  4. Click on Save API Field Mappings.

Note:

  • The Unique user ID cannot be changed after users have been imported.

Related Articles