import_users users

Pass a list of users addresses,
sets the same roles/company for all

Required permissions:

  • IsAuthenticated
  • WorkspaceRequired
  • HasRolePermissions::user_create
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

supports RFC 2822 standard (copy-paste format from email client), example:
'"Doe, John C" [email protected],"Goodwin, Kurt M" [email protected]'

or can pass as list: [[display_name, email], [display_name, email]]

https://superuser.com/questions/1625686/what-is-the-email-address-format-name-email-called

integer
roles
array of strings
roles
boolean

set all users to is_staff, is_superuser

boolean
Defaults to true

Send welcome email to new users

string
length ≤ 500

Optional free-text reason for the import batch (e.g. 'New hires onboarding 2026-Q2'). Applied to every audit log entry written for the created users.

Response
200

{created_users, warnings}

Language
Credentials
Header
LoadingLoading…