Esc

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

Action Plans

27 endpoints27 implementedAll modules →
  1. GET /rest/v1.0/companies/{company_id}/action_plans/plan_templates
  2. POST /rest/v1.0/companies/{company_id}/action_plans/plan_templates
  3. GET /rest/v1.0/companies/{company_id}/action_plans/plan_templates/{id}
  4. PATCH /rest/v1.0/companies/{company_id}/action_plans/plan_templates/{id}
  5. GET /rest/v1.0/projects/{project_id}/action_plans/filter_options/status
  6. GET /rest/v1.0/projects/{project_id}/action_plans/parties
  7. GET /rest/v1.0/projects/{project_id}/action_plans/plan_approvers
  8. POST /rest/v1.0/projects/{project_id}/action_plans/plan_approvers
  9. GET /rest/v1.0/projects/{project_id}/action_plans/plan_approvers/{plan_approver_id}
  10. PATCH /rest/v1.0/projects/{project_id}/action_plans/plan_approvers/{plan_approver_id}/signature
  11. GET /rest/v1.0/projects/{project_id}/action_plans/plan_receivers
  12. POST /rest/v1.0/projects/{project_id}/action_plans/plan_receivers
  13. GET /rest/v1.0/projects/{project_id}/action_plans/plan_receivers/{plan_receiver_id}
  14. PATCH /rest/v1.0/projects/{project_id}/action_plans/plan_receivers/{plan_receiver_id}/signature
  15. GET /rest/v1.0/projects/{project_id}/action_plans/plans
  16. POST /rest/v1.0/projects/{project_id}/action_plans/plans
  17. GET /rest/v1.0/projects/{project_id}/action_plans/plans/{id}
  18. PATCH /rest/v1.0/projects/{project_id}/action_plans/plans/{id}
  19. GET /rest/v1.0/projects/{project_id}/action_plans/plans/{id}/items
  20. POST /rest/v1.0/projects/{project_id}/action_plans/plans/{id}/items
  21. GET /rest/v1.0/projects/{project_id}/action_plans/plans/{id}/items/{item_id}
  22. PATCH /rest/v1.0/projects/{project_id}/action_plans/plans/{id}/items/{item_id}
  23. PATCH /rest/v1.0/projects/{project_id}/action_plans/plans/{id}/items/{item_id}/assign
  24. POST /rest/v1.0/projects/{project_id}/action_plans/plans/{id}/items/{item_id}/sign_off
  25. DELETE /rest/v1.0/projects/{project_id}/action_plans/plans/{id}/items/{item_id}/sign_off
  26. GET /rest/v1.0/projects/{project_id}/action_plans/plans/recycle_bin
  27. GET /rest/v1.0/projects/{project_id}/action_plans/potential_assignees
GET /rest/v1.0/companies/{company_id}/action_plans/plan_templates

GET companies/{company_id}/action_plans/plan_templates

v1.0Implemented

Parameters

  • company_id
    stringpathrequired

Response · 200 · TemplateListItem[]

  • id
    integerrequired
  • title
    stringrequired
  • description_plain_text
    string
  • status
    stringrequired
  • translated_status
    string
  • template_type
    stringrequired
  • plan_type
    PlanType
  • item_count
    integer
  • created_at
    string
  • updated_at
    string
  • deleted
    boolean
  • deleted_at
    string
POST /rest/v1.0/companies/{company_id}/action_plans/plan_templates

POST companies/{company_id}/action_plans/plan_templates

v1.0Implemented

Parameters

  • company_id
    stringpathrequired

Response · 201 · TemplateShow

  • id
    integerrequired
  • title
    stringrequired
  • description_plain_text
    string
  • status
    stringrequired
  • translated_status
    string
  • template_type
    stringrequired
  • plan_type
    PlanType
  • item_count
    integer
  • created_at
    string
  • updated_at
    string
  • deleted
    boolean
  • deleted_at
    string
  • created_by
    PartyPerson
  • sections
    TemplateSection[]
  • items
    TemplateItem[]
GET /rest/v1.0/companies/{company_id}/action_plans/plan_templates/{id}

GET companies/{company_id}/action_plans/plan_templates/{id}

v1.0Implemented

Parameters

  • company_id
    stringpathrequired
  • id
    stringpathrequired

