Esc

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

Meetings

36 endpoints18 implementedAll modules →
  1. GET /rest/v1.0/companies/{company_id}/meeting_templatesList Meeting Templates
  2. GET /rest/v1.0/companies/{company_id}/meeting_templates/{id}Show a Meeting Template
  3. POST /rest/v1.0/meeting_attendee_recordsCreate meeting attendee record
  4. PATCH /rest/v1.0/meeting_attendee_records/{id}Update meeting attendee record
  5. DELETE /rest/v1.0/meeting_attendee_records/{id}Delete meeting attendee record
  6. GET /rest/v1.0/meeting_categoriesList meeting categories
  7. POST /rest/v1.0/meeting_categoriesCreate meeting category
  8. PATCH /rest/v1.0/meeting_categories/{id}Update meeting category
  9. POST /rest/v1.0/meeting_topicsCreate meeting topic
  10. PATCH /rest/v1.0/meeting_topics/{id}Update meeting topic
  11. GET /rest/v1.0/meeting_topics/parent_minutesGet the minutes and date created for all parent topics
  12. GET /rest/v1.0/meetingsList meetings
  13. POST /rest/v1.0/meetingsCreate meeting
  14. GET /rest/v1.0/meetings/{id}Show meeting
  15. PATCH /rest/v1.0/meetings/{id}Update meeting
  16. DELETE /rest/v1.0/meetings/{id}Delete meeting
  17. GET /rest/v1.0/meetings/ecrion_pdf_generation_dataList Ecrion Xml and Template for Meetings
  18. POST /rest/v1.1/projects/{project_id}/meeting_topicsCreate meeting topic
  19. PATCH /rest/v1.1/projects/{project_id}/meeting_topics/{id}Update meeting topic
  20. GET /rest/v1.1/projects/{project_id}/meeting_topics/{meeting_topic_id}/parent_minutesGet the minutes and date created for all parent topics
  21. GET /rest/v1.1/projects/{project_id}/meetingsList meetings
  22. POST /rest/v1.1/projects/{project_id}/meetingsCreate meeting
  23. GET /rest/v1.1/projects/{project_id}/meetings/{id}Show meeting
  24. PATCH /rest/v1.1/projects/{project_id}/meetings/{id}Update meeting
  25. DELETE /rest/v1.1/projects/{project_id}/meetings/{id}Delete meeting
  26. GET /rest/v1.1/projects/{project_id}/meetings/{id}/distributeList minutes distributions for a meeting
  27. POST /rest/v1.1/projects/{project_id}/meetings/{id}/distributeDistribute a minutes-mode meeting's minutes
  28. POST /rest/v1.1/projects/{project_id}/meetings/{id}/follow_upCreate a follow-up meeting carrying forward open topics
  29. GET /rest/v1.1/projects/{project_id}/meetings/{id}/recurrenceGet a meeting series' recurrence definition and occurrences
  30. POST /rest/v1.1/projects/{project_id}/meetings/{id}/recurrenceDefine a recurrence on a meeting series and generate occurrences
  31. GET /rest/v1.1/projects/{project_id}/meetings/ecrion_pdf_generation_dataList Ecrion Xml and Template for Meetings
  32. GET /rest/v2.0/companies/{company_id}/projects/{project_id}/meetingsList meetings
  33. POST /rest/v2.0/companies/{company_id}/projects/{project_id}/meetingsPOST Meeting
  34. GET /rest/v2.0/companies/{company_id}/projects/{project_id}/meetings/{id}GET Meeting
  35. DELETE /rest/v2.0/companies/{company_id}/projects/{project_id}/meetings/{id}/categories/{category_id}Delete meeting category
  36. GET /rest/v2.0/companies/{company_id}/projects/{project_id}/meetings/{id}/change_historyGet Meeting Change History
GET /rest/v1.0/companies/{company_id}/meeting_templates

List Meeting Templates

v1.0Documented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • company_id
    integerpathrequired
  • page
    integerquery
  • per_page
    integerquery
  • view
    stringquery

Response · 200 · object[]

  • id
    integer
  • name
    string
  • overview
    string
  • private
    boolean
  • agendas
    object[]
  • attachments
    object[]
GET /rest/v1.0/companies/{company_id}/meeting_templates/{id}

Show a Meeting Template

v1.0Documented

Parameters

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

Response · 200 · object

  • id
    integer
  • name
    string
  • overview
    string
  • private
    boolean
  • agendas
    object[]
  • attachments
    object[]
POST /rest/v1.0/meeting_attendee_records

Create meeting attendee record

