API Changelog

Endpoint:

GET /api/v2/{customer_id}/projects

What changed:

A new paginated endpoint is now available to retrieve projects, replacing the unpaginated

my_projects

endpoint. Supports

page

,

pagesize

,

sort

,

search

, and

include_archived

parameters.

Additional Resources:

Refer to the API documentation in the WebApp under Settings → API Documentation.

Endpoint:

GET /api/v2/{customer_id}/projects/{project_id}/tickets/journals

What changed:

A new endpoint is now available to retrieve journal entries for every ticket the caller can access within a project in a single API call, intended to replace individual per-ticket journal calls during ERP sync integrations. Supports

last_sync_date

for incremental sync and

prop_keys

to filter by journal detail type.

Additional Resources:

Refer to the API documentation in the WebApp under Settings → API Documentation.

Endpoint:

GET /api/v2/{customer_id}/projects/{project_id}/tickets/bulk_create_status

What changed:

A new endpoint is now available to poll the status of a bulk ticket creation job previously enqueued via the

bulk_create

endpoint. Pass the

job_id

returned by

bulk_create

to track progress (

queued

,

processing

,

completed

, or

failed

) along with succeeded/failed counts. Status is retained for 24 hours.

Additional Resources:

Refer to the API documentation in the WebApp under Settings → API Documentation.

Endpoints:

POST /api/v2/{customer_id}/projects/{project_id}/dms/nodes/copy_attachments_to_dms_validation

POST /api/v2/{customer_id}/projects/{project_id}/dms/nodes/copy_attachments_to_dms

What changed:

Two new DMS endpoints are available to copy ticket attachments into DMS in bulk. Use the validation endpoint first to check eligibility (scan status, per-customer attachment limits) before performing the copy operation.

Additional Resources:

Refer to the API documentation in the WebApp under Settings → API Documentation.

Endpoints:

POST /api/v2/{customer_id}/projects/{project_id}/dms/nodes

POST /api/v2/{customer_id}/projects/{project_id}/dms/nodes/{node_id}/versions

What changed:

Added new optional formData parameter

data[attributes][run_id]

(type: string) to both endpoints. When provided as a valid UUID, it is stored on the created file version's metadata and returned verbatim under

file_data.metadata.run_id

.

Additional Resources:

Refer to the API documentation in the WebApp under Settings → API Documentation.

Endpoints:

GET /api/v2/{customer_id}/groups

POST /api/v2/{customer_id}/groups

GET /api/v2/{customer_id}/groups/{id}

PATCH /api/v2/{customer_id}/groups/{id}

DELETE /api/v2/{customer_id}/groups/{id}

What changed:

New V2 endpoints are now available to list, create, view, update, and delete groups. Supports ransack-style search (

q[search_i_cont]

), on-fly filtering, and an optional

remove_users_from_projects

flag on update/delete to cascade-remove members from associated projects.

Additional Resources:

Refer to the API documentation in the WebApp under Settings → API Documentation.

Endpoint:

GET /api/v2/{customer_id}/projects/{project_id}/dms/nodes

What changed:

Added new optional query parameter

filter_by_edit_permissions

(boolean) to scope the listing to nodes the current user may copy files into.

Additional Resources:

Refer to the API documentation in the WebApp under Settings → API Documentation.

Endpoints:

GET /api/v1/{customer_id}/projects/{project_id}/ticket_types_project

GET /api/v1/{customer_id}/projects/{project_id}/ticket_types

GET /api/v2/{customer_id}/projects/{project_id}/ticket_types/ticket_type_project

GET /api/v1/{customer_id}/ticket_types

What changed:

Added new optional query parameters

apply_form_display_permission

and

apply_form_edit_permission

(both boolean) to filter results to only the forms visible to or editable by the caller's role. Watchers bypass both filters.

Additional Resources:

Refer to the API documentation in the WebApp under Settings → API Documentation.

Endpoint:

PUT /api/v1/{customer_id}/projects/{project_id}