Response · 200 · TemplateShow

  • id
    integerrequired
  • title
    stringrequired
  • description_plain_text
    string
  • status
    stringrequired
  • translated_status
    string
  • template_type
    stringrequired
  • plan_type
    PlanType
  • item_count
    integer
  • created_at
    string
  • updated_at
    string
  • deleted
    boolean
  • deleted_at
    string
  • created_by
    PartyPerson
  • sections
    TemplateSection[]
  • items
    TemplateItem[]
PATCH /rest/v1.0/companies/{company_id}/action_plans/plan_templates/{id}

PATCH companies/{company_id}/action_plans/plan_templates/{id}

v1.0Implemented

Parameters

  • company_id
    stringpathrequired
  • id
    stringpathrequired

Response · 200 · TemplateShow

  • id
    integerrequired
  • title
    stringrequired
  • description_plain_text
    string
  • status
    stringrequired
  • translated_status
    string
  • template_type
    stringrequired
  • plan_type
    PlanType
  • item_count
    integer
  • created_at
    string
  • updated_at
    string
  • deleted
    boolean
  • deleted_at
    string
  • created_by
    PartyPerson
  • sections
    TemplateSection[]
  • items
    TemplateItem[]
GET /rest/v1.0/projects/{project_id}/action_plans/filter_options/status

GET projects/{project_id}/action_plans/filter_options/status

v1.0Implemented

Parameters

  • project_id
    stringpathrequired

Response · 200 · object[]

  • key
    stringrequired
  • value
    stringrequired
GET /rest/v1.0/projects/{project_id}/action_plans/parties

GET projects/{project_id}/action_plans/parties

v1.0Implemented

Parameters

  • project_id
    stringpathrequired

Response · 200 · ProjectParty[]

  • id
    integerrequired
  • first_name
    string
  • last_name
    string
  • name
    stringrequired
  • user_id
    integerrequired
  • is_employee
    boolean
  • employee_id
    string | null
  • login
    string
  • vendor
    object | null
  • potential_manager
    boolean
  • potential_assignee
    boolean
  • potential_approver
    boolean
  • potential_receiver
    boolean
  • updated_at
    string
GET /rest/v1.0/projects/{project_id}/action_plans/plan_approvers

GET projects/{project_id}/action_plans/plan_approvers

v1.0Implemented

Parameters

  • project_id
    stringpathrequired

Response · 200 · PlanParty[]

  • id
    integerrequired
  • plan_id
    integerrequired
  • party
    PartyPersonrequired
  • signature
    PlanPartySignaturerequired
  • updated_at
    stringrequired
POST /rest/v1.0/projects/{project_id}/action_plans/plan_approvers

POST projects/{project_id}/action_plans/plan_approvers

v1.0Implemented

Parameters

  • project_id
    stringpathrequired

Response · 201 · PlanParty

  • id
    integerrequired
  • plan_id
    integerrequired
  • party
    PartyPersonrequired
  • signature
    PlanPartySignaturerequired
  • updated_at
    stringrequired
GET /rest/v1.0/projects/{project_id}/action_plans/plan_approvers/{plan_approver_id}

GET projects/{project_id}/action_plans/plan_approvers/{plan_approver_id}

v1.0Implemented

Parameters

  • project_id
    stringpathrequired
  • plan_approver_id
    stringpathrequired

Response · 200 · PlanParty

  • id
    integerrequired
  • plan_id
    integerrequired
  • party
    PartyPersonrequired
  • signature
    PlanPartySignaturerequired
  • updated_at
    stringrequired
PATCH /rest/v1.0/projects/{project_id}/action_plans/plan_approvers/{plan_approver_id}/signature

PATCH projects/{project_id}/action_plans/plan_approvers/{plan_approver_id}/signature

v1.0Implemented

Parameters

  • project_id
    stringpathrequired
  • plan_approver_id
    stringpathrequired

Response · 200 · PlanParty

  • id
    integerrequired
  • plan_id
    integerrequired
  • party
    PartyPersonrequired
  • signature
    PlanPartySignaturerequired
  • updated_at
    stringrequired
GET /rest/v1.0/projects/{project_id}/action_plans/plan_receivers

GET projects/{project_id}/action_plans/plan_receivers

v1.0Implemented

Parameters

  • project_id
    stringpathrequired

