HIhireart
Assignments

Retrieve a single assignment by id

get/assignments/{id}

Request

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

Path parameters

idstring required

Response

Successful response

object'assignment' required
idstring required
status'terminated' | 'active' | 'furloughed' | 'leave' | 'hold' | 'stipend_only' | 'offer_revoked' | 'offer_turned_down' | 'pending' | 'null' nullable
status_changed_atstring date-time nullable
start_datestring date nullable
end_datestring date nullable
classification'w2' | '1099' | 't4' | 'international_ic' | 'null' nullable

Example response

{
  "id": "97811bd6-539f-4a58-8be3-6bbe3acfdae0",
  "status": "active",
  "status_changed_at": "2024-06-15T14:30:00Z",
  "start_date": "2024-06-15",
  "end_date": "2024-06-15",
  "classification": "w2",
  "pay_rate": {
    "salary_cents": 4500000,
    "hourly_rate_cents": 2163,
    "currency": "USD",
    "rate_type": "hourly"
  },
  "bill_rate": {
    "salary_cents": 4500000,
    "hourly_rate_cents": 2163,
    "currency": "USD",
    "rate_type": "hourly"
  },
  "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"
  },
  "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"
  },
  "work_location": {
    "id": "97811bd6-539f-4a58-8be3-6bbe3acfdae0",
    "description": "Handle inbound customer inquiries via phone, email, and chat.",
    "street1": "20 W 34th St",
    "city": "New York",
    "state": "NY",
    "postal_code": "10001",
    "country": "US"
  },
  "employer_of_record": {
    "name": "Acme Corp",
    "vendor_id": "1aecf7c8-9d70-433a-9bb5-473cf4907a86"
  },
  "visa": {
    "type": "us_eligible",
    "expiration_date": "2024-06-15"
  },
  "purchase_orders": [
    {
      "object": "purchase_order",
      "id": "97811bd6-539f-4a58-8be3-6bbe3acfdae0",
      "client_reference_id": "1aecf7c8-9d70-433a-9bb5-473cf4907a86",
      "cost_center": "Engineering",
      "original_amount_cents": 50000000,
      "currency": "USD",
      "start_date": "2024-06-15",
      "expiration_date": "2024-06-15"
    }
  ]
}

Changes

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