List drafts

GET/workspaces/{organizationId}/drafts

Path parameters

organizationIdstringrequired

Query parameters

statusstring

Allowed:pendingpublisheddiscarded

issueIdstring

Responses

200

The workspace draft-review queue — pending agent output awaiting a human publish/discard decision

draftsDraftOutput[]required

Show properties

Array of DraftOutput

idstringrequired

organizationIdstringrequired

entityTypestringrequired

entityIdstringrequired

issueIdstring | nullrequired

kindstringrequired

Allowed:commentfield_changemessage

payloadobjectrequired

statusstringrequired

Allowed:pendingpublisheddiscarded

createdByIdstring | nullrequired

sessionIdstring | nullrequired

reviewedByIdstring | nullrequired

reviewedAtstring | nullrequired

reviewNotestring | nullrequired

publishedCommentIdstring | nullrequired

createdAtstringrequired

updatedAtstringrequired

Try it

Server

Custom base URLOverrides the selected server when set.

Parameters

organizationIdpath*statusqueryissueIdquery

Request

curl -X GET '/workspaces/string/drafts' \
  -H 'Accept: application/json'

const response = await fetch("/workspaces/string/drafts", {
  method: "GET",
  headers: {
    "Accept": "application/json"
  }
});

import requests

response = requests.get(
    "/workspaces/string/drafts",
    headers={
        "Accept": "application/json"
    },
)

Response

{
  "drafts": [
    {
      "id": "string",
      "organizationId": "string",
      "entityType": "string",
      "entityId": "string",
      "issueId": "string",
      "kind": "comment",
      "payload": {
        "property1": null,
        "property2": null
      },
      "status": "pending",
      "createdById": "string",
      "sessionId": "string",
      "reviewedById": "string",
      "reviewedAt": "string",
      "reviewNote": "string",
      "publishedCommentId": "string",
      "createdAt": "string",
      "updatedAt": "string"
    }
  ]
}