Offers

Retrieve a single offer by id

get/offers/{id}

Request

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

Path parameters

idstring required

Response

Successful response

object'offer' required
idstring required
status'pending' | 'initiated' | 'sent' | 'accepted' | 'rejected' | 'revoked' | 'enrollment_completed' | 'bill_rate_change_requested' | 'null' nullable
status_changed_atstring date-time nullable
additional_detailsstring nullable
employer_start_datestring date nullable
employer_start_preferencestring nullable
initiated_atstring date-time nullable
references_checked_atstring date-time nullable
sent_atstring date-time nullable
application_idstring nullable
worker_idstring nullable
created_atstring date-time nullable
updated_atstring date-time nullable

Example response

{
  "id": "97811bd6-539f-4a58-8be3-6bbe3acfdae0",
  "status": "pending",
  "status_changed_at": "2024-06-15T14:30:00Z",
  "additional_details": "Hybrid schedule, 3 days on-site.",
  "terms": [
    {
      "object": "offer_term",
      "type": "salary",
      "amount_cents": 15000,
      "currency": "USD",
      "cadence": "annually",
      "context": "Performance bonus",
      "start_date": "2024-06-15"
    }
  ],
  "employer_start_date": "2024-06-15",
  "employer_start_preference": "as_soon_as_possible",
  "initiated_at": "2024-06-15T14:30:00Z",
  "references_checked_at": "2024-06-15T14:30:00Z",
  "sent_at": "2024-06-15T14:30:00Z",
  "job": {
    "id": "97811bd6-539f-4a58-8be3-6bbe3acfdae0",
    "name": "Customer Support Specialist",
    "employer_name": "Acme Corp",
    "employer_id": "1aecf7c8-9d70-433a-9bb5-473cf4907a86",
    "logo_url": "https://cdn.example.com/image.jpg"
  },
  "applicant": {
    "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"
  },
  "application_id": "e3d53e91-6187-4184-a084-75a7532e5fca",
  "worker_id": "1ccf6e61-376c-47d3-8a63-a8ee112e83a2",
  "created_at": "2024-06-15T14:30:00Z",
  "updated_at": "2024-06-15T14:30:00Z"
}

Changes

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