> ## Documentation Index
> Fetch the complete documentation index at: https://developer.rocket.chat/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Setup Wizard Parameters

> Returns the settings used by the setup wizard and whether the workspace is already registered with Rocket.Chat Cloud.

This endpoint does not require authentication, because the setup wizard runs before the first administrator account exists. 
If the setup wizard is completed, the endpoint returns a `403` response. 

This endpoint replaces the deprecated `getSetupWizardParameters` Realtime API method.

### Changelog
| Version | Description |
| ------- | ----------- |
| 8.9.0   | Added       |

## OpenAPI

````json GET /api/v1/setupWizard.parameters
{
  "openapi": "3.0.0",
  "info": {
    "version": "1.0.0",
    "title": "Settings"
  },
  "servers": [
    {
      "url": "https://apiexplorer.support.rocket.chat"
    }
  ],
  "tags": [
    {
      "name": "Settings"
    },
    {
      "name": "Audit"
    },
    {
      "name": "Cloud"
    },
    {
      "name": "DNS"
    },
    {
      "name": "E2E"
    },
    {
      "name": "Import"
    },
    {
      "name": "Bulk User Import"
    },
    {
      "name": "Instances"
    },
    {
      "name": "Federation"
    },
    {
      "name": "Moderation"
    },
    {
      "name": "Device Management"
    },
    {
      "name": "Password policy"
    },
    {
      "name": "Video Conference"
    },
    {
      "name": "Media Calls"
    }
  ],
  "paths": {
    "/api/v1/setupWizard.parameters": {
      "get": {
        "tags": [
          "Settings"
        ],
        "summary": "Get Setup Wizard Parameters",
        "description": "Returns the settings used by the setup wizard and whether the workspace is already registered with Rocket.Chat Cloud.\n\nThis endpoint does not require authentication, because the setup wizard runs before the first administrator account exists. \nIf the setup wizard is completed, the endpoint returns a `403` response. \n\nThis endpoint replaces the deprecated `getSetupWizardParameters` Realtime API method.\n\n### Changelog\n| Version | Description |\n| ------- | ----------- |\n| 8.9.0   | Added       |",
        "operationId": "get-api-v1-setupWizard.parameters",
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "settings": {
                      "type": "array",
                      "description": "The settings shown in the setup wizard.",
                      "items": {
                        "type": "object",
                        "properties": {
                          "_id": {
                            "type": "string"
                          },
                          "type": {
                            "type": "string"
                          },
                          "value": {},
                          "values": {
                            "type": "array",
                            "items": {
                              "type": "object",
                              "properties": {
                                "key": {
                                  "type": "string"
                                },
                                "i18nLabel": {
                                  "type": "string"
                                }
                              }
                            }
                          },
                          "wizard": {
                            "type": "object",
                            "properties": {
                              "step": {
                                "type": "integer"
                              },
                              "order": {
                                "type": "integer"
                              }
                            }
                          }
                        }
                      }
                    },
                    "serverAlreadyRegistered": {
                      "type": "boolean",
                      "description": "Whether the workspace is already registered with Rocket.Chat Cloud."
                    },
                    "success": {
                      "type": "boolean"
                    }
                  }
                },
                "examples": {
                  "Success Example": {
                    "value": {
                      "settings": [
                        {
                          "_id": "Organization_Name",
                          "type": "string",
                          "value": "",
                          "wizard": {
                            "step": 2,
                            "order": 1
                          }
                        },
                        {
                          "_id": "Organization_Type",
                          "type": "select",
                          "value": "",
                          "values": [
                            {
                              "key": "community",
                              "i18nLabel": "Community"
                            },
                            {
                              "key": "government",
                              "i18nLabel": "Government"
                            },
                            {
                              "key": "nonprofit",
                              "i18nLabel": "Nonprofit"
                            }
                          ],
                          "wizard": {
                            "step": 2,
                            "order": 0
                          }
                        }
                      ],
                      "serverAlreadyRegistered": false,
                      "success": true
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Forbidden. The setup wizard is already completed.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "success": {
                      "type": "boolean"
                    },
                    "error": {
                      "type": "string"
                    }
                  }
                },
                "examples": {
                  "Permission Error": {
                    "value": {
                      "success": false,
                      "error": "unauthorized"
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}
````