Esc

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

Forms

19 endpoints19 implementedAll modules →
  1. GET /rest/v1.0/companies/{company_id}/form_templatesList Company Form Templates
  2. POST /rest/v1.0/companies/{company_id}/form_templatesCreate Company Form Template
  3. GET /rest/v1.0/companies/{company_id}/form_templates/{id}Show Company Form Template
  4. PATCH /rest/v1.0/companies/{company_id}/form_templates/{id}Update Company Form Template
  5. DELETE /rest/v1.0/companies/{company_id}/form_templates/{id}Delete Company Form Template
  6. GET /rest/v1.0/companies/{company_id}/recycle_bin/form_templatesList Recycled Company Form Templates
  7. GET /rest/v1.0/companies/{company_id}/recycle_bin/form_templates/{id}Show Recycled Company Form Template
  8. PATCH /rest/v1.0/companies/{company_id}/recycle_bin/form_templates/{id}/restoreRestore Company Form Template
  9. GET /rest/v1.0/projects/{project_id}/form_templatesList Company Form Templates from Project
  10. GET /rest/v1.0/projects/{project_id}/form_templates/{id}Show Company Form Template from Project
  11. GET /rest/v1.0/projects/{project_id}/formsList Forms on a project
  12. POST /rest/v1.0/projects/{project_id}/formsCreate Form
  13. GET /rest/v1.0/projects/{project_id}/forms/{id}Show Form
  14. PATCH /rest/v1.0/projects/{project_id}/forms/{id}Update Form
  15. DELETE /rest/v1.0/projects/{project_id}/forms/{id}Delete Form
  16. GET /rest/v1.0/projects/{project_id}/recycle_bin/formsList Recycled Project Forms
  17. GET /rest/v1.0/projects/{project_id}/recycle_bin/forms/{id}Show Recycled Project Form
  18. PATCH /rest/v1.0/projects/{project_id}/recycle_bin/forms/{id}/restoreRestore Project Form
  19. GET /rest/v1.1/projects/{project_id}/formsList Forms on a project
GET /rest/v1.0/companies/{company_id}/form_templates

List Company Form Templates

v1.0Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • company_id
    integerpathrequired
  • page
    integerquery
  • per_page
    integerquery
  • filters[id]
    integer[]query
  • filters[created_at]
    string (date)query
  • filters[updated_at]
    string (date)query

Response · 200 · object[]

  • id
    integer
  • name
    string
  • assign_to_new_projects
    boolean
  • created_at
    string (date-time)
  • updated_at
    string (date-time)
  • archived_at
    string (date-time)
  • created_by
    object
  • attachment
    object
  • fillable_pdf
    object
POST /rest/v1.0/companies/{company_id}/form_templates

Create Company Form Template

v1.0Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • company_id
    integerpathrequired

Request body

  • form_template
    objectrequired
  • fillable_pdf
    string (binary)required

Response · 201 · object

  • id
    integer
  • name
    string
  • assign_to_new_projects
    boolean
  • created_at
    string (date-time)
  • updated_at
    string (date-time)
  • archived_at
    string (date-time)
  • created_by
    object
  • attachment
    object
  • fillable_pdf
    object
GET /rest/v1.0/companies/{company_id}/form_templates/{id}

Show Company Form Template

v1.0Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • id
    integerpathrequired
  • company_id
    integerpathrequired

Response · 200 · object

  • id
    integer
  • name
    string
  • assign_to_new_projects
    boolean
  • created_at
    string (date-time)
  • updated_at
    string (date-time)
  • archived_at
    string (date-time)
  • created_by
    object
  • attachment
    object
  • fillable_pdf
    object
PATCH /rest/v1.0/companies/{company_id}/form_templates/{id}

Update Company Form Template

v1.0Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • id
    integerpathrequired
  • company_id
    integerpathrequired

Request body

  • form_template
    objectrequired

Response · 200 · object

  • id
    integer
  • name
    string
  • assign_to_new_projects
    boolean
  • created_at
    string (date-time)
  • updated_at
    string (date-time)
  • archived_at
    string (date-time)
  • created_by
    object
  • attachment
    object
  • fillable_pdf
    object
DELETE /rest/v1.0/companies/{company_id}/form_templates/{id}

Delete Company Form Template

v1.0Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • id
    integerpathrequired
  • company_id
    integerpathrequired

Response · 204

No response body.

GET /rest/v1.0/companies/{company_id}/recycle_bin/form_templates

