Esc

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

Correspondence

13 endpoints13 implementedAll modules →
  1. GET /rest/v1.0/companies/{company_id}/generic_toolsList Correspondence Types
  2. POST /rest/v1.0/companies/{company_id}/generic_toolsCreate Correspondence Type
  3. GET /rest/v1.0/companies/{company_id}/generic_tools/{generic_tool_id}Show Correspondence Type
  4. PATCH /rest/v1.0/companies/{company_id}/generic_tools/{generic_tool_id}Update Correspondence Type
  5. GET /rest/v1.0/projects/{project_id}/correspondence_type_itemsList Correspondence Type Items
  6. GET /rest/v1.0/projects/{project_id}/generic_tools/{generic_tool_id}/generic_tool_itemsList Correspondence Items
  7. POST /rest/v1.0/projects/{project_id}/generic_tools/{generic_tool_id}/generic_tool_itemsCreate Correspondence Item
  8. GET /rest/v1.0/projects/{project_id}/generic_tools/{generic_tool_id}/generic_tool_items/{generic_tool_item_id}Show Correspondence Item
  9. PATCH /rest/v1.0/projects/{project_id}/generic_tools/{generic_tool_id}/generic_tool_items/{generic_tool_item_id}Update Correspondence Item
  10. GET /rest/v1.0/projects/{project_id}/generic_tools/{generic_tool_id}/generic_tool_items/{generic_tool_item_id}/generic_tool_item_responsesList Item Responses
  11. POST /rest/v1.0/projects/{project_id}/generic_tools/{generic_tool_id}/generic_tool_items/{generic_tool_item_id}/generic_tool_item_responsesCreate Item Response
  12. GET /rest/v1.0/projects/{project_id}/generic_tools/{generic_tool_id}/generic_tool_items/available_statusesAvailable Statuses
  13. GET /rest/v1.0/projects/{project_id}/recycle_bin/correspondence/itemsRecycle Bin
GET /rest/v1.0/companies/{company_id}/generic_tools

List Correspondence Types

v1.0Implemented

Parameters

  • company_id
    stringpathrequired

Response · 200 · object[]

  • id
    integerrequired
  • title
    string
  • name
    stringrequired
  • abbreviation
    string
  • private_by_default
    boolean
  • active
    booleanrequired
  • in_use
    boolean
  • fields
    object[]
  • statuses
    object[]
  • default_distribution_ids
    integer[]
  • default_due_days
    integer
  • created_at
    string
  • updated_at
    string
POST /rest/v1.0/companies/{company_id}/generic_tools

Create Correspondence Type

v1.0Implemented

Parameters

  • company_id
    stringpathrequired

Response · 201 · object

  • id
    integerrequired
  • title
    string
  • name
    stringrequired
  • abbreviation
    string
  • private_by_default
    boolean
  • active
    booleanrequired
  • in_use
    boolean
  • fields
    object[]
  • statuses
    object[]
  • default_distribution_ids
    integer[]
  • default_due_days
    integer
  • created_at
    string
  • updated_at
    string
GET /rest/v1.0/companies/{company_id}/generic_tools/{generic_tool_id}

Show Correspondence Type

v1.0Implemented

Parameters

  • company_id
    stringpathrequired
  • generic_tool_id
    stringpathrequired

Response · 200 · object

  • id
    integerrequired
  • title
    string
  • name
    stringrequired
  • abbreviation
    string
  • private_by_default
    boolean
  • active
    booleanrequired
  • in_use
    boolean
  • fields
    object[]
  • statuses
    object[]
  • default_distribution_ids
    integer[]
  • default_due_days
    integer
  • created_at
    string
  • updated_at
    string
PATCH /rest/v1.0/companies/{company_id}/generic_tools/{generic_tool_id}

Update Correspondence Type

v1.0Implemented

Parameters

  • company_id
    stringpathrequired
  • generic_tool_id
    stringpathrequired

