# Onboarding

> The Onboarding object in the Guv API.

## Fields

| Field | Type | Description |
| --- | --- | --- |
| `workspace_id` * | string or null |  |
| `plan` * | `trial`, `hobby`, `pro`, `business`, `dedicated` or null |  |
| `plan_chosen` * | boolean |  |
| `trial_ends_at` * | string (date-time) or null |  |
| `card` * | object |  |
| `legal` * | object |  |
| `checklist` * | array of [OnboardingStep](/docs/api/objects/onboarding-step/) |  |
| `completed_count` * | integer |  |
| `total_count` * | integer |  |
| `complete` * | boolean |  |
| `dismissed` * | boolean |  |
| `version` * | integer |  |

\* always present

## Example

```json
{
  "workspace_id": "string",
  "plan": "trial",
  "plan_chosen": false,
  "trial_ends_at": "2026-10-22T13:05:00Z",
  "card": {
    "required": false,
    "status": "not_required",
    "setup_url": "https://guv.dev/"
  },
  "legal": {
    "terms_version": "string",
    "privacy_version": "string",
    "accepted_terms_version": "string",
    "accepted_privacy_version": "string",
    "needs_acceptance": false
  },
  "checklist": [
    {
      "id": "create_project",
      "title": "string",
      "description": "string",
      "status": "pending",
      "source": "auto",
      "completed_at": "2026-10-22T13:05:00Z"
    }
  ],
  "completed_count": 1,
  "total_count": 1,
  "complete": false,
  "dismissed": false,
  "version": 1
}
```

## Used by

- [Get onboarding progress](/docs/api/sign-up/#get-onboarding-progress)
- [Update onboarding progress](/docs/api/sign-up/#update-onboarding-progress)