List Recycled Company Form Templates

v1.0Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • company_id
    integerpathrequired
  • page
    integerquery
  • per_page
    integerquery
  • filters[id]
    integer[]query
  • filters[created_at]
    string (date)query
  • filters[updated_at]
    string (date)query

Response · 200 · object[]

  • id
    integer
  • name
    string
  • assign_to_new_projects
    boolean
  • created_at
    string (date-time)
  • updated_at
    string (date-time)
  • archived_at
    string (date-time)
  • created_by
    object
  • attachment
    object
  • fillable_pdf
    object
GET /rest/v1.0/companies/{company_id}/recycle_bin/form_templates/{id}

Show Recycled Company Form Template

v1.0Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • id
    integerpathrequired
  • company_id
    integerpathrequired

Response · 200 · object

  • id
    integer
  • name
    string
  • assign_to_new_projects
    boolean
  • created_at
    string (date-time)
  • updated_at
    string (date-time)
  • archived_at
    string (date-time)
  • created_by
    object
  • attachment
    object
  • fillable_pdf
    object
PATCH /rest/v1.0/companies/{company_id}/recycle_bin/form_templates/{id}/restore

Restore Company Form Template

v1.0Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • id
    integerpathrequired
  • company_id
    integerpathrequired

Response · 204

No response body.

GET /rest/v1.0/projects/{project_id}/form_templates

List Company Form Templates from Project

v1.0Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerpathrequired
  • page
    integerquery
  • per_page
    integerquery
  • filters[id]
    integer[]query
  • filters[created_at]
    string (date)query
  • filters[updated_at]
    string (date)query

Response · 200 · object[]

  • id
    integer
  • name
    string
  • assign_to_new_projects
    boolean
  • created_at
    string (date-time)
  • updated_at
    string (date-time)
  • archived_at
    string (date-time)
  • created_by
    object
  • attachment
    object
  • fillable_pdf
    object
GET /rest/v1.0/projects/{project_id}/form_templates/{id}

Show Company Form Template from Project

v1.0Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • id
    integerpathrequired
  • project_id
    integerpathrequired

Response · 200 · object

  • id
    integer
  • name
    string
  • assign_to_new_projects
    boolean
  • created_at
    string (date-time)
  • updated_at
    string (date-time)
  • archived_at
    string (date-time)
  • created_by
    object
  • attachment
    object
  • fillable_pdf
    object
GET /rest/v1.0/projects/{project_id}/forms

List Forms on a project

v1.0Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerpathrequired
  • page
    integerquery
  • per_page
    integerquery
  • filters[id]
    integer[]query
  • filters[created_by_id]
    integer[]query
  • filters[form_template_id]
    integer[]query
  • filters[search]
    stringquery
  • filters[created_at]
    string (date)query
  • filters[updated_at]
    string (date)query
  • sort
    stringquery

Response · 200 · object[]

  • id
    integer
  • created_at
    string (date-time)
  • form_template_id
    integer
  • form_template_name
    string
  • name
    string
  • private
    boolean
  • created_by
    object
  • updated_at
    string (date-time)
  • fillable_pdf
    object
  • attachments
    object[]
  • thumbnail_url
    string
  • viewable
    boolean
  • viewable_document_id
    integer
  • holder_class
    string
  • download_all_uuid
    object
  • attachment
    object
  • permissions
    object
  • deleted
    boolean
POST /rest/v1.0/projects/{project_id}/forms

Create Form

v1.0Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerpathrequired

Request body

  • form
    objectrequired

Response · 201 · object

  • id
    integer
  • created_at
    string (date-time)
  • form_template_id
    integer
  • form_template_name
    string
  • name
    string
  • private
    boolean
  • created_by
    object
  • updated_at
    string (date-time)
  • fillable_pdf
    object
  • attachments
    object[]
  • thumbnail_url
    string
  • viewable
    boolean
  • viewable_document_id
    integer
  • holder_class
    string
  • download_all_uuid
    object
  • attachment
    object
  • permissions
    object
  • deleted
    boolean
GET /rest/v1.0/projects/{project_id}/forms/{id}

Show Form

v1.0Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerpathrequired
  • id
    integerpathrequired

Response · 200 · object

  • id
    integer
  • created_at
    string (date-time)
  • form_template_id
    integer
  • form_template_name
    string
  • name
    string
  • private
    boolean
  • created_by
    object
  • updated_at
    string (date-time)
  • fillable_pdf
    object
  • attachments
    object[]
  • thumbnail_url
    string
  • viewable
    boolean
  • viewable_document_id
    integer
  • holder_class
    string
  • download_all_uuid
    object
  • attachment
    object
  • permissions
    object
  • deleted
    boolean