Response · 200 · object

  • id
    integerrequired
  • title
    string
  • name
    stringrequired
  • abbreviation
    string
  • private_by_default
    boolean
  • active
    booleanrequired
  • in_use
    boolean
  • fields
    object[]
  • statuses
    object[]
  • default_distribution_ids
    integer[]
  • default_due_days
    integer
  • created_at
    string
  • updated_at
    string
GET /rest/v1.0/projects/{project_id}/correspondence_type_items

List Correspondence Type Items

v1.0Implemented

Parameters

  • project_id
    stringpathrequired

Response · 200 · object[]

  • id
    integerrequired
  • number
    stringrequired
  • position
    string
  • title
    stringrequired
  • status
    stringrequired
  • status_type
    string
  • private
    boolean
  • due_date
    string
  • issued_at
    string
  • closed_at
    string
  • created_at
    string
  • updated_at
    string
  • cost_impact
    string
  • schedule_impact
    string
  • generic_tool
    objectrequired
  • created_by
    object
  • assignee
    object
  • assignees
    object[]
  • received_from
    object
  • distribution_members
    object[]
  • location
    object
  • cost_code
    object
  • specification_section
    object
  • custom_fields
    object
GET /rest/v1.0/projects/{project_id}/generic_tools/{generic_tool_id}/generic_tool_items

List Correspondence Items

v1.0Implemented

Parameters

  • project_id
    stringpathrequired
  • generic_tool_id
    stringpathrequired

Response · 200 · object[]

  • id
    integerrequired
  • number
    stringrequired
  • position
    string
  • title
    stringrequired
  • status
    stringrequired
  • status_type
    string
  • private
    boolean
  • due_date
    string
  • issued_at
    string
  • closed_at
    string
  • created_at
    string
  • updated_at
    string
  • cost_impact
    string
  • schedule_impact
    string
  • generic_tool
    objectrequired
  • created_by
    object
  • assignee
    object
  • assignees
    object[]
  • received_from
    object
  • distribution_members
    object[]
  • location
    object
  • cost_code
    object
  • specification_section
    object
  • custom_fields
    object
POST /rest/v1.0/projects/{project_id}/generic_tools/{generic_tool_id}/generic_tool_items

Create Correspondence Item

v1.0Implemented

Parameters

  • project_id
    stringpathrequired
  • generic_tool_id
    stringpathrequired

Response · 201 · object

  • id
    integerrequired
  • number
    stringrequired
  • position
    string
  • title
    stringrequired
  • status
    stringrequired
  • status_type
    string
  • private
    boolean
  • due_date
    string
  • issued_at
    string
  • closed_at
    string
  • created_at
    string
  • updated_at
    string
  • cost_impact
    string
  • schedule_impact
    string
  • generic_tool
    objectrequired
  • created_by
    object
  • assignee
    object
  • assignees
    object[]
  • received_from
    object
  • distribution_members
    object[]
  • location
    object
  • cost_code
    object
  • specification_section
    object
  • custom_fields
    object
  • ball_in_court_ids
    integer[]
  • distribution_member_ids
    integer[]
  • attachments
    object[]
  • responses
    object[]
GET /rest/v1.0/projects/{project_id}/generic_tools/{generic_tool_id}/generic_tool_items/{generic_tool_item_id}

Show Correspondence Item

v1.0Implemented

Parameters

  • project_id
    stringpathrequired
  • generic_tool_id
    stringpathrequired
  • generic_tool_item_id
    stringpathrequired

