---
title: "Retrieve a single onboarding by id"
method: GET
path: "/onboardings/{id}"
tags: ["Onboardings"]
---

# Retrieve a single onboarding by id

`GET /onboardings/{id}`

## Request

- Base URL: `https://app.hireart.com/api/v2`
- URL: `https://app.hireart.com/api/v2/onboardings/{id}`
- Auth: HTTP bearer

## Path parameters

- `id` string, required

## Response `200`

Successful response

- Onboarding
  - `object` 'onboarding', required
  - `id` string, required
  - `assignment_id` string, nullable
  - `ready_to_work` boolean, nullable
  - `start_date` string, date, nullable
  - `job_name` string, nullable
  - `status` 'fully_cleared' | 'ready_to_work' | 'screenings' | 'enrollment_complete' | 'offer_accepted' | 'offer_sent' | 'offer_initiated' | 'offer_rejected' | 'revoked' | 'null', nullable
  - `initiated_at` string, date-time, nullable
  - `completed_at` string, date-time, nullable
  - `assignment_term_status` string, nullable
  - `status_changed_at` string, date-time, nullable
  - `offer_sent_at` string, date-time, nullable
  - `worker` PersonSummary
    - `object` 'person', required
    - `id` string, required
    - `full_name` string, nullable
    - `first_name` string, nullable
    - `last_name` string, nullable
    - `email` string, nullable
    - `phone` string, nullable
  - `pay_rate` PayRate
    - `object` 'pay_rate', required
    - `salary_cents` integer, nullable
    - `hourly_rate_cents` integer, nullable
    - `currency` string, nullable
    - `rate_type` 'hourly' | 'salary' | 'null', nullable
  - `screenings` Screening[], required
    - `object` 'screening', required
    - `id` string, required
    - `report_id` string, nullable
    - `type` string, nullable
    - `subtype` string, nullable
    - `status` 'pending' | 'clear' | 'consider' | 'complete' | 'canceled' | 'suspended' | 'unknown' | 'null', nullable
    - `result` string, nullable
  - `documents` OnboardingDocument[], required
    - `object` 'onboarding_document', required
    - `name` string, nullable
    - `url` string, nullable
    - `signed_at` string, date-time, nullable

## Other responses

- `401`: Unauthorized
- `404`: Not found
- `429`: Rate limit exceeded (100 requests per 60 seconds per API key)
- `500`: Internal server error

---

[API](https://skmtc.dev/hireart/apis/hireart-api.md) - [All operations](https://skmtc.dev/hireart/apis/hireart-api/llms.txt) - [OpenAPI document](https://skmtc.dev/hireart/apis/hireart-api/revisions/41935c8fd584?raw)
