---
title: "Get welcome details"
method: GET
path: "/v1/account/onboarding"
tags: ["account"]
---

# Get welcome details

`GET /v1/account/onboarding`

## Request

- Base URL: `https://api.brixsignage.com`
- URL: `https://api.brixsignage.com/v1/account/onboarding`
- Auth: HTTP bearer

Returns what the welcome panel needs: how the owner signed up (email, Google or Microsoft), the workspace country, whether a phone number is on file, and the region where the workspace data is stored, with a plain place name.

## Response `2XX`

Success. Body is `{ data: … }` unless the endpoint serves bytes. The shape of `data` is not yet modelled for this operation.

## Other responses

- `4XX`: Client error. 404 rather than 403 for another tenant's resource, so account existence is not leaked.
- `5XX`: Server error. The body carries a `requestId` to quote to support.

---

[API](https://skmtc.dev/brixsignage/apis/brix-api.md) · [All operations](https://skmtc.dev/brixsignage/apis/brix-api/llms.txt) · [OpenAPI document](https://skmtc.dev/brixsignage/apis/brix-api/revisions/02fd3665dc7d?raw)