Read a ticket linked to this Context Capture credential

GET

/integrations/context-capture/v1/tickets/{ticketId}

const url = 'https://example.com/api/integrations/context-capture/v1/tickets/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/api/integrations/context-capture/v1/tickets/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>'

Authorizations

contextCaptureCredential

Parameters

Path Parameters

ticketId

required

string format: uuid

Responses

200

Linked ticket

application/json

object

required

string format: uuid

number

required

integer

>= 1

title

required

string

status

required

string

Allowed values: open closed

stage

required

string

Allowed values: backlog up_next in_progress validation live

priority

required

string

Allowed values: low medium high

revision

required

string format: date-time

updatedAt

required

string format: date-time

portalUrl

required

string format: uri

resolutionType

required

How the ticket was actually resolved, so a customer-facing status can say “merged into HO-n” or “closed, not built” instead of “Resolved”. Every closed ticket lands in stage live regardless of outcome, so stage alone cannot tell a shipped fix from a duplicate/cancelled/wont_fix close. Null on an open ticket, and null on a closed ticket that carries neither a stored resolution nor a merge — absence means “closed, nothing proven”, never “completed”.

string | null

survivingTicketRef

For a duplicate close, the ticket that survived (e.g. HO-11216). Best-effort: no stored duplicate link type exists yet, so this is parsed from the free-prose resolution note and is absent when the note names no ticket. Absent on every non-duplicate resolution.

string | null

401

Not authenticated

application/json

object

error

required

Human-readable error message

string

code

Stable machine-readable error code for client branching

string

fieldErrors

First validation message per field path

object

key

additional properties

string

issues

Structured validation issues (Zod)

Array<object>

object

path

required

string

message

required

string

retryAfter

Seconds until rate limit resets (429 responses)

number

reconnect

True if re-linking GitHub may fix the issue

boolean

404

Not found

application/json

object

error

required

Human-readable error message

string

code

Stable machine-readable error code for client branching

string

fieldErrors

First validation message per field path

object

key

additional properties

string

issues

Structured validation issues (Zod)

Array<object>

object

path

required

string

message

required

string

retryAfter

Seconds until rate limit resets (429 responses)

number

429

Rate limited