Response · 200 · PlanParty[]

  • id
    integerrequired
  • plan_id
    integerrequired
  • party
    PartyPersonrequired
  • signature
    PlanPartySignaturerequired
  • updated_at
    stringrequired
POST /rest/v1.0/projects/{project_id}/action_plans/plan_receivers

POST projects/{project_id}/action_plans/plan_receivers

v1.0Implemented

Parameters

  • project_id
    stringpathrequired

Response · 201 · PlanParty

  • id
    integerrequired
  • plan_id
    integerrequired
  • party
    PartyPersonrequired
  • signature
    PlanPartySignaturerequired
  • updated_at
    stringrequired
GET /rest/v1.0/projects/{project_id}/action_plans/plan_receivers/{plan_receiver_id}

GET projects/{project_id}/action_plans/plan_receivers/{plan_receiver_id}

v1.0Implemented

Parameters

  • project_id
    stringpathrequired
  • plan_receiver_id
    stringpathrequired

Response · 200 · PlanParty

  • id
    integerrequired
  • plan_id
    integerrequired
  • party
    PartyPersonrequired
  • signature
    PlanPartySignaturerequired
  • updated_at
    stringrequired
PATCH /rest/v1.0/projects/{project_id}/action_plans/plan_receivers/{plan_receiver_id}/signature

PATCH projects/{project_id}/action_plans/plan_receivers/{plan_receiver_id}/signature

v1.0Implemented

Parameters

  • project_id
    stringpathrequired
  • plan_receiver_id
    stringpathrequired

Response · 200 · PlanParty

  • id
    integerrequired
  • plan_id
    integerrequired
  • party
    PartyPersonrequired
  • signature
    PlanPartySignaturerequired
  • updated_at
    stringrequired
GET /rest/v1.0/projects/{project_id}/action_plans/plans

GET projects/{project_id}/action_plans/plans

v1.0Implemented

Parameters

  • project_id
    stringpathrequired

Response · 200 · PlanListItem[] | integer[]

  • id
    integerrequired
  • number
    integer
  • full_number
    string
  • title
    stringrequired
  • description_plain_text
    string
  • status
    stringrequired
  • status_type
    stringrequired
  • translated_status
    string
  • plan_status
    PlanStatus
  • plan_type
    PlanType
  • private
    boolean
  • manager
    PartyPerson
  • template_id
    integer
  • total_item_count
    integerrequired
  • closed_item_count
    integerrequired
  • progress_percent
    integer
  • specification_section_id
    integer
  • created_at
    string
  • updated_at
    string
  • deleted
    boolean
  • deleted_at
    string
POST /rest/v1.0/projects/{project_id}/action_plans/plans

POST projects/{project_id}/action_plans/plans

v1.0Implemented

Parameters

  • project_id
    stringpathrequired

Response · 201 · PlanShow

  • id
    integerrequired
  • number
    integer
  • full_number
    string
  • title
    stringrequired
  • description_plain_text
    string
  • status
    stringrequired
  • status_type
    stringrequired
  • translated_status
    string
  • plan_status
    PlanStatus
  • plan_type
    PlanType
  • private
    boolean
  • manager
    PartyPerson
  • template_id
    integer
  • total_item_count
    integerrequired
  • closed_item_count
    integerrequired
  • progress_percent
    integer
  • specification_section_id
    integer
  • created_at
    string
  • updated_at
    string
  • deleted
    boolean
  • deleted_at
    string
  • created_by
    PartyPerson
  • custom_fields
    object
  • plan_approvers
    PlanParty[]
  • plan_receivers
    PlanParty[]
  • specification_section
    object
  • sections
    PlanSection[]
  • items
    PlanItem[]
GET /rest/v1.0/projects/{project_id}/action_plans/plans/{id}

GET projects/{project_id}/action_plans/plans/{id}

v1.0Implemented

Parameters

  • project_id
    stringpathrequired
  • id
    stringpathrequired

Response · 200 · PlanShow

  • id
    integerrequired
  • number
    integer
  • full_number
    string
  • title
    stringrequired
  • description_plain_text
    string
  • status
    stringrequired
  • status_type
    stringrequired
  • translated_status
    string
  • plan_status
    PlanStatus
  • plan_type
    PlanType
  • private
    boolean
  • manager
    PartyPerson
  • template_id
    integer
  • total_item_count
    integerrequired
  • closed_item_count
    integerrequired
  • progress_percent
    integer
  • specification_section_id
    integer
  • created_at
    string
  • updated_at
    string
  • deleted
    boolean
  • deleted_at
    string
  • created_by
    PartyPerson
  • custom_fields
    object
  • plan_approvers
    PlanParty[]
  • plan_receivers
    PlanParty[]
  • specification_section
    object
  • sections
    PlanSection[]
  • items
    PlanItem[]
