plane icon indicating copy to clipboard operation
plane copied to clipboard

[feature]: Include issue-slug in "Get issue by UUID" API call

Open Hope-IT-Works opened this issue 9 months ago • 3 comments

Is there an existing issue for this?

  • [x] I have searched the existing issues

Summary

The issue-slug is not included in the "Get issue by UUID" API call: /api/v1/workspaces/{WORKSPACE_SLUG}/projects/{PROJECT_UUID}/issues/{ISSUE_UUID}

The problem is that you can't generate links to issues this way.

I want to create an integration that links back to the issue: https://{PLANE_BASE_URL}/{WORKSPACE_SLUG}/browse/{ISSUE_SLUG}/

When calling the endpoint, I expected to get the issue-slug, but that was not the case.

Why should this be worked on?

This removes the possibility of creating flexible integrations, which in this example, prevents generating links to issues.

Hope-IT-Works avatar Apr 18 '25 19:04 Hope-IT-Works

Workaround found:

Get identifier from /api/v1/workspaces/{workspace-slug}/projects/{project_id}/ and append - and the sequence_id of the issue.

Hope-IT-Works avatar Apr 18 '25 19:04 Hope-IT-Works

@Hope-IT-Works Yes, that workaround is actually the correct approach — the ISSUE_SLUG is meant to be generated using the project identifier and issue sequence_id joined by a hyphen.

dheeru0198 avatar Apr 19 '25 03:04 dheeru0198

Maybe a note in the API documentation would be great!

Thanks for your response and your work on plane!

Hope-IT-Works avatar Apr 19 '25 03:04 Hope-IT-Works