Skip to main content
POST
/
api
/
v1
/
assignments
Create Assignment
curl --request POST \
  --url https://api.example.com/api/v1/assignments \
  --header 'Content-Type: application/json' \
  --data '
{
  "facility": "<string>",
  "location": "<string>",
  "state": "<string>",
  "start_date": "<string>",
  "base_pay": 123,
  "agency": "<string>",
  "end_date": "<string>",
  "housing_stipend": 123,
  "mie_stipend": 123,
  "status": "<string>",
  "sign_on_bonus": 123,
  "completion_bonus": 123,
  "referral_bonus": 123,
  "contract_s3_key": "<string>"
}
'
{
  "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"
}

​
Request Body

​
facility
string
required
Hospital or facility name (max 255 chars).
​
location
string
required
City name (max 255 chars).
​
state
string
required
2-letter state code (e.g., TX, CA, NY).
​
start_date
string
required
Contract start date (YYYY-MM-DD).
​
base_pay
integer
required
Weekly pre-tax base pay in cents. Must be ≥ 0.
​
agency
string
Staffing agency name (max 255 chars).
​
end_date
string
Contract end date (YYYY-MM-DD). Must be ≥ start_date.
​
housing_stipend
integer
default:"0"
Weekly housing stipend in cents.
​
mie_stipend
integer
default:"0"
Weekly M&IE stipend in cents.
​
status
string
default:"upcoming"
Assignment status: upcoming, active, or complete.
​
sign_on_bonus
integer
default:"0"
Sign-on bonus in cents.
​
completion_bonus
integer
default:"0"
Completion bonus in cents.
​
referral_bonus
integer
default:"0"
Referral bonus in cents.
​
contract_s3_key
string
S3 key of an uploaded contract file.

​
Request

curl -X POST \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "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",
    "completion_bonus": 100000
  }' \
  https://app.taxhomebase.com/api/v1/assignments

​
Response

{
  "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"
}

​
Errors

StatusCause
400Missing required fields, invalid state code, base_pay < 0, end_date < start_date, invalid status