HIhireart
Onboardings

List all onboardings for the authenticated employer

get/onboardings

Request

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

Query parameters

pageinteger

Page number

per_pageinteger

Number of results per page

worker_idstring

Filter by worker id

job_idstring

Filter by job id

start_datestring date

The onboarding's start_date: the offer's until the assignment begins, then the assignment's is on this date (YYYY-MM-DD)

start_date_gtstring date

The onboarding's start_date: the offer's until the assignment begins, then the assignment's is after this date (YYYY-MM-DD)

start_date_gtestring date

The onboarding's start_date: the offer's until the assignment begins, then the assignment's is on or after this date (YYYY-MM-DD)

start_date_ltstring date

The onboarding's start_date: the offer's until the assignment begins, then the assignment's is before this date (YYYY-MM-DD)

start_date_ltestring date

The onboarding's start_date: the offer's until the assignment begins, then the assignment's is on or before this date (YYYY-MM-DD)

Response

Successful response

object'list' required
pageinteger required
per_pageinteger required
total_countinteger required
total_pagesinteger required

Example response

{
  "page": 1,
  "per_page": 25,
  "total_count": 42,
  "total_pages": 2,
  "data": [
    {
      "object": "onboarding",
      "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": {
        "object": "person",
        "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": {
        "object": "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.