Esc

↑↓ move↵ openIndex · Pagefind
REST reference · Project Management

Workforce Planning

15 endpoints15 implementedAll modules →
  1. GET /rest/v1.0/companies/{company_id}/crewsList crews
  2. POST /rest/v1.0/companies/{company_id}/crewsCreate a crew
  3. GET /rest/v1.0/companies/{company_id}/crews/{id}Show a crew
  4. PATCH /rest/v1.0/companies/{company_id}/crews/{id}Update a crew
  5. GET /rest/v1.0/companies/{company_id}/peopleList company people (roster)
  6. POST /rest/v1.0/companies/{company_id}/peopleCreate a person
  7. GET /rest/v1.0/companies/{company_id}/people/{id}Show a person
  8. PATCH /rest/v1.0/companies/{company_id}/people/{id}Update a person
  9. GET /rest/v1.0/companies/{company_id}/people/filter_options/tradeTrade filter options
  10. GET /rest/v1.0/companies/{company_id}/people/inactiveList inactive company people
  11. GET /rest/v1.0/projects/{project_id}/workforce/assignmentsList project assignments (optionally by date range)
  12. POST /rest/v1.0/projects/{project_id}/workforce/assignmentsCreate an assignment
  13. GET /rest/v1.0/projects/{project_id}/workforce/assignments/{id}Show an assignment
  14. PATCH /rest/v1.0/projects/{project_id}/workforce/assignments/{id}Update an assignment
  15. GET /rest/v1.0/projects/{project_id}/workforce/assignments/filter_options/crewsCrew filter options for a project
GET /rest/v1.0/companies/{company_id}/crews

List crews

v1.0Implemented

Parameters

  • company_id
    stringpathrequired

Response · 200 · Crew[]

  • id
    integerrequired
  • company_id
    integerrequired
  • name
    stringrequired
  • lead
    PersonStub
  • lead_person_id
    integer
  • employees
    object[]required
  • employee_count
    integer
  • created_by_id
    integer
  • created_by
    UserStub
  • created_at
    string
  • updated_at
    string
POST /rest/v1.0/companies/{company_id}/crews

Create a crew

v1.0Implemented

Parameters

  • company_id
    stringpathrequired

Request body

  • crew
    objectrequired

Response · 201 · Crew

  • id
    integerrequired
  • company_id
    integerrequired
  • name
    stringrequired
  • lead
    PersonStub
  • lead_person_id
    integer
  • employees
    object[]required
  • employee_count
    integer
  • created_by_id
    integer
  • created_by
    UserStub
  • created_at
    string
  • updated_at
    string
GET /rest/v1.0/companies/{company_id}/crews/{id}

Show a crew

v1.0Implemented

Parameters

  • company_id
    stringpathrequired
  • id
    stringpathrequired

Response · 200 · Crew

  • id
    integerrequired
  • company_id
    integerrequired
  • name
    stringrequired
  • lead
    PersonStub
  • lead_person_id
    integer
  • employees
    object[]required
  • employee_count
    integer
  • created_by_id
    integer
  • created_by
    UserStub
  • created_at
    string
  • updated_at
    string
PATCH /rest/v1.0/companies/{company_id}/crews/{id}

Update a crew

v1.0Implemented

Parameters

  • company_id
    stringpathrequired
  • id
    stringpathrequired

Request body

  • crew
    objectrequired

Response · 200 · Crew

  • id
    integerrequired
  • company_id
    integerrequired
  • name
    stringrequired
  • lead
    PersonStub
  • lead_person_id
    integer
  • employees
    object[]required
  • employee_count
    integer
  • created_by_id
    integer
  • created_by
    UserStub
  • created_at
    string
  • updated_at
    string
GET /rest/v1.0/companies/{company_id}/people

List company people (roster)

v1.0Implemented

Parameters

  • company_id
    stringpathrequired

Response · 200 · Person[]

  • id
    integerrequired
  • company_id
    integerrequired
  • first_name
    stringrequired
  • last_name
    stringrequired
  • name
    stringrequired
  • job_title
    string
  • trade
    string
  • status
    stringrequired
  • translated_status
    string
  • is_assignable
    booleanrequired
  • employee_id
    string
  • email
    string
  • phone
    string
  • hourly_rate
    number
  • user_id
    integer
  • crew_ids
    integer[]
  • created_at
    string
  • updated_at
    string
  • deleted_at
    string
POST /rest/v1.0/companies/{company_id}/people

Create a person

v1.0Implemented

Parameters

  • company_id
    stringpathrequired

Request body

  • person
    objectrequired

Response · 201 · PersonShow

  • id
    integerrequired
  • company_id
    integerrequired
  • first_name
    stringrequired
  • last_name
    stringrequired
  • name
    stringrequired
  • job_title
    string
  • trade
    string
  • status
    stringrequired
  • translated_status
    string
  • is_assignable
    booleanrequired
  • employee_id
    string
  • email
    string
  • phone
    string
  • hourly_rate
    number
  • user_id
    integer
  • crew_ids
    integer[]
  • created_at
    string
  • updated_at
    string
  • deleted_at
    string
  • crews
    object[]
  • created_by
    UserStub
GET /rest/v1.0/companies/{company_id}/people/{id}

Show a person

v1.0Implemented

Parameters

  • company_id
    stringpathrequired
  • id
    stringpathrequired