Response · 200 · object

  • id
    integerrequired
  • number
    stringrequired
  • position
    string
  • title
    stringrequired
  • status
    stringrequired
  • status_type
    string
  • private
    boolean
  • due_date
    string
  • issued_at
    string
  • closed_at
    string
  • created_at
    string
  • updated_at
    string
  • cost_impact
    string
  • schedule_impact
    string
  • generic_tool
    objectrequired
  • created_by
    object
  • assignee
    object
  • assignees
    object[]
  • received_from
    object
  • distribution_members
    object[]
  • location
    object
  • cost_code
    object
  • specification_section
    object
  • custom_fields
    object
  • ball_in_court_ids
    integer[]
  • distribution_member_ids
    integer[]
  • attachments
    object[]
  • responses
    object[]
PATCH /rest/v1.0/projects/{project_id}/generic_tools/{generic_tool_id}/generic_tool_items/{generic_tool_item_id}

Update Correspondence Item

v1.0Implemented

Parameters

  • project_id
    stringpathrequired
  • generic_tool_id
    stringpathrequired
  • generic_tool_item_id
    stringpathrequired

Response · 200 · object

  • id
    integerrequired
  • number
    stringrequired
  • position
    string
  • title
    stringrequired
  • status
    stringrequired
  • status_type
    string
  • private
    boolean
  • due_date
    string
  • issued_at
    string
  • closed_at
    string
  • created_at
    string
  • updated_at
    string
  • cost_impact
    string
  • schedule_impact
    string
  • generic_tool
    objectrequired
  • created_by
    object
  • assignee
    object
  • assignees
    object[]
  • received_from
    object
  • distribution_members
    object[]
  • location
    object
  • cost_code
    object
  • specification_section
    object
  • custom_fields
    object
  • ball_in_court_ids
    integer[]
  • distribution_member_ids
    integer[]
  • attachments
    object[]
  • responses
    object[]
GET /rest/v1.0/projects/{project_id}/generic_tools/{generic_tool_id}/generic_tool_items/{generic_tool_item_id}/generic_tool_item_responses

List Item Responses

v1.0Implemented

Parameters

  • project_id
    stringpathrequired
  • generic_tool_id
    stringpathrequired
  • generic_tool_item_id
    stringpathrequired

Response · 200 · object[]

  • id
    integerrequired
  • item_id
    integerrequired
  • notes
    string
  • official
    boolean
  • status
    stringrequired
  • created_at
    string
  • attachments
    any[]
  • created_by
    object
POST /rest/v1.0/projects/{project_id}/generic_tools/{generic_tool_id}/generic_tool_items/{generic_tool_item_id}/generic_tool_item_responses

Create Item Response

v1.0Implemented

Parameters

  • project_id
    stringpathrequired
  • generic_tool_id
    stringpathrequired
  • generic_tool_item_id
    stringpathrequired

Response · 201 · object

  • id
    integerrequired
  • item_id
    integerrequired
  • notes
    string
  • official
    boolean
  • status
    stringrequired
  • created_at
    string
  • attachments
    any[]
  • created_by
    object
GET /rest/v1.0/projects/{project_id}/generic_tools/{generic_tool_id}/generic_tool_items/available_statuses

Available Statuses

v1.0Implemented

Parameters

  • project_id
    stringpathrequired
  • generic_tool_id
    stringpathrequired

Response · 200 · object[]

  • value
    stringrequired
  • label
    stringrequired
  • status_type
    string
GET /rest/v1.0/projects/{project_id}/recycle_bin/correspondence/items

Recycle Bin

v1.0Implemented

Parameters

  • project_id
    stringpathrequired

Response · 200 · object[]

  • id
    integerrequired
  • number
    stringrequired
  • position
    string
  • title
    stringrequired
  • status
    stringrequired
  • status_type
    string
  • private
    boolean
  • due_date
    string
  • issued_at
    string
  • closed_at
    string
  • created_at
    string
  • updated_at
    string
  • cost_impact
    string
  • schedule_impact
    string
  • generic_tool
    objectrequired
  • created_by
    object
  • assignee
    object
  • assignees
    object[]
  • received_from
    object
  • distribution_members
    object[]
  • location
    object
  • cost_code
    object
  • specification_section
    object
  • custom_fields
    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