v1.0Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerqueryrequired
  • meeting_id
    integerqueryrequired

Request body

  • meeting_attendee_record
    objectrequired

Response · 201 · object

  • id
    integer
  • meeting_id
    integer
  • status
    string
  • login_information
    object
PATCH /rest/v1.0/meeting_attendee_records/{id}

Update meeting attendee record

v1.0Implemented

Parameters

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

Request body

  • meeting_attendee_record
    objectrequired

Response · 200 · object

  • id
    integer
  • meeting_id
    integer
  • status
    string
  • login_information
    object
DELETE /rest/v1.0/meeting_attendee_records/{id}

Delete meeting attendee record

v1.0Implemented

Parameters

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

Response · 200

No response body.

GET /rest/v1.0/meeting_categories

List meeting categories

v1.0Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerqueryrequired
  • meeting_id
    integerqueryrequired
  • page
    integerquery
  • per_page
    integerquery

Response · 200 · object[]

  • id
    integer
  • title
    string
  • position
    integer
  • created_by
    object
POST /rest/v1.0/meeting_categories

Create meeting category

v1.0Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired

Request body

  • project_id
    integerrequired
  • meeting_id
    integerrequired
  • meeting_category
    objectrequired

Response · 201 · object

  • id
    integer
  • title
    string
  • position
    integer
  • created_by
    object
PATCH /rest/v1.0/meeting_categories/{id}

Update meeting category

v1.0Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • id
    integerpathrequired

Request body

  • project_id
    integerrequired
  • meeting_id
    integerrequired
  • meeting_category
    objectrequired

Response · 200 · object

  • id
    integer
  • title
    string
  • position
    integer
  • created_by
    object
POST /rest/v1.0/meeting_topics

Create meeting topic

v1.0DocumentedDeprecated: use the Analytics API

Parameters

  • OS-Company-Id
    integerheaderrequired

Request body

  • project_id
    integerrequired
  • meeting_id
    integerrequired
  • meeting_topic
    objectrequired
  • attachments
    string[]

Response · 201 · object

  • id
    integer
  • number
    string
  • created_on
    string (date)
  • position
    integer
  • due_date
    string (date)
  • priority
    string
  • status
    string
  • title
    string
  • minutes
    string
  • meeting_category
    object
  • assignments
    object[]
  • attachments
    object[]
PATCH /rest/v1.0/meeting_topics/{id}

Update meeting topic

v1.0DocumentedDeprecated: use the Analytics API

Parameters

  • OS-Company-Id
    integerheaderrequired
  • id
    integerpathrequired

Request body

  • project_id
    integerrequired
  • meeting_id
    integerrequired
  • meeting_topic
    objectrequired
  • attachments
    string[]

Response · 200 · object

  • id
    integer
  • number
    string
  • created_on
    string (date)
  • position
    integer
  • due_date
    string (date)
  • priority
    string
  • status
    string
  • title
    string
  • minutes
    string
  • meeting_category
    object
  • assignments
    object[]
  • attachments
    object[]
GET /rest/v1.0/meeting_topics/parent_minutes

Get the minutes and date created for all parent topics

v1.0DocumentedDeprecated: use the Analytics API

Parameters

  • OS-Company-Id
    integerheaderrequired
  • meeting_id
    integerqueryrequired
  • meeting_topic_id
    integerqueryrequired

Response · 200 · object[]

  • created_on
    string (date)
  • minutes
    string
  • no_minutes
    boolean
GET /rest/v1.0/meetings

List meetings

v1.0DocumentedDeprecated: use the Analytics API

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerqueryrequired
  • page
    integerquery
  • per_page
    integerquery
  • deleted_only
    booleanquery
  • serializer_view
    stringquery

Response · 200 · object[]

  • group_title
    string
  • meetings
    object[]
POST /rest/v1.0/meetings

Create meeting

v1.0DocumentedDeprecated: use the Analytics API

Parameters

  • OS-Company-Id
    integerheaderrequired

Request body

  • project_id
    integerrequired
  • meeting
    objectrequired
  • attachments
    string[]

Response · 201 · object

  • id
    integer
  • position
    integer
  • created_by_id
    integer
  • title
    string
  • location
    string
  • meeting_date
    string (date)
  • occurred
    boolean
  • start_time
    string
  • finish_time
    string
  • time_zone
    string
  • is_private
    boolean
  • is_draft
    boolean
  • mode
    string
  • remote_meeting_url
    string
  • meeting_template_id
    integer
  • conclusion
    string
  • created_at
    string (date-time)
  • updated_at
    string (date-time)
  • download_all_url
    string
  • attachments
    object[]
  • attendees
    object[]
  • meeting_categories
    object[]
