Reports API

Reports are feedback items submitted by users or external systems. Reports can be promoted to issues, dismissed, or reordered on the board. External systems use project tokens to submit reports via the API.

Requires the Reports feature

Report creation is only available when the Reports feature is enabled for your workspace. If it is disabled, requests return 403 with "feature_restricted": true.

Submitting reports from an external system?

The Sending Reports guide walks through minting a token, posting a report, and triaging it on the board.

Permissions

Action	Required Permission	Scope
List	Reports: Read	Reports within accessible projects
Create	Reports: Create	Within accessible projects (or via project token)
Promote	Reports: Update	Reports within accessible projects
Dismiss	Reports: Update	Reports within accessible projects
Reorder	Reports: Update	Reports within accessible projects
Delete	Reports: Delete	Reports within accessible projects
Upload attachment	Attachments: Create	Attachments on reports within accessible projects

Admins and project owners bypass all permission checks for project-scoped resources.

Endpoints

Method	Endpoint	Description
`GET`	`/api/projects/{projectId}/reports`	List reports
`POST`	`/api/projects/{projectId}/reports`	Create a report
`POST`	`/api/projects/{projectId}/reports/promote`	Promote reports to an issue
`POST`	`/api/projects/{projectId}/reports/{reportId}/dismiss`	Dismiss a report
`POST`	`/api/projects/{projectId}/reports/reorder`	Reorder reports
`DELETE`	`/api/projects/{projectId}/reports/{reportId}`	Delete a report
`GET`	`/api/projects/{projectId}/reports/{reportId}/attachments`	List attachments for a report
`POST`	`/api/projects/{projectId}/reports/{reportId}/attachments`	Upload an attachment to a report
`GET`	`/api/projects/{projectId}/reports/{reportId}/attachments/{attachmentId}/download`	Download a report attachment

List Reports

GET /api/projects/{projectId}/reports

Returns all reports for a project, ordered by their display order.

RequestResponse 200

bash

curl https://{tenant}.kendo.dev/api/projects/1/reports \
  -H "Authorization: Bearer your-token"

json

[
  {
    "id": 1,
    "title": "Login button not working on mobile",
    "description": "The login button does not respond to taps on iOS Safari.",
    "source": 1,
    "author_name": "External CI",
    "project_id": 1,
    "created_by": null,
    "promoted_issue_id": null,
    "promoted_at": null,
    "dismissed_at": null,
    "order": 0,
    "attachments_count": 0,
    "created_at": "2026-03-20T10:00:00.000000Z",
    "updated_at": "2026-03-20T10:00:00.000000Z"
  },
  {
    "id": 2,
    "title": "Typo in onboarding flow",
    "description": "Step 3 says 'conifgure' instead of 'configure'.",
    "source": 0,
    "author_name": null,
    "project_id": 1,
    "created_by": 4,
    "promoted_issue_id": null,
    "promoted_at": null,
    "dismissed_at": null,
    "order": 1,
    "attachments_count": 0,
    "created_at": "2026-03-21T08:30:00.000000Z",
    "updated_at": "2026-03-21T08:30:00.000000Z"
  }
]

Create Report

POST /api/projects/{projectId}/reports

Creates a new report. For external submission over the API, authenticate with a project token carrying the report:create ability — personal access tokens cannot create reports through the API. Reports created this way are tagged source: 1 (Api) with created_by: null.

Reports filed by a signed-in user inside the kendo app are tagged source: 0 (Manual), with created_by set to that user.

Request Fields

Field	Type	Required	Description
`title`	string	Yes	Report title, max 255 characters
`description`	string	Yes	Report description, max 65,535 characters
`author_name`	string	No	Name of the external reporter
`files`	file[]	No	Up to 5 image attachments (jpg, jpeg, png, gif, webp, bmp, tiff; max 3 MB each)

RequestResponse 201

bash

curl -X POST https://{tenant}.kendo.dev/api/projects/1/reports \
  -H "Authorization: Bearer your-project-token" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Login button not working on mobile",
    "description": "The login button does not respond to taps on iOS Safari.",
    "author_name": "External CI"
  }'

json

{
  "id": 1,
  "title": "Login button not working on mobile",
  "description": "The login button does not respond to taps on iOS Safari.",
  "source": 1,
  "author_name": "External CI",
  "project_id": 1,
  "created_by": null,
  "promoted_issue_id": null,
  "promoted_at": null,
  "dismissed_at": null,
  "order": 0,
  "attachments_count": 0,
  "created_at": "2026-03-20T10:00:00.000000Z",
  "updated_at": "2026-03-20T10:00:00.000000Z"
}

With File Attachments

When uploading files, use multipart/form-data instead of JSON:

bash

curl -X POST https://{tenant}.kendo.dev/api/projects/1/reports \
  -H "Authorization: Bearer your-token" \
  -F "title=Screenshot of the bug" \
  -F "description=See attached screenshot for details." \
  -F "author_name=External CI" \
  -F "files[0]=@screenshot.png" \
  -F "files[1]=@error-log.png"

The response includes attachments_count reflecting the number of files stored with the report.

Promote Reports

POST /api/projects/{projectId}/reports/promote

Promotes one or more reports into a single issue. The reports are marked as promoted and linked to the newly created issue. Returns the updated reports.

Request Fields

Field	Type	Required	Description
`report_ids`	int[]	Yes	IDs of reports to promote (min 1)
`title`	string	Yes	Issue title, max 255 characters
`description`	string	Yes	Issue description, max 65,535 characters
`lane_id`	int	No	Target lane for the new issue
`priority`	int	No	Priority: 0=Highest, 1=High, 2=Medium, 3=Low, 4=Lowest
`type`	int	No	Type: 0=Feature, 1=Bug
`assignee_id`	int	No	User ID to assign the issue to
`sprint_id`	int	No	Sprint ID to add the issue to
`epic_id`	int	No	Epic ID to link the issue to
`estimated_minutes`	int	No	Time estimate in minutes
`order`	int	No	Display order within the lane
`blocked_by_ids`	int[]	No	IDs of issues that block this issue
`blocks_ids`	int[]	No	IDs of issues that this issue blocks
`label_ids`	int[]	No	Label IDs to attach to the created issue (must belong to the project)

RequestResponse 200

bash

curl -X POST https://{tenant}.kendo.dev/api/projects/1/reports/promote \
  -H "Authorization: Bearer your-token" \
  -H "Content-Type: application/json" \
  -d '{
    "report_ids": [1, 2],
    "title": "Mobile login and onboarding fixes",
    "description": "Combined report: login button broken on iOS + typo in onboarding.",
    "priority": 1,
    "type": 1
  }'

json

[
  {
    "id": 1,
    "title": "Login button not working on mobile",
    "description": "The login button does not respond to taps on iOS Safari.",
    "source": 1,
    "author_name": "External CI",
    "project_id": 1,
    "created_by": null,
    "promoted_issue_id": 42,
    "promoted_at": "2026-03-22T09:00:00.000000Z",
    "dismissed_at": null,
    "order": 0,
    "attachments_count": 0,
    "created_at": "2026-03-20T10:00:00.000000Z",
    "updated_at": "2026-03-22T09:00:00.000000Z"
  },
  {
    "id": 2,
    "title": "Typo in onboarding flow",
    "description": "Step 3 says 'conifgure' instead of 'configure'.",
    "source": 0,
    "author_name": null,
    "project_id": 1,
    "created_by": 4,
    "promoted_issue_id": 42,
    "promoted_at": "2026-03-22T09:00:00.000000Z",
    "dismissed_at": null,
    "order": 1,
    "attachments_count": 0,
    "created_at": "2026-03-21T08:30:00.000000Z",
    "updated_at": "2026-03-22T09:00:00.000000Z"
  }
]

Dismiss Report

POST /api/projects/{projectId}/reports/{reportId}/dismiss

Marks a report as dismissed. Dismissed reports are not deleted but are excluded from the active reports view. This operation is idempotent.

RequestResponse 200

bash

curl -X POST https://{tenant}.kendo.dev/api/projects/1/reports/1/dismiss \
  -H "Authorization: Bearer your-token"

json

{
  "id": 1,
  "title": "Login button not working on mobile",
  "description": "The login button does not respond to taps on iOS Safari.",
  "source": 1,
  "author_name": "External CI",
  "project_id": 1,
  "created_by": null,
  "promoted_issue_id": null,
  "promoted_at": null,
  "dismissed_at": "2026-03-22T10:00:00.000000Z",
  "order": 0,
  "attachments_count": 0,
  "created_at": "2026-03-20T10:00:00.000000Z",
  "updated_at": "2026-03-22T10:00:00.000000Z"
}

Reorder Reports

POST /api/projects/{projectId}/reports/reorder

Updates the display order of reports. Each report's position in the array becomes its new order value (index 0 = order 0, index 1 = order 1, etc.). Returns all reports with updated order.

Request Fields

Field	Type	Required	Description
`report_ids`	int[]	Yes	Report IDs in the desired display order

RequestResponse 200

bash

curl -X POST https://{tenant}.kendo.dev/api/projects/1/reports/reorder \
  -H "Authorization: Bearer your-token" \
  -H "Content-Type: application/json" \
  -d '{
    "report_ids": [2, 1]
  }'