PATCH /rest/v1.0/projects/{project_id}/action_plans/plans/{id}

PATCH projects/{project_id}/action_plans/plans/{id}

v1.0Implemented

Parameters

  • project_id
    stringpathrequired
  • id
    stringpathrequired

Response · 200 · PlanShow

  • id
    integerrequired
  • number
    integer
  • full_number
    string
  • title
    stringrequired
  • description_plain_text
    string
  • status
    stringrequired
  • status_type
    stringrequired
  • translated_status
    string
  • plan_status
    PlanStatus
  • plan_type
    PlanType
  • private
    boolean
  • manager
    PartyPerson
  • template_id
    integer
  • total_item_count
    integerrequired
  • closed_item_count
    integerrequired
  • progress_percent
    integer
  • specification_section_id
    integer
  • created_at
    string
  • updated_at
    string
  • deleted
    boolean
  • deleted_at
    string
  • created_by
    PartyPerson
  • custom_fields
    object
  • plan_approvers
    PlanParty[]
  • plan_receivers
    PlanParty[]
  • specification_section
    object
  • sections
    PlanSection[]
  • items
    PlanItem[]
GET /rest/v1.0/projects/{project_id}/action_plans/plans/{id}/items

GET projects/{project_id}/action_plans/plans/{id}/items

v1.0Implemented

Parameters

  • project_id
    stringpathrequired
  • id
    stringpathrequired

Response · 200 · PlanItem[]

  • id
    integerrequired
  • plan_id
    integerrequired
  • plan_section_id
    integer
  • title
    stringrequired
  • notes
    string
  • holding_type
    string
  • position
    integer
  • status
    ItemStatusrequired
  • record_type
    string
  • due_at
    string
  • template_item_id
    integer
  • plan_item_assignees
    PlanItemAssignee[]
  • signed_off
    boolean
  • sign_off
    PlanItemSignOff
  • created_at
    string
  • updated_at
    string
POST /rest/v1.0/projects/{project_id}/action_plans/plans/{id}/items

POST projects/{project_id}/action_plans/plans/{id}/items

v1.0Implemented

Parameters

  • project_id
    stringpathrequired
  • id
    stringpathrequired

Response · 201 · PlanItem

  • id
    integerrequired
  • plan_id
    integerrequired
  • plan_section_id
    integer
  • title
    stringrequired
  • notes
    string
  • holding_type
    string
  • position
    integer
  • status
    ItemStatusrequired
  • record_type
    string
  • due_at
    string
  • template_item_id
    integer
  • plan_item_assignees
    PlanItemAssignee[]
  • signed_off
    boolean
  • sign_off
    PlanItemSignOff
  • created_at
    string
  • updated_at
    string
GET /rest/v1.0/projects/{project_id}/action_plans/plans/{id}/items/{item_id}

GET projects/{project_id}/action_plans/plans/{id}/items/{item_id}

v1.0Implemented

Parameters

  • project_id
    stringpathrequired
  • id
    stringpathrequired
  • item_id
    stringpathrequired

Response · 200 · PlanItem

  • id
    integerrequired
  • plan_id
    integerrequired
  • plan_section_id
    integer
  • title
    stringrequired
  • notes
    string
  • holding_type
    string
  • position
    integer
  • status
    ItemStatusrequired
  • record_type
    string
  • due_at
    string
  • template_item_id
    integer
  • plan_item_assignees
    PlanItemAssignee[]
  • signed_off
    boolean
  • sign_off
    PlanItemSignOff
  • created_at
    string
  • updated_at
    string
PATCH /rest/v1.0/projects/{project_id}/action_plans/plans/{id}/items/{item_id}

PATCH projects/{project_id}/action_plans/plans/{id}/items/{item_id}

v1.0Implemented

Parameters

  • project_id
    stringpathrequired
  • id
    stringpathrequired
  • item_id
    stringpathrequired