What changed:

The

project

body parameter schema has been updated to include a new

schedule-start-date

field.

Additional Resources:

Refer to the API documentation in the WebApp under Settings → API Documentation.

Endpoint:
POST /api/v2/{customer_id}/projects/{project_id}/tickets/bulk_create

What changed:
A new endpoint is now available to create multiple tickets at once within a project.

Additional Resources:
Refer to the API documentation in the WebApp under Settings → API Documentation.

Endpoint:
POST /api/v2/{customer_id}/projects/{project_id}/dms/nodes/copy_to_tickets

What changed:
Added new optional formData parameter data[attributes][ticket_type_id] (type: string) to allow specifying a ticket type when copying files to tickets.

Additional Resources:
Refer to the API documentation in the WebApp under Settings → API Documentation.

Endpoint:
GET /api/v2/{customer_id}/projects/{project_id}/dms/nodes/form_field_attachments

What changed:
Added new optional query parameter filters (type: object) to allow filtering of form field attachment results.

Additional Resources:
Refer to the API documentation in the WebApp under Settings → API Documentation.

Endpoint:
GET /api/v2/{customer_id}/projects/{project_id}/approval_requests

What changed:
The response schema for the 200 success response has been updated. Please refer to the updated documentation for the new response structure.

Additional Resources:
Refer to the API documentation in the WebApp under Settings → API Documentation.

Endpoint:
POST /api/v1/{customer_id}/projects/{project_id}/site_reports/{site_report_uuid}/image

What changed:
The image_data body parameter schema has been updated. Please refer to the updated documentation for the new schema structure.

Additional Resources:
Refer to the API documentation in the WebApp under Settings → API Documentation.

Endpoint:
POST /api/v2/{customer_id}/projects/{project_id}/dms/nodes/copy_to_tickets

What changed:
Added new optional formData parameter data[attributes][ticket_type_id] (type: string) to allow specifying a ticket type when copying files to tickets.

Additional Resources:
Refer to the API documentation in the WebApp under Settings → API Documentation.

Endpoint:
GET /api/v2/{customer_id}/projects/{project_id}/dms/nodes/form_field_attachments

What changed:
Added new optional query parameter filters (type: object) to allow filtering of form field attachment results.

Additional Resources:
Refer to the API documentation in the WebApp under Settings → API Documentation.

Endpoint:
PUT /api/v2/{customer_id}/lists/{id}

What changed:
The optional query parameter save has been removed. Additionally, the list body parameter schema has been updated. Please refer to the updated documentation for the new schema structure.

Additional Resources:
Refer to the API documentation in the WebApp under Settings → API Documentation.

Endpoints:
GET /api/v2/{customer_id}/projects/{project_id}/approval_requests/{id}/can_be_reopened
GET /api/v2/{customer_id}/projects/{project_id}/approval_requests/{id}/load_plan_request
PUT /api/v2/{customer_id}/projects/{project_id}/approval_requests/{id}/update_plan_request
PATCH /api/v2/{customer_id}/projects/{project_id}/approval_requests/{approval_request_id}/approvals
PUT /api/v2/{customer_id}/projects/{project_id}/approval_requests/{approval_request_id}/approvals/plans
GET /api/v2/{customer_id}/projects/{project_id}/approval_requests/for_ticket/{id}

What changed:
Several new endpoints have been added to support extended approval request workflows:

• Check whether an approval request can be reopened.
• Load and update plan-type approval requests.
• Submit approval decisions for both files and plans.
• Load an approval request directly by ticket UUID.

Additional Resources:
Refer to the API documentation in the WebApp under Settings → API Documentation.

Endpoint:
GET /api/v2/{customer_id}/projects/{project_id}/approval_requests

What changed:
The endpoint now documents a 200 response ("Requests Found") with the full response schema.

Additional Resources:
Refer to the API documentation in the WebApp under Settings → API Documentation.

