Get a workspace contract

get/contracts/{id}

Request

  • Base URL: https://api.shorpay.com/v1
  • URL: https://api.shorpay.com/v1/contracts/{id}
  • Auth: HTTP bearer

Path parameters

idstring uuid required

Response

Success

idstring uuid required
titlestring required
employmentType'employee' | 'contractor' required
contractType'employment_at_will' | 'contractor_fixed' | 'contractor_milestone' | 'contractor_payg' | 'contractor_creator' required
status'draft' | 'pending_verification' | 'ready_for_signature' | 'pending_signature' | 'signed' | 'active' | 'offboarding' | 'completed' | 'cancelled' required
startDatestring date nullable required
endDatestring date nullable required
createdAtstring date-time required
updatedAtstring date-time required
deletedAtstring date-time nullable required

Changes

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