---
title: "GET /v2/agent-onboarding/{intent_id}"
method: GET
path: "/v2/agent-onboarding/{intent_id}"
tags: ["agent-onboarding-v2"]
---

# GET /v2/agent-onboarding/{intent_id}

`GET /v2/agent-onboarding/{intent_id}`

## Request

- Base URL: `https://api.tracklysms.com/api`
- URL: `https://api.tracklysms.com/api/v2/agent-onboarding/{intent_id}`
- Auth: API key in header `Authorization`

## Headers

- `Authorization` string, required

## Response `200`

Enrollment status; completed requires separate secure key configuration

- AgentOnboardingStatusResponse
  - `onboarding` AgentOnboardingStatus, required
    - `account_id` integer, nullable: New account identifier after completion; otherwise null
    - `expires_at` string, date-time, required: UTC confirmation deadline
    - `id` string, required: 32-character enrollment identifier
    - `name` string, required
    - `next_step` 'complete_signup' | 'configure_api_key', required
    - `status` 'pending' | 'completed' | 'expired', required

## Other responses

- `401`: Missing or malformed polling capability
- `404`: Unknown enrollment or mismatched capability
- `429`: Polling limit reached; see Retry-After
- `503`: Enrollment authority unavailable

---

[API](https://skmtc.dev/tracklysms/apis/trackly-sms-api.md) · [All operations](https://skmtc.dev/tracklysms/apis/trackly-sms-api/llms.txt) · [OpenAPI document](https://skmtc.dev/tracklysms/apis/trackly-sms-api/revisions/ac1ad22cb2a9?raw)