PATCH /rest/v1.0/projects/{project_id}/forms/{id}

Update Form

v1.0Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerpathrequired
  • id
    integerpathrequired
  • send_emails
    booleanquery

Request body

  • form
    objectrequired

Response · 200 · object

  • id
    integer
  • created_at
    string (date-time)
  • form_template_id
    integer
  • form_template_name
    string
  • name
    string
  • private
    boolean
  • created_by
    object
  • updated_at
    string (date-time)
  • fillable_pdf
    object
  • attachments
    object[]
  • thumbnail_url
    string
  • viewable
    boolean
  • viewable_document_id
    integer
  • holder_class
    string
  • download_all_uuid
    object
  • attachment
    object
  • permissions
    object
  • deleted
    boolean
DELETE /rest/v1.0/projects/{project_id}/forms/{id}

Delete Form

v1.0Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerpathrequired
  • id
    integerpathrequired

Response · 200

No response body.

GET /rest/v1.0/projects/{project_id}/recycle_bin/forms

List Recycled Project Forms

v1.0Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerpathrequired
  • page
    integerquery
  • per_page
    integerquery
  • filters[id]
    integer[]query
  • filters[created_at]
    string (date)query
  • filters[updated_at]
    string (date)query

Response · 200 · object[]

  • id
    integer
  • created_at
    string (date-time)
  • form_template_id
    integer
  • form_template_name
    string
  • name
    string
  • private
    boolean
  • created_by
    object
  • updated_at
    string (date-time)
  • fillable_pdf
    object
  • attachments
    object[]
  • thumbnail_url
    string
  • viewable
    boolean
  • viewable_document_id
    integer
  • holder_class
    string
  • download_all_uuid
    object
  • attachment
    object
  • permissions
    object
  • deleted
    boolean
GET /rest/v1.0/projects/{project_id}/recycle_bin/forms/{id}

Show Recycled Project Form

v1.0Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • id
    integerpathrequired
  • project_id
    integerpathrequired

Response · 200 · object

  • id
    integer
  • created_at
    string (date-time)
  • form_template_id
    integer
  • form_template_name
    string
  • name
    string
  • private
    boolean
  • created_by
    object
  • updated_at
    string (date-time)
  • fillable_pdf
    object
  • attachments
    object[]
  • thumbnail_url
    string
  • viewable
    boolean
  • viewable_document_id
    integer
  • holder_class
    string
  • download_all_uuid
    object
  • attachment
    object
  • permissions
    object
  • deleted
    boolean
PATCH /rest/v1.0/projects/{project_id}/recycle_bin/forms/{id}/restore

Restore Project Form

v1.0Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • id
    integerpathrequired
  • project_id
    integerpathrequired

Response · 200 · object

  • id
    integer
  • created_at
    string (date-time)
  • form_template_id
    integer
  • form_template_name
    string
  • name
    string
  • private
    boolean
  • created_by
    object
  • updated_at
    string (date-time)
  • fillable_pdf
    object
  • attachments
    object[]
  • thumbnail_url
    string
  • viewable
    boolean
  • viewable_document_id
    integer
  • holder_class
    string
  • download_all_uuid
    object
  • attachment
    object
  • permissions
    object
  • deleted
    boolean
GET /rest/v1.1/projects/{project_id}/forms

List Forms on a project

v1.1Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerpathrequired
  • page
    integerquery
  • per_page
    integerquery
  • filters[id]
    integer[]query
  • filters[private]
    booleanquery
  • filters[created_by_id]
    integer[]query
  • filters[form_template_id]
    integer[]query
  • filters[search]
    stringquery
  • filters[created_at]
    string (date)query
  • filters[updated_at]
    string (date)query
  • sort
    stringquery

Response · 200 · object[]

  • id
    integer
  • created_at
    string (date-time)
  • form_template_id
    integer
  • form_template_name
    string
  • name
    string
  • private
    boolean
  • created_by
    object
  • updated_at
    string (date-time)
  • fillable_pdf
    object
  • attachments
    object[]
  • thumbnail_url
    string
  • viewable
    boolean
  • viewable_document_id
    integer
  • holder_class
    string
  • download_all_uuid
    object
  • attachment
    object
  • permissions
    object
  • deleted
    boolean

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