Admin

GET companies/{company_id}/project_stages

Parameters

• company_id

  stringpathrequired

Response · 200 · object[]

• id

  integer
• name

  string
• is_bidding_stage

  boolean
• is_concept_stage

  boolean
• category

  string
• readonly

  boolean
• default_stage

  boolean
• hideable

  boolean
• has_rfi_prefixes

  boolean
• project_stage_has_children

  boolean

GET cost_codes

Response · 200 · object[]

• id

  integer
• biller

  string
• biller_id

  integer
• biller_type

  string
• biller_origin_id

  string
• budgeted

  boolean
• code

  string
• created_at

  string (date-time)
• deleted_at

  string (date-time)
• full_code

  string
• name

  string
• origin_data

  string
• origin_id

  string
• parent

  object
• position

  integer
• sortable_code

  string
• standard_cost_code_id

  integer
• updated_at

  string (date-time)
• line_item_types

  object[]

POST cost_codes

Request body

• project_id

  integerrequired
• sub_job_id

  integer
• cost_code

  objectrequired

Response · 201 · object

• id

  integer
• biller

  string
• biller_id

  integer
• biller_type

  string
• biller_origin_id

  string
• budgeted

  boolean
• code

  string
• created_at

  string (date-time)
• deleted_at

  string (date-time)
• full_code

  string
• name

  string
• origin_data

  string
• origin_id

  string
• parent

  object
• position

  integer
• sortable_code

  string
• standard_cost_code_id

  integer
• updated_at

  string (date-time)
• line_item_types

  object[]

GET cost_codes/{id}

Parameters

• id

  stringpathrequired

Response · 200 · object

• id

  integer
• biller

  string
• biller_id

  integer
• biller_type

  string
• biller_origin_id

  string
• budgeted

  boolean
• code

  string
• created_at

  string (date-time)
• deleted_at

  string (date-time)
• full_code

  string
• name

  string
• origin_data

  string
• origin_id

  string
• parent

  object
• position

  integer
• sortable_code

  string
• standard_cost_code_id

  integer
• updated_at

  string (date-time)
• line_item_types

  object[]

PATCH cost_codes/{id}

Parameters

• id

  stringpathrequired

Response · 200 · object

• id

  integer
• biller

  string
• biller_id

  integer
• biller_type

  string
• biller_origin_id

  string
• budgeted

  boolean
• code

  string
• created_at

  string (date-time)
• deleted_at

  string (date-time)
• full_code

  string
• name

  string
• origin_data

  string
• origin_id

  string
• parent

  object
• position

  integer
• sortable_code

  string
• standard_cost_code_id

  integer
• updated_at

  string (date-time)
• line_item_types

  object[]

List projects

Parameters

• company_id

  integerquery
• OS-Company-Id

  integerheader
• filters[active]

  stringquery
• page

  integerquery
• per_page

  integerquery

Response · 200 · object[]

• id

  integer
• logo_id

  integer
• logo_url

  string
• name

  string
• is_demo

  boolean
• template

  boolean
• display_name

  string
• project_number

  string
• address

  string
• city

  string
• state_code

  string
• country_code

  string
• zip

  string
• time_zone

  string
• tz_name

  string
• latitude

  number (float)
• longitude

  number (float)
• county

  string
• parent_job_id

  integer
• parent_job

  object
• from_project_template_id

  integer
• square_feet

  integer
• start_date

  string (date)
• completion_date

  string (date)
• total_value

  string (float)
• store_number

  string
• accounting_project_number

  string
• designated_market_area

  string
• warranty_start_date

  string (date)
• warranty_end_date

  string (date)
• active

  boolean
• flag

  string
• locale

  string
• phone

  string
• public_notes

  string
• actual_start_date

  string (date)
• projected_finish_date

  string (date)
• created_at

  string (date-time)
• updated_at

  string (date-time)
• origin_id

  string
• origin_data

  string
• origin_code

  string
• standard_cost_code_list_id

  integer
• is_erp_integrated

  boolean
• owners_project_id

  integer
• photo_id

  integer