Response · 200 · PersonShow

  • id
    integerrequired
  • company_id
    integerrequired
  • first_name
    stringrequired
  • last_name
    stringrequired
  • name
    stringrequired
  • job_title
    string
  • trade
    string
  • status
    stringrequired
  • translated_status
    string
  • is_assignable
    booleanrequired
  • employee_id
    string
  • email
    string
  • phone
    string
  • hourly_rate
    number
  • user_id
    integer
  • crew_ids
    integer[]
  • created_at
    string
  • updated_at
    string
  • deleted_at
    string
  • crews
    object[]
  • created_by
    UserStub
PATCH /rest/v1.0/companies/{company_id}/people/{id}

Update a person

v1.0Implemented

Parameters

  • company_id
    stringpathrequired
  • id
    stringpathrequired

Request body

  • person
    objectrequired

Response · 200 · PersonShow

  • id
    integerrequired
  • company_id
    integerrequired
  • first_name
    stringrequired
  • last_name
    stringrequired
  • name
    stringrequired
  • job_title
    string
  • trade
    string
  • status
    stringrequired
  • translated_status
    string
  • is_assignable
    booleanrequired
  • employee_id
    string
  • email
    string
  • phone
    string
  • hourly_rate
    number
  • user_id
    integer
  • crew_ids
    integer[]
  • created_at
    string
  • updated_at
    string
  • deleted_at
    string
  • crews
    object[]
  • created_by
    UserStub
GET /rest/v1.0/companies/{company_id}/people/filter_options/trade

Trade filter options

v1.0Implemented

Parameters

  • company_id
    stringpathrequired

Response · 200 · FilterOption[]

  • key
    stringrequired
  • value
    stringrequired
GET /rest/v1.0/companies/{company_id}/people/inactive

List inactive company people

v1.0Implemented

Parameters

  • company_id
    stringpathrequired

Response · 200 · Person[]

  • id
    integerrequired
  • company_id
    integerrequired
  • first_name
    stringrequired
  • last_name
    stringrequired
  • name
    stringrequired
  • job_title
    string
  • trade
    string
  • status
    stringrequired
  • translated_status
    string
  • is_assignable
    booleanrequired
  • employee_id
    string
  • email
    string
  • phone
    string
  • hourly_rate
    number
  • user_id
    integer
  • crew_ids
    integer[]
  • created_at
    string
  • updated_at
    string
  • deleted_at
    string
GET /rest/v1.0/projects/{project_id}/workforce/assignments

List project assignments (optionally by date range)

v1.0Implemented

Parameters

  • project_id
    stringpathrequired

Response · 200 · Assignment[]

  • id
    integerrequired
  • company_id
    integerrequired
  • project_id
    integerrequired
  • project_name
    string
  • person_id
    integer
  • person_name
    string
  • crew_id
    integer
  • crew_name
    string
  • start_day
    stringrequired
  • end_day
    string
  • hours_per_day
    number
  • role
    string
  • category_name
    string
  • state
    stringrequired
  • translated_state
    string
  • notes
    string
  • created_by
    UserStub
  • created_at
    string
  • updated_at
    string
POST /rest/v1.0/projects/{project_id}/workforce/assignments

Create an assignment

v1.0Implemented

Parameters

  • project_id
    stringpathrequired

Request body

  • assignment
    objectrequired

Response · 201 · Assignment

  • id
    integerrequired
  • company_id
    integerrequired
  • project_id
    integerrequired
  • project_name
    string
  • person_id
    integer
  • person_name
    string
  • crew_id
    integer
  • crew_name
    string
  • start_day
    stringrequired
  • end_day
    string
  • hours_per_day
    number
  • role
    string
  • category_name
    string
  • state
    stringrequired
  • translated_state
    string
  • notes
    string
  • created_by
    UserStub
  • created_at
    string
  • updated_at
    string
GET /rest/v1.0/projects/{project_id}/workforce/assignments/{id}

Show an assignment

v1.0Implemented

Parameters

  • project_id
    stringpathrequired
  • id
    stringpathrequired

Response · 200 · Assignment

  • id
    integerrequired
  • company_id
    integerrequired
  • project_id
    integerrequired
  • project_name
    string
  • person_id
    integer
  • person_name
    string
  • crew_id
    integer
  • crew_name
    string
  • start_day
    stringrequired
  • end_day
    string
  • hours_per_day
    number
  • role
    string
  • category_name
    string
  • state
    stringrequired
  • translated_state
    string
  • notes
    string
  • created_by
    UserStub
  • created_at
    string
  • updated_at
    string
PATCH /rest/v1.0/projects/{project_id}/workforce/assignments/{id}

Update an assignment

v1.0Implemented

Parameters

  • project_id
    stringpathrequired
  • id
    stringpathrequired

Request body

  • assignment
    objectrequired

Response · 200 · Assignment

  • id
    integerrequired
  • company_id
    integerrequired
  • project_id
    integerrequired
  • project_name
    string
  • person_id
    integer
  • person_name
    string
  • crew_id
    integer
  • crew_name
    string
  • start_day
    stringrequired
  • end_day
    string
  • hours_per_day
    number
  • role
    string
  • category_name
    string
  • state
    stringrequired
  • translated_state
    string
  • notes
    string
  • created_by
    UserStub
  • created_at
    string
  • updated_at
    string
GET /rest/v1.0/projects/{project_id}/workforce/assignments/filter_options/crews

Crew filter options for a project

v1.0Implemented

Parameters

  • project_id
    stringpathrequired

Response · 200 · FilterOption[]

  • key
    stringrequired
  • value
    stringrequired

Ask the OS

Reading this page

Ask anything about this page. Answers use what you're reading as context.

Suggested

    AI · may be imperfect · sample data where shown

    Open file