GET /rest/v1.0/meetings/{id}

Show meeting

v1.0DocumentedDeprecated: use the Analytics API

Parameters

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

Response · 200 · object

  • id
    integer
  • position
    integer
  • created_by_id
    integer
  • title
    string
  • location
    string
  • meeting_date
    string (date)
  • occurred
    boolean
  • start_time
    string
  • finish_time
    string
  • time_zone
    string
  • is_private
    boolean
  • is_draft
    boolean
  • mode
    string
  • remote_meeting_url
    string
  • meeting_template_id
    integer
  • conclusion
    string
  • created_at
    string (date-time)
  • updated_at
    string (date-time)
  • download_all_url
    string
  • attachments
    object[]
  • attendees
    object[]
  • meeting_categories
    object[]
PATCH /rest/v1.0/meetings/{id}

Update meeting

v1.0DocumentedDeprecated: use the Analytics API

Parameters

  • OS-Company-Id
    integerheaderrequired
  • id
    integerpathrequired

Request body

  • project_id
    integerrequired
  • meeting
    objectrequired
  • attachments
    string[]

Response · 200 · object

  • id
    integer
  • position
    integer
  • created_by_id
    integer
  • title
    string
  • location
    string
  • meeting_date
    string (date)
  • occurred
    boolean
  • start_time
    string
  • finish_time
    string
  • time_zone
    string
  • is_private
    boolean
  • is_draft
    boolean
  • mode
    string
  • remote_meeting_url
    string
  • meeting_template_id
    integer
  • conclusion
    string
  • created_at
    string (date-time)
  • updated_at
    string (date-time)
  • download_all_url
    string
  • attachments
    object[]
  • attendees
    object[]
  • meeting_categories
    object[]
DELETE /rest/v1.0/meetings/{id}

Delete meeting

v1.0DocumentedDeprecated: use the Analytics API

Parameters

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

Response · 200

No response body.

GET /rest/v1.0/meetings/ecrion_pdf_generation_data

List Ecrion Xml and Template for Meetings

v1.0DocumentedDeprecated: use the Analytics API

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerqueryrequired
  • page
    integerquery
  • per_page
    integerquery

Response · 200 · object

  • pdf_template
    object
  • meetings
    object[]
POST /rest/v1.1/projects/{project_id}/meeting_topics

Create meeting topic

v1.1Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerpathrequired

Request body

  • meeting_id
    integerrequired
  • meeting_topic
    objectrequired
  • attachments
    string[]

Response · 201 · object

  • id
    integer
  • number
    string
  • created_on
    string (date)
  • position
    integer
  • due_date
    string (date)
  • priority
    string
  • status
    string
  • title
    string
  • minutes
    string
  • meeting_category
    object
  • assignments
    object[]
  • attachments
    object[]
PATCH /rest/v1.1/projects/{project_id}/meeting_topics/{id}

Update meeting topic

v1.1Implemented

Parameters

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

Request body

  • meeting_id
    integerrequired
  • meeting_topic
    objectrequired
  • attachments
    string[]

Response · 200 · object

  • id
    integer
  • number
    string
  • created_on
    string (date)
  • position
    integer
  • due_date
    string (date)
  • priority
    string
  • status
    string
  • title
    string
  • minutes
    string
  • meeting_category
    object
  • assignments
    object[]
  • attachments
    object[]
GET /rest/v1.1/projects/{project_id}/meeting_topics/{meeting_topic_id}/parent_minutes

Get the minutes and date created for all parent topics

v1.1Documented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerpathrequired
  • meeting_id
    integerqueryrequired
  • meeting_topic_id
    integerpathrequired

Response · 200 · object[]

  • id
    integer
  • meeting_id
    integer
  • created_on
    string (date)
  • minutes
    string
  • no_minutes
    boolean
  • marked
    boolean
  • meeting_position
    integer
GET /rest/v1.1/projects/{project_id}/meetings

List meetings

v1.1Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerpathrequired
  • page
    integerquery
  • per_page
    integerquery
  • deleted_only
    booleanquery
  • filters[assignee_id]
    integer[]query
  • filters[id]
    integer[]query
  • filters[query]
    stringquery
  • filters[search]
    stringquery
  • serializer_view
    stringquery

Response · 200 · object[] | object

  • group_title
    string
  • meetings
    object[]
POST /rest/v1.1/projects/{project_id}/meetings

Create meeting

v1.1Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerpathrequired

Request body

  • project_id
    integerrequired
  • meeting
    objectrequired
  • attachments
    string[]

