---
title: "Retrieve a single onboarding profile"
method: GET
path: "/api/v1/onboarding-profiles/{profileId}"
tags: ["Onboarding Profiles"]
---

# Retrieve a single onboarding profile

`GET /api/v1/onboarding-profiles/{profileId}`

## Request

- Base URL: `https://partner-api.monta.com`
- URL: `https://partner-api.monta.com/api/v1/onboarding-profiles/{profileId}`
- Auth: HTTP bearer

Required scope: `teams:read` </br>Organization authorization: `supported`

## Path parameters

- `profileId` integer, required

## Response `200`

Onboarding profile with provided id

- OnboardingProfile
  - `id` integer: Id of this onboarding profile
  - `operatorId` integer: Id of the operator this profile belongs to
  - `name` string, required: Name of the profile, unique per operator
  - `description` string, nullable: Description of the profile
  - `enabled` boolean: Whether the profile can be assigned to teams
  - `inUseCount` integer: Number of teams currently linked to this profile
  - `steps` OnboardingStep[], required: The onboarding steps a linked team receives, as {step, config?, displayMode?} entries.
    - `step` 'ADD_VEHICLE' | 'ADD_PAYMENT_METHOD' | 'ADD_RFID' | 'ADD_CHARGER' | 'ADD_TEAM_MEMBER' | 'SETUP_CHARGING_RULE' | 'SETUP_REIMBURSEMENT', required: The onboarding step key. Present in the list means the step is enabled for the team.
    - `config` 'scheduled' | 'smart' | 'member' | 'admin', nullable: Optional per-step configuration, interpreted by the step. SETUP_CHARGING_RULE: the charging rule type, one of `scheduled`, `smart`. ADD_TEAM_MEMBER: the member type the invite creates, one of `member`, `admin`; null/absent keeps the app's native invite flow, which picks the role. Null/absent for all other steps.
    - `displayMode` 'full_screen' | 'waiting_step', nullable: How the app presents the step: `full_screen` (default) or `waiting_step` (a passive card). `waiting_step` is rejected for SETUP_CHARGING_RULE. Absent/null defaults to `full_screen`.
  - `welcomeText` OnboardingWelcomeText
    - `type` 'home' | 'public' | 'semi_public', nullable: Welcome screen flavour. Required when `enabled` is true.
    - `enabled` boolean, required: Whether the welcome text overrides are shown.
    - `slots` object, nullable: Per-charger-state text overrides, keyed by slot (e.g. `ready`). Omitted slots use Monta's default copy.
  - `createdAt` string, date-time, nullable: Creation date of this profile
  - `updatedAt` string, date-time, nullable: Date this profile was last updated

## Other responses

- `400`: The request is invalid
- `401`: Consumer with provided credentials was not found
- `403`: Operator doesn't have access to resource
- `404`: Entity with the provided id was not found

## Changes

- **2026-11-03** `0ca400461c52`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/monta/apis/monta-partner-api/changes/api/v1/onboarding-profiles/:profileId/get.md)

---

[API](https://skmtc.dev/monta/apis/monta-partner-api.md) - [All operations](https://skmtc.dev/monta/apis/monta-partner-api/llms.txt) - [OpenAPI document](https://skmtc.dev/monta/apis/monta-partner-api/revisions/0ca400461c52?raw)