---
title: "Get Onboarding"
method: GET
path: "/api/v1/imessage/onboarding"
tags: ["iMessage"]
---

# Get Onboarding

`GET /api/v1/imessage/onboarding`

## Query parameters

- `agent_identity_id` string, uuid, nullable

## Response `200`

Successful Response

- object

## Other responses

- `422` — Validation Error
- `4XX` — Client error with Support Agent information.
- `5XX` — Server error with Support Agent information.

---

[API](https://skmtc.dev/inkbox/apis/inkbox-api.md) · [All operations](https://skmtc.dev/inkbox/apis/inkbox-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/inkbox/inkbox-api/revisions/31f357e7e6f8/schema)