HIhireart
Onboardings

Retrieve a single onboarding by id

get/onboardings/{id}

Request

  • Base URL
    https://app.hireart.com/api/v2
  • Auth
    HTTP bearer

Path parameters

idstring required

Response

Successful response

object'onboarding' required
idstring required
assignment_idstring nullable
ready_to_workboolean nullable
start_datestring date nullable
job_namestring nullable
status'fully_cleared' | 'ready_to_work' | 'screenings' | 'enrollment_complete' | 'offer_accepted' | 'offer_sent' | 'offer_initiated' | 'offer_rejected' | 'revoked' | 'null' nullable
initiated_atstring date-time nullable
completed_atstring date-time nullable
assignment_term_statusstring nullable
status_changed_atstring date-time nullable
offer_sent_atstring date-time nullable

Example response

{
  "id": "97811bd6-539f-4a58-8be3-6bbe3acfdae0",
  "assignment_id": "1aecf7c8-9d70-433a-9bb5-473cf4907a86",
  "ready_to_work": true,
  "start_date": "2024-06-15",
  "job_name": "Customer Support Specialist",
  "status": "fully_cleared",
  "initiated_at": "2024-06-15T14:30:00Z",
  "completed_at": "2024-06-15T14:30:00Z",
  "assignment_term_status": "active",
  "status_changed_at": "2024-06-15T14:30:00Z",
  "offer_sent_at": "2024-06-15T14:30:00Z",
  "worker": {
    "id": "97811bd6-539f-4a58-8be3-6bbe3acfdae0",
    "full_name": "Jane Doe",
    "first_name": "Jane",
    "last_name": "Doe",
    "email": "jane.doe@example.com",
    "phone": "+1 (555) 555-5555"
  },
  "pay_rate": {
    "salary_cents": 4500000,
    "hourly_rate_cents": 2163,
    "currency": "USD",
    "rate_type": "hourly"
  },
  "screenings": [
    {
      "object": "screening",
      "id": "97811bd6-539f-4a58-8be3-6bbe3acfdae0",
      "report_id": "1aecf7c8-9d70-433a-9bb5-473cf4907a86",
      "type": "criminal_background",
      "subtype": "county",
      "status": "pending",
      "result": "clear"
    }
  ],
  "documents": [
    {
      "object": "onboarding_document",
      "name": "Employment Agreement",
      "url": "https://cdn.example.com/document.pdf",
      "signed_at": "2024-06-15T14:30:00Z"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.