Assignments

List all assignments for the authenticated employer

get/assignments

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

Assignment start date is on this date (YYYY-MM-DD)

start_date_gtstring date

Assignment start date is after this date (YYYY-MM-DD)

start_date_gtestring date

Assignment start date is on or after this date (YYYY-MM-DD)

start_date_ltstring date

Assignment start date is before this date (YYYY-MM-DD)

start_date_ltestring date

Assignment start date 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": "assignment",
      "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": {
        "object": "pay_rate",
        "salary_cents": 4500000,
        "hourly_rate_cents": 2163,
        "currency": "USD",
        "rate_type": "hourly"
      },
      "bill_rate": {
        "object": "bill_rate",
        "salary_cents": 4500000,
        "hourly_rate_cents": 2163,
        "currency": "USD",
        "rate_type": "hourly"
      },
      "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"
      },
      "job": {
        "object": "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": {
        "object": "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",
        "is_remote": false
      },
      "employer_of_record": {
        "object": "employer_of_record",
        "name": "Acme Corp",
        "vendor_id": "1aecf7c8-9d70-433a-9bb5-473cf4907a86"
      },
      "visa": {
        "object": "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.