Skip to main content
GET
/
api
/
v1
/
assignments
List Assignments
curl --request GET \
  --url https://api.example.com/api/v1/assignments
[
  {
    "id": 1,
    "user_id": 1,
    "facility": "Memorial Hospital",
    "location": "Houston",
    "state": "TX",
    "agency": "TravelNurse Inc",
    "start_date": "2025-01-06",
    "end_date": "2025-04-06",
    "base_pay": 180000,
    "housing_stipend": 175000,
    "mie_stipend": 54600,
    "status": "active",
    "sign_on_bonus": 0,
    "completion_bonus": 100000,
    "referral_bonus": 0,
    "contract_s3_key": null,
    "created_at": "2025-01-05T12:00:00.000Z"
  }
]
Returns a paginated list of assignments, optionally filtered by year.

Query Parameters

year
string
Filter by year (YYYY format). Returns assignments that overlap with the given year.
limit
integer
default:"100"
Maximum records to return (1–200).
offset
integer
default:"0"
Number of records to skip.

Request

curl -H "Authorization: Bearer <token>" \
  "https://app.taxhomebase.com/api/v1/assignments?year=2025&limit=20"

Response

Returns an array of assignment objects. The X-Total-Count header contains the total matching count.
[
  {
    "id": 1,
    "user_id": 1,
    "facility": "Memorial Hospital",
    "location": "Houston",
    "state": "TX",
    "agency": "TravelNurse Inc",
    "start_date": "2025-01-06",
    "end_date": "2025-04-06",
    "base_pay": 180000,
    "housing_stipend": 175000,
    "mie_stipend": 54600,
    "status": "active",
    "sign_on_bonus": 0,
    "completion_bonus": 100000,
    "referral_bonus": 0,
    "contract_s3_key": null,
    "created_at": "2025-01-05T12:00:00.000Z"
  }
]