Sign in

v2

latestOpenAPI 3.0.32026-08-07534393676.1 KB
project

get/api/project/basic/

Headers

X-Companystring

The company id to request data for

Response

idstring uuid required
site_hour_fromstring time required
site_hour_tostring time required
site_hour_from_formattedstring required
site_hour_to_formattedstring required
short_addressstring required
short_address_with_suburbstring required
swms_accepted_by_mestring required
jsa_accepted_by_mestring required
readonlystring required
weatherstring required
checkliststring required
sort_namestring required
raw_namestring required
client_namestring nullable required
contract_pricestring
contract_price_excluding_gststring
crewstring required
last_messagestring required
unread_messagesstring required
swms_docsstring required
swms_accepted_bystring required
jsa_docsstring required
jsa_accepted_bystring required
covid_docsstring required
covid_accepted_by_me_todaystring required
covid_accepted_by_todaystring required
created_atstring date-time required
updated_atstring date-time required
namestring
addressstring required
address_latnumber double nullable required
address_longnumber double nullable required
descriptionstring required
purchase_orderstring
start_datestring date required
complete_datestring date required
actual_complete_datestring date nullable
unset_hoursboolean
status'open' | 'on-hold' | 'completed' | 'archived' required
  • open - open
  • on-hold - on-hold
  • completed - completed
  • archived - archived
photostring uri nullable
colorstring
swms_include_headerboolean
jsa_include_headerboolean
supervisor_namestring
contact_phonestring
completioninteger
retentionnumber double
retention_gst'inc' | 'ex'
  • inc - inc
  • ex - ex
retention_calculated_from'contract' | 'adjusted_contract'
  • contract - contract
  • adjusted_contract - adjusted_contract
budget_quote_descriptionstring
budget_quote_termsstring
use_timetraka_pre_work_lockoutboolean
timetraka_pre_work_lockout_minutesinteger
use_timetraka_geofenceboolean
timetraka_geofence_radiusinteger
hour_spentnumber double
operating_atnumber double
has_cellular_connectionboolean
procore_project_idinteger nullable
archived_atstring date-time nullable
labour_estimated_costnumber double
labour_margin_percentnumber double
disable_labour_budget_itemboolean
weather_locationstring uuid nullable
message_channelstring uuid nullable
created_bystring uuid required
companystring uuid required
sharing_companystring uuid nullable
parentstring uuid nullable
labour_budget_groupstring uuid nullable