• photo_url

  string
• inbound_email

  string
• inbound_email_address

  string (email)
• estimated_start_date

  string (date)
• estimated_completion_date

  string (date)
• estimated_value

  string (float)
• code

  string
• sector

  string
• work_scope

  string
• delivery_method

  string
• created_by

  object
• persistent_message

  object
• office

  object
• project_bid_type_id

  integer
• project_bid_type

  object
• project_owner_type_id

  integer
• project_owner_type

  object
• project_region_id

  integer
• project_region

  object
• project_stage_id

  integer
• project_stage

  object
• project_type

  object
• program

  object
• departments

  object[]
• company

  object
• dictionary_type

  string
• custom_fields

  object
• project_sector_id

  integer

Create project

Parameters

• company_id

  integerquery
• OS-Company-Id

  integerheader

Request body

• company_id

  integer
• project

  objectrequired

Response · 201 · object

• id

  integer
• logo_id

  integer
• logo_url

  string
• name

  string
• is_demo

  boolean
• template

  boolean
• display_name

  string
• project_number

  string
• address

  string
• city

  string
• state_code

  string
• country_code

  string
• zip

  string
• time_zone

  string
• tz_name

  string
• latitude

  number (float)
• longitude

  number (float)
• county

  string
• parent_job_id

  integer
• parent_job

  object
• from_project_template_id

  integer
• square_feet

  integer
• start_date

  string (date)
• completion_date

  string (date)
• total_value

  string (float)
• store_number

  string
• accounting_project_number

  string
• designated_market_area

  string
• warranty_start_date

  string (date)
• warranty_end_date

  string (date)
• active

  boolean
• flag

  string
• locale

  string
• phone

  string
• public_notes

  string
• actual_start_date

  string (date)
• projected_finish_date

  string (date)
• created_at

  string (date-time)
• updated_at

  string (date-time)
• origin_id

  string
• origin_data

  string
• origin_code

  string
• standard_cost_code_list_id

  integer
• is_erp_integrated

  boolean
• owners_project_id

  integer
• photo_id

  integer
• photo_url

  string
• inbound_email

  string
• inbound_email_address

  string (email)
• estimated_start_date

  string (date)
• estimated_completion_date

  string (date)
• estimated_value

  string (float)
• code

  string
• sector

  string
• work_scope

  string
• delivery_method

  string
• created_by

  object
• persistent_message

  object
• office

  object
• project_bid_type_id

  integer
• project_bid_type

  object
• project_owner_type_id

  integer
• project_owner_type

  object
• project_region_id

  integer
• project_region

  object
• project_stage_id

  integer
• project_stage

  object
• project_type

  object
• program

  object
• departments

  object[]
• company

  object
• dictionary_type

  string
• custom_fields

  object
• project_sector_id

  integer

GET projects/{id}

Parameters

• id

  stringpathrequired

Response · 200 · object

• id

  integer
• logo_id

  integer
• logo_url

  string
• name

  string
• is_demo

  boolean
• template

  boolean
• display_name

  string
• project_number

  string
• address

  string
• city

  string
• state_code

  string
• country_code

  string
• zip

  string
• time_zone

  string
• tz_name

  string
• latitude

  number (float)
• longitude

  number (float)
• county

  string
• parent_job_id

  integer
• parent_job

  object
• from_project_template_id

  integer
• square_feet

  integer
• start_date

  string (date)
• completion_date

  string (date)
• total_value

  string (float)
• store_number

  string
• accounting_project_number

  string
• designated_market_area

  string
• warranty_start_date

  string (date)
• warranty_end_date

  string (date)
• active

  boolean
• flag

  string
• locale

  string
• phone

  string
• public_notes

  string
• actual_start_date

  string (date)
• projected_finish_date

  string (date)
• created_at

  string (date-time)
• updated_at

  string (date-time)
• origin_id

  string
• origin_data

  string
• origin_code

  string
• standard_cost_code_list_id

  integer
• is_erp_integrated

  boolean
• owners_project_id

  integer
• photo_id

  integer
