---
title: "Get onboarding checklist REST API | HitKeep"
description: "Reference for the HitKeep REST API operation Get onboarding checklist, including request parameters, responses, and authentication notes."
canonical: "https://hitkeep.com/api/operations/apiuseronboarding/"
---

# Get onboarding checklist REST API

GET

/api/user/onboarding

FetchcURL

```
const url = 'http://127.0.0.1:25737/api/user/onboarding';
const options = {method: 'GET', headers: {cookie: 'hk_token=<hk_token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```
curl --request GET \
  --url http://127.0.0.1:25737/api/user/onboarding \
  --cookie hk_token=<hk_token>
```

-

Returns an onboarding checklist computed from sites, tracking status, team membership, and scheduled report state.

## Authorizations

- **[cookieAuth](https://hitkeep.com/api/#cookieauth)**

## Responses

### 200

Onboarding state

application/json

object

**complete**

boolean

**dismissed**

boolean

**steps**

Array<object>

object

**complete**

boolean

**current**

integer

**key**

string

Allowed values: create_site verify_tracking automatic_events invite_teammate schedule_report

**site_domain**

string

**site_id**

string format: uuid

**target**

integer

##### Example

```
{
  "steps": [
    {
      "key": "create_site"
    }
  ]
}
```

[Previous Get current IP](https://hitkeep.com/api/operations/apiusercurrent-ip/)[Next Dismiss onboarding checklist](https://hitkeep.com/api/operations/apiuseronboardingdismiss/)