Response · 200 · PlanItem

  • id
    integerrequired
  • plan_id
    integerrequired
  • plan_section_id
    integer
  • title
    stringrequired
  • notes
    string
  • holding_type
    string
  • position
    integer
  • status
    ItemStatusrequired
  • record_type
    string
  • due_at
    string
  • template_item_id
    integer
  • plan_item_assignees
    PlanItemAssignee[]
  • signed_off
    boolean
  • sign_off
    PlanItemSignOff
  • created_at
    string
  • updated_at
    string
PATCH /rest/v1.0/projects/{project_id}/action_plans/plans/{id}/items/{item_id}/assign

PATCH projects/{project_id}/action_plans/plans/{id}/items/{item_id}/assign

v1.0Implemented

Parameters

  • project_id
    stringpathrequired
  • id
    stringpathrequired
  • item_id
    stringpathrequired

Response · 200 · PlanItem

  • id
    integerrequired
  • plan_id
    integerrequired
  • plan_section_id
    integer
  • title
    stringrequired
  • notes
    string
  • holding_type
    string
  • position
    integer
  • status
    ItemStatusrequired
  • record_type
    string
  • due_at
    string
  • template_item_id
    integer
  • plan_item_assignees
    PlanItemAssignee[]
  • signed_off
    boolean
  • sign_off
    PlanItemSignOff
  • created_at
    string
  • updated_at
    string
POST /rest/v1.0/projects/{project_id}/action_plans/plans/{id}/items/{item_id}/sign_off

POST projects/{project_id}/action_plans/plans/{id}/items/{item_id}/sign_off

v1.0Implemented

Parameters

  • project_id
    stringpathrequired
  • id
    stringpathrequired
  • item_id
    stringpathrequired

Response · 200 · PlanItem

  • id
    integerrequired
  • plan_id
    integerrequired
  • plan_section_id
    integer
  • title
    stringrequired
  • notes
    string
  • holding_type
    string
  • position
    integer
  • status
    ItemStatusrequired
  • record_type
    string
  • due_at
    string
  • template_item_id
    integer
  • plan_item_assignees
    PlanItemAssignee[]
  • signed_off
    boolean
  • sign_off
    PlanItemSignOff
  • created_at
    string
  • updated_at
    string
DELETE /rest/v1.0/projects/{project_id}/action_plans/plans/{id}/items/{item_id}/sign_off

DELETE projects/{project_id}/action_plans/plans/{id}/items/{item_id}/sign_off

v1.0Implemented

Parameters

  • project_id
    stringpathrequired
  • id
    stringpathrequired
  • item_id
    stringpathrequired

Response · 200 · PlanItem

  • id
    integerrequired
  • plan_id
    integerrequired
  • plan_section_id
    integer
  • title
    stringrequired
  • notes
    string
  • holding_type
    string
  • position
    integer
  • status
    ItemStatusrequired
  • record_type
    string
  • due_at
    string
  • template_item_id
    integer
  • plan_item_assignees
    PlanItemAssignee[]
  • signed_off
    boolean
  • sign_off
    PlanItemSignOff
  • created_at
    string
  • updated_at
    string
GET /rest/v1.0/projects/{project_id}/action_plans/plans/recycle_bin

GET projects/{project_id}/action_plans/plans/recycle_bin

v1.0Implemented

Parameters

  • project_id
    stringpathrequired

Response · 200 · PlanListItem[]

  • id
    integerrequired
  • number
    integer
  • full_number
    string
  • title
    stringrequired
  • description_plain_text
    string
  • status
    stringrequired
  • status_type
    stringrequired
  • translated_status
    string
  • plan_status
    PlanStatus
  • plan_type
    PlanType
  • private
    boolean
  • manager
    PartyPerson
  • template_id
    integer
  • total_item_count
    integerrequired
  • closed_item_count
    integerrequired
  • progress_percent
    integer
  • specification_section_id
    integer
  • created_at
    string
  • updated_at
    string
  • deleted
    boolean
  • deleted_at
    string
GET /rest/v1.0/projects/{project_id}/action_plans/potential_assignees

GET projects/{project_id}/action_plans/potential_assignees

v1.0Implemented

Parameters

  • project_id
    stringpathrequired

Response · 200 · object[]

  • id
    integerrequired
  • login
    stringrequired
  • name
    stringrequired
  • locale
    string

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