json

[
  {
    "id": 2,
    "title": "Typo in onboarding flow",
    "description": "Step 3 says 'conifgure' instead of 'configure'.",
    "source": 0,
    "author_name": null,
    "project_id": 1,
    "created_by": 4,
    "promoted_issue_id": null,
    "promoted_at": null,
    "dismissed_at": null,
    "order": 0,
    "attachments_count": 0,
    "created_at": "2026-03-21T08:30:00.000000Z",
    "updated_at": "2026-03-22T11:00:00.000000Z"
  },
  {
    "id": 1,
    "title": "Login button not working on mobile",
    "description": "The login button does not respond to taps on iOS Safari.",
    "source": 1,
    "author_name": "External CI",
    "project_id": 1,
    "created_by": null,
    "promoted_issue_id": null,
    "promoted_at": null,
    "dismissed_at": null,
    "order": 1,
    "attachments_count": 0,
    "created_at": "2026-03-20T10:00:00.000000Z",
    "updated_at": "2026-03-22T11:00:00.000000Z"
  }
]

Delete Report

DELETE /api/projects/{projectId}/reports/{reportId}

Returns 204 No Content on success.

bash

curl -X DELETE https://{tenant}.kendo.dev/api/projects/1/reports/1 \
  -H "Authorization: Bearer your-token"

Attachments

Reports support file attachments (images, documents, and other allowed file types). Use these endpoints to manage files after a report has been created — for uploading files at report-creation time, include them in the Create Report files[] field instead.

Upload Attachment

POST /api/projects/{projectId}/reports/{reportId}/attachments

Uploads a single file and links it to the report as a polymorphic attachment. Requires multipart/form-data with a file form field.

Field	Type	Required	Description
`file`	file	Yes	Max 20 MB. Allowed: pdf, doc(x), xls(x), ppt(x), odt/ods/odp, txt, csv, json, xml, md, jpg/jpeg, png, gif, webp, bmp, tiff, mp4, mp3, wav, ogg

Images are automatically converted to WebP server-side for efficient storage; the returned filename reflects the stored file name.

RequestResponse 201

bash

curl -X POST https://{tenant}.kendo.dev/api/projects/1/reports/1/attachments \
  -H "Authorization: Bearer your-token" \
  -F "file=@screenshot.png"

json

{
  "id": 42,
  "filename": "screenshot.webp",
  "mime_type": "image/webp",
  "size": 28417,
  "user_id": 4,
  "created_at": "2026-04-22T09:15:00.000000Z"
}

List Attachments

GET /api/projects/{projectId}/reports/{reportId}/attachments

Returns all attachments linked to a report, ordered by creation time (oldest first).

RequestResponse 200

bash

curl https://{tenant}.kendo.dev/api/projects/1/reports/1/attachments \
  -H "Authorization: Bearer your-token"

json

[
  {
    "id": 42,
    "filename": "screenshot.webp",
    "mime_type": "image/webp",
    "size": 28417,
    "user_id": 4,
    "created_at": "2026-04-22T09:15:00.000000Z"
  }
]

Download Attachment

GET /api/projects/{projectId}/reports/{reportId}/attachments/{attachmentId}/download

Streams the attachment file bytes with a Content-Disposition: attachment header.

bash

curl https://{tenant}.kendo.dev/api/projects/1/reports/1/attachments/42/download \
  -H "Authorization: Bearer your-token" \
  -o screenshot.webp

Common Errors

Status	Cause
`401`	Token is missing, invalid, revoked, or expired
`403`	Token lacks the required permission or ability, or the Reports feature is disabled (`"feature_restricted": true`)
`422`	Request validation failed, or a project token is not linked to (or is inactive for) the target project
`429`	Rate limit exceeded — report endpoints use the default API limit of 120 requests per minute

Enums

Source

Value	Name	Description
`0`	Manual	Submitted by a signed-in user inside the kendo app
`1`	Api	Submitted by an external system using a project token

Reports API ​

Permissions ​

Endpoints ​

List Reports ​

Create Report ​

Request Fields ​

With File Attachments ​

Promote Reports ​

Request Fields ​

Dismiss Report ​

Reorder Reports ​

Request Fields ​

Delete Report ​

Attachments ​

Upload Attachment ​

List Attachments ​

Download Attachment ​

Common Errors ​

Enums ​

Source ​

See Also ​

Reports API

Permissions

Endpoints

List Reports

Create Report

Request Fields

With File Attachments

Promote Reports

Request Fields

Dismiss Report

Reorder Reports

Request Fields

Delete Report

Attachments

Upload Attachment

List Attachments

Download Attachment

Common Errors

Enums

Source

See Also