Endpoints:
POST /api/v2/{customer_id}/projects/{project_id}/approval_requests/version
POST /api/v2/{customer_id}/projects/{project_id}/approval_requests
POST /api/v2/{customer_id}/projects/{project_id}/approval_requests/validate_nodes

What changed:
The request body parameter schema has been updated across all three approval request creation and validation endpoints. Please refer to the updated documentation for the new schema structure.

Additional Resources:
Refer to the API documentation in the WebApp under Settings → API Documentation.

Endpoint:
GET /api/v2/{customer_id}/roles

What changed:
A new V2 endpoint for retrieving all roles for a customer is now available.

Additional Resources:
Refer to the API documentation in the WebApp under Settings → API Documentation.

Endpoints:
POST /api/v2/{customer_id}/projects/{project_id}/dms/nodes/copy_to_tickets_validation
POST /api/v2/{customer_id}/projects/{project_id}/dms/nodes/copy_to_tickets

What changed:
Two new DMS endpoints are available to support copying files to tickets. Use the validation endpoint first to check eligibility before performing the copy operation.

Additional Resources:
Refer to the API documentation in the WebApp under Settings → API Documentation.

Endpoint:
GET /api/v2/{customer_id}/projects/{project_id}/dms/nodes/ticket_attachments

What changed:
Added new optional query parameter filters (type: object) to allow filtering of ticket attachment results.

Additional Resources:
Refer to the API documentation in the WebApp under Settings → API Documentation.

Endpoint:
GET /api/v2/{customer_id}/projects/{project_id}/filters/filterable_fields

What changed:
A new endpoint is now available to retrieve all filterable fields for a specific filter type within a project.

Additional Resources:
Refer to the API documentation in the WebApp under Settings → API Documentation.

Endpoints:
GET /api/v2/{customer_id}/projects/{project_id}/tickets/{uuid}/single_ticket_export
POST /api/v2/{customer_id}/projects/{project_id}/tickets/export/pdf

What changed:
Added new optional query parameter async (boolean) to both endpoints to enable asynchronous export processing.

Additional Resources:
Refer to the API documentation in the WebApp under Settings → API Documentation.

Endpoint:
POST /api/v1/{customer_id}/projects/{project_id}/ticket_imports

What changed:
Added new optional formData parameter data[][attributes][file_name] (type: string) to allow specifying a file name when uploading ticket import files.

Additional Resources:
Refer to the API documentation in the WebApp under Settings → API Documentation.

Endpoints:
PUT /api/v2/{customer_id}/projects/{project_id}/tickets/batch_update
POST /api/v2/{customer_id}/projects/{project_id}/tickets/batch_delete

What changed:
The body parameter schemas for multi_update_object and multi_delete_object have been updated. Please refer to the updated documentation for the new schema structure.

Additional Resources:
Refer to the API documentation in the WebApp under Settings → API Documentation.

Endpoint:
POST /api/v1/{customer_id}/projects

What changed:
The project body parameter schema has been updated. Please refer to the updated documentation for the new schema structure.

Additional Resources:
Refer to the API documentation in the WebApp under Settings → API Documentation.

Endpoint:
GET /api/v2/{customer_id}/projects/{project_id}/tickets/{ticket_uuid}/attachments

What changed:
Added new optional query parameter only_ticket_attachments (boolean) to return only ticket-level attachments when set to true.

Additional Resources:
Refer to the API documentation in the WebApp under Settings → API Documentation.

Endpoints:
POST /api/v2/{customer_id}/projects/{project_id}/tickets/export/xls

What changed:
Added new optional query parameter async (boolean) to enable asynchronous export processing.

Additional Resources:
Refer to the API documentation in the WebApp under Settings → API Documentation.

Endpoint:
PUT /api/v2/{customer_id}/projects/{project_id}/tickets/{uuid}

What changed:
Added new optional query parameter clean_up_assets (boolean) to allow removal of related assets during ticket updates.

Additional Resources:
Refer to the API documentation in the WebApp under Settings → API Documentation.