• photo_url

  string
• inbound_email

  string
• inbound_email_address

  string (email)
• estimated_start_date

  string (date)
• estimated_completion_date

  string (date)
• estimated_value

  string (float)
• code

  string
• sector

  string
• work_scope

  string
• delivery_method

  string
• created_by

  object
• persistent_message

  object
• office

  object
• project_bid_type_id

  integer
• project_bid_type

  object
• project_owner_type_id

  integer
• project_owner_type

  object
• project_region_id

  integer
• project_region

  object
• project_stage_id

  integer
• project_stage

  object
• project_type

  object
• program

  object
• departments

  object[]
• company

  object
• dictionary_type

  string
• custom_fields

  object
• project_sector_id

  integer

PATCH projects/{id}

Parameters

• id

  stringpathrequired

Request body

• company_id

  integerrequired
• project

  objectrequired

Response · 200 · object

• id

  integer
• logo_id

  integer
• logo_url

  string
• name

  string
• is_demo

  boolean
• template

  boolean
• display_name

  string
• project_number

  string
• address

  string
• city

  string
• state_code

  string
• country_code

  string
• zip

  string
• time_zone

  string
• tz_name

  string
• latitude

  number (float)
• longitude

  number (float)
• county

  string
• parent_job_id

  integer
• parent_job

  object
• from_project_template_id

  integer
• square_feet

  integer
• start_date

  string (date)
• completion_date

  string (date)
• total_value

  string (float)
• store_number

  string
• accounting_project_number

  string
• designated_market_area

  string
• warranty_start_date

  string (date)
• warranty_end_date

  string (date)
• active

  boolean
• flag

  string
• locale

  string
• phone

  string
• public_notes

  string
• actual_start_date

  string (date)
• projected_finish_date

  string (date)
• created_at

  string (date-time)
• updated_at

  string (date-time)
• origin_id

  string
• origin_data

  string
• origin_code

  string
• standard_cost_code_list_id

  integer
• is_erp_integrated

  boolean
• owners_project_id

  integer
• photo_id

  integer
• photo_url

  string
• inbound_email

  string
• inbound_email_address

  string (email)
• estimated_start_date

  string (date)
• estimated_completion_date

  string (date)
• estimated_value

  string (float)
• code

  string
• sector

  string
• work_scope

  string
• delivery_method

  string
• created_by

  object
• persistent_message

  object
• office

  object
• project_bid_type_id

  integer
• project_bid_type

  object
• project_owner_type_id

  integer
• project_owner_type

  object
• project_region_id

  integer
• project_region

  object
• project_stage_id

  integer
• project_stage

  object
• project_type

  object
• program

  object
• departments

  object[]
• company

  object
• dictionary_type

  string
• custom_fields

  object
• project_sector_id

  integer

GET projects/{project_id}/permission_templates

Parameters

• project_id

  stringpathrequired

Response · 200 · object[]

• id

  integer
• name

  string
• project_specific

  boolean
• type

  string
• category

  string

GET sub_jobs

Response · 200 · object[]

• origin_id

  string
• origin_code

  string
• origin_data

  string
• created_at

  string (date-time)
• updated_at

  string (date-time)
• id

  integer
• name

  string
• code

  string

POST sub_jobs

Request body

• sub_job

  objectrequired

Response · 201 · object

• origin_id

  string
• origin_code

  string
• origin_data

  string
• created_at

  string (date-time)
• updated_at

  string (date-time)
• id

  integer
• name

  string
• code

  string

GET sub_jobs/{id}

Parameters

• id

  stringpathrequired

Response · 200 · object

• origin_id

  string
• origin_code

  string
• origin_data

  string
• created_at

  string (date-time)
• updated_at

  string (date-time)
• id

  integer
• name

  string
• code

  string

PATCH sub_jobs/{id}

Parameters

• id

  stringpathrequired

Response · 200 · object

• origin_id

  string
• origin_code

  string
• origin_data

  string
• created_at

  string (date-time)
• updated_at

  string (date-time)
• id

  integer
• name

  string
• code

  string