Homepage

import_users

Last edit: Nov 10, 2026

Imports users in bulk, for example from another instance. Each user is matched
by its id (see _id_remap) and updated, or created when there is no match; for
an existing user only names, slug and properties change. Users that fail are
skipped and reported together in one error after the others are imported;
nothing is imported when two users share an email or slug

import_users(
  _id_remap: Boolean = true
  _index_rebuild: Boolean = true
  users: [UserImport!]!
): ImportUsersMutationPayload

Arguments

_id_remap (Boolean)

When true, given ids are treated as external ids: objects are matched by
them, new objects get new ids, and references between imported objects are
rewritten to the new ids. When false, given ids are used as the actual ids
and must be integers. Defaults to true

_index_rebuild (Boolean)

When true, the search index is rebuilt in a background job after the import. Defaults to true

users (UserImport)

The users to import

Type

ImportUsersMutationPayload

Autogenerated return type of ImportUsersMutation.

Questions?

We are always happy to help with any questions you may have.

contact us