Response · 201 · object

  • id
    integer
  • meeting_template_id
    integer
  • position
    integer
  • created_by_id
    integer
  • title
    string
  • location
    string
  • occurred
    boolean
  • starts_at
    string (date-time)
  • ends_at
    string (date-time)
  • time_zone
    string
  • is_private
    boolean
  • is_draft
    boolean
  • mode
    string
  • created_at
    string (date-time)
  • updated_at
    string (date-time)
  • conclusion
    string
  • remote_meeting_url
    string
  • download_all_url
    string
  • attachments
    object[]
  • attendees
    object[]
  • meeting_categories
    object[]
GET /rest/v1.1/projects/{project_id}/meetings/{id}

Show meeting

v1.1Implemented

Parameters

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

Response · 200 · object

  • id
    integer
  • meeting_template_id
    integer
  • position
    integer
  • created_by_id
    integer
  • title
    string
  • location
    string
  • occurred
    boolean
  • starts_at
    string (date-time)
  • ends_at
    string (date-time)
  • time_zone
    string
  • is_private
    boolean
  • is_draft
    boolean
  • mode
    string
  • created_at
    string (date-time)
  • updated_at
    string (date-time)
  • conclusion
    string
  • remote_meeting_url
    string
  • download_all_url
    string
  • attachments
    object[]
  • attendees
    object[]
  • meeting_categories
    object[]
PATCH /rest/v1.1/projects/{project_id}/meetings/{id}

Update meeting

v1.1Implemented

Parameters

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

Request body

  • project_id
    integerrequired
  • meeting
    objectrequired
  • attachments
    string[]

Response · 200 · object

  • id
    integer
  • meeting_template_id
    integer
  • position
    integer
  • created_by_id
    integer
  • title
    string
  • location
    string
  • occurred
    boolean
  • starts_at
    string (date-time)
  • ends_at
    string (date-time)
  • time_zone
    string
  • is_private
    boolean
  • is_draft
    boolean
  • mode
    string
  • created_at
    string (date-time)
  • updated_at
    string (date-time)
  • conclusion
    string
  • remote_meeting_url
    string
  • download_all_url
    string
  • attachments
    object[]
  • attendees
    object[]
  • meeting_categories
    object[]
DELETE /rest/v1.1/projects/{project_id}/meetings/{id}

Delete meeting

v1.1Implemented

Parameters

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

Response · 200

No response body.

GET /rest/v1.1/projects/{project_id}/meetings/{id}/distribute

List minutes distributions for a meeting

v1.1Implemented

Parameters

  • project_id
    integerpathrequired
  • id
    integerpathrequired

Response · 200 · object[]

  • id
    integerrequired
  • meeting_id
    integerrequired
  • sent_at
    string (date-time)required
  • sent_by
    object
  • recipient_ids
    integer[]required
  • recipients
    object[]required
POST /rest/v1.1/projects/{project_id}/meetings/{id}/distribute

Distribute a minutes-mode meeting's minutes

v1.1Implemented

Parameters

  • project_id
    integerpathrequired
  • id
    integerpathrequired

Request body

  • project_id
    integer
  • distribution
    object

Response · 201 · object

  • id
    integerrequired
  • meeting_id
    integerrequired
  • sent_at
    string (date-time)required
  • sent_by
    object
  • recipient_ids
    integer[]required
  • recipients
    object[]required
POST /rest/v1.1/projects/{project_id}/meetings/{id}/follow_up

Create a follow-up meeting carrying forward open topics

v1.1Implemented

Parameters

  • project_id
    integerpathrequired
  • id
    integerpathrequired

Request body

  • project_id
    integer
  • follow_up
    object

Response · 201 · object

  • id
    integer
  • meeting_template_id
    integer
  • position
    integer
  • created_by_id
    integer
  • title
    string
  • location
    string
  • occurred
    boolean
  • starts_at
    string (date-time)
  • ends_at
    string (date-time)
  • time_zone
    string
  • is_private
    boolean
  • is_draft
    boolean
  • mode
    string
  • created_at
    string (date-time)
  • updated_at
    string (date-time)
  • conclusion
    string
  • remote_meeting_url
    string
  • download_all_url
    string
  • attachments
    object[]
  • attendees
    object[]
  • meeting_categories
    object[]
GET /rest/v1.1/projects/{project_id}/meetings/{id}/recurrence

Get a meeting series' recurrence definition and occurrences

v1.1Implemented

Parameters

  • project_id
    integerpathrequired
  • id
    integerpathrequired

