Get issue

GET/workspaces/{organizationId}/issues/{id}

Authorization

AuthorizationBearer token · headerrequired

Workspace API key (Authorization: Bearer <key>). Issue keys under Settings → Developer or POST /workspaces/{organizationId}/tokens.

Path parameters

organizationIdstringrequired

idstringrequired

Responses

200

Issue

idstringrequired

organizationIdstringrequired

externalRefstring | nullrequired

teamIdstringrequired

titlestringrequired

descriptionstring | nullrequired

statusstringrequired

Allowed:triagebacklogtodoin_progressdonecanceled

prioritystringrequired

Allowed:lowmediumhighurgent

resolutionstring | nullrequired

Allowed:duplicatenot_plannedintended_behaviornot_reproducibleobsoleteresolvedskippednull

resolutionReasonstring | nullrequired

parentIdstring | nullrequired

subIssueSortOrdernumber | nullrequired

estimatenumber | nullrequired

isDraftbooleanrequired

sensitivebooleanrequired

snoozedUntilstring | nullrequired

assigneeIdstring | nullrequired

delegateIdstring | nullrequired

stepKeystring | nullrequired

requiredbooleanrequired

ownerAgentstring | nullrequired

claimedBystring | nullrequired

claimedLeaseExpiresAtstring | nullrequired

claimEpochnumberrequired

projectIdstring | nullrequired

cycleIdstring | nullrequired

labelIdsstring[]required

numbernumber | nullrequired

identifierstring | nullrequired

repostring | nullrequired

branchstring | nullrequired

prUrlstring | nullrequired

prStatestring | nullrequired

prCheckStatestring | nullrequired

createdAtstringrequired

updatedAtstringrequired

subStepProgressobject | null

Show properties

totalintegerrequired

doneintegerrequired

blockedintegerrequired

ownerAgentstring | nullrequired

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer tokenRemember on this deviceInclude my values in samples

Parameters

organizationIdpath*idpath*

Request

curl -X GET 'https://pile.nyc/workspaces/string/issues/string' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'

const response = await fetch("https://pile.nyc/workspaces/string/issues/string", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json"
  }
});

import requests

response = requests.get(
    "https://pile.nyc/workspaces/string/issues/string",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Accept": "application/json"
    },
)

Response

{
  "id": "string",
  "organizationId": "string",
  "externalRef": "string",
  "teamId": "string",
  "title": "string",
  "description": "string",
  "status": "triage",
  "priority": "low",
  "resolution": "duplicate",
  "resolutionReason": "string",
  "parentId": "string",
  "subIssueSortOrder": 0,
  "estimate": 0,
  "isDraft": true,
  "sensitive": true,
  "snoozedUntil": "string",
  "assigneeId": "string",
  "delegateId": "string",
  "stepKey": "string",
  "required": true,
  "ownerAgent": "string",
  "claimedBy": "string",
  "claimedLeaseExpiresAt": "string",
  "claimEpoch": 0,
  "projectId": "string",
  "cycleId": "string",
  "labelIds": [
    "string"
  ],
  "number": 0,
  "identifier": "string",
  "repo": "string",
  "branch": "string",
  "prUrl": "string",
  "prState": "string",
  "prCheckState": "string",
  "createdAt": "string",
  "updatedAt": "string",
  "subStepProgress": {
    "total": 0,
    "done": 0,
    "blocked": 0,
    "ownerAgent": "string"
  }
}