Get Import Progress

Get the progress of an import.

It requires the run-import permission.


Example Call

curl -L -X GET 'http://localhost:3000/api/v1/getImportProgress' \
-H 'X-User-Id: d26x6zSkaPSe5gCyy' \
-H 'X-Auth-Token: Zu-Z6eKzIIz7MCCRGeHi29bYkXZCJ4SxFC0JAasqm92'

Example Result


    "key": "pending-avatars",
    "name": "Pending Avatars",
    "step": "importer_user_selection",
    "count": {
        "completed": 0,
        "total": 0
    "success": true


Any of the following errors can occur on the endpoint.

  • Authorization: Requires an authentication token for the request to be made.

  • No Permission: This occurs when the authenticated user doesn't have the run-import permission.

    "success": false,
    "error": "unauthorized"

Change Log

Last updated

Rocket.Chat versions receive support for six months after release.