Response · 200 · object

  • series_id
    integerrequired
  • cadence
    stringrequired
  • cadence_label
    string
  • interval
    integerrequired
  • start_date
    string (date)
  • count
    integerrequired
  • end_date
    string (date)
  • created_count
    integerrequired
  • occurrences
    object[]required
POST /rest/v1.1/projects/{project_id}/meetings/{id}/recurrence

Define a recurrence on a meeting series and generate occurrences

v1.1Implemented

Parameters

  • project_id
    integerpathrequired
  • id
    integerpathrequired

Request body

  • project_id
    integer
  • recurrence
    objectrequired

Response · 201 · object

  • series_id
    integerrequired
  • cadence
    stringrequired
  • cadence_label
    string
  • interval
    integerrequired
  • start_date
    string (date)
  • count
    integerrequired
  • end_date
    string (date)
  • created_count
    integerrequired
  • occurrences
    object[]required
GET /rest/v1.1/projects/{project_id}/meetings/ecrion_pdf_generation_data

List Ecrion Xml and Template for Meetings

v1.1DocumentedDeprecated: use the Analytics API

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerpathrequired
  • page
    integerquery
  • per_page
    integerquery
  • filters[assignee_id]
    integer[]query
  • filters[id]
    integer[]query
  • filters[public]
    stringquery
  • filters[draft]
    stringquery
  • filters[mode]
    stringquery
  • filters[root_id]
    stringquery
  • filters[roots]
    stringquery
  • filters[template_id]
    stringquery
  • show_attachments
    booleanquery

Response · 200 · object

  • pdf_template
    object
  • meetings
    object[]
GET /rest/v2.0/companies/{company_id}/projects/{project_id}/meetings

List meetings

v2.0Documented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    stringpathrequired
  • company_id
    stringpathrequired
  • page
    integerquery
  • per_page
    integerquery
  • filters[id]
    string[]query
  • filters[assignee_id]
    string[]query
  • filters[title]
    stringquery
  • filters[public]
    stringquery
  • filters[draft]
    stringquery
  • filters[mode]
    stringquery
  • filter[root_id]
    stringquery
  • filters[template_id]
    stringquery
  • filters[from]
    stringquery
  • filters[to]
    stringquery
  • filters[roots]
    stringquery
  • filters[deleted]
    stringquery
  • view
    stringquery
  • sort
    stringquery

Response · 200 · object

  • data
    object[]
  • meta
    object
POST /rest/v2.0/companies/{company_id}/projects/{project_id}/meetings

POST Meeting

v2.0Documented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • company_id
    stringpathrequired
  • project_id
    stringpathrequired

Request body

  • title
    string
  • location
    string
  • overview
    string
  • is_private
    boolean
  • conclusion
    string
  • is_draft
    boolean
  • time_zone
    string
  • remote_meeting_url
    string
  • start_time
    string
  • finish_time
    string
  • meeting_template_id
    string
  • custom_textfield_1
    string
  • custom_textarea_1
    string
  • position
    integer
  • attendees
    integer[]
  • attendee_minutes_approvers
    integer[]
  • create_uncategorized_items_category
    boolean
  • meeting_date
    string
  • starts_at
    string (date-time)
  • ends_at
    string (date-time)
  • view
    string
  • attachment_ids
    string[]
  • drawing_revision_ids
    string[]
  • file_version_ids
    string[]
  • form_ids
    string[]
  • image_ids
    string[]
  • upload_ids
    string[]
  • prostore_file_ids
    integer[]
  • document_management_document_revision_ids
    string[]

Response · 201 · object

  • data
    object
GET /rest/v2.0/companies/{company_id}/projects/{project_id}/meetings/{id}

GET Meeting

v2.0Documented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • company_id
    stringpathrequired
  • project_id
    stringpathrequired
  • id
    stringpathrequired
  • view
    stringquery

Response · 200 · object

  • data
    object
DELETE /rest/v2.0/companies/{company_id}/projects/{project_id}/meetings/{id}/categories/{category_id}

Delete meeting category

v2.0Documented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • company_id
    stringpathrequired
  • project_id
    stringpathrequired
  • id
    stringpathrequired
  • category_id
    stringpathrequired

Response · 204

No response body.

GET /rest/v2.0/companies/{company_id}/projects/{project_id}/meetings/{id}/change_history

Get Meeting Change History

v2.0Documented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • company_id
    stringpathrequired
  • project_id
    stringpathrequired
  • id
    stringpathrequired
  • page
    integerquery
  • per_page
    integerquery
  • sort
    stringquery

Response · 200 · object

  • data
    object[]

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