Issues

Resolve an issue by its friendly key (PREFIX-number)

Resolves an issue from its PREFIX-number key (e.g. PLAT-50) within the workspace — the prefix identifies the project, the number the issue. Case-insensitive on the prefix. Backs the friendly issue URL /app/{workspaceSlug}/{PREFIX}-{number} (PLAT-81); 404 on a malformed key or a miss. The two-segment path keeps it clear of the list GET "".

get/api/workspaces/{workspaceId}/issues/by-key/{issueKey}

Request

  • Base URL: https://hiveship.app/api
  • URL: https://hiveship.app/api/api/workspaces/{workspaceId}/issues/by-key/{issueKey}
  • Auth: one of:
    • apiToken (a scheme the document does not define)
    • HTTP bearer
    • API key in cookie hiveship_access

Path parameters

workspaceIdstring required
issueKeystring required

Response

The resolved issue

successboolean required

Changes

No recorded changes to this operation across all 1 revision of this API.