Skip to main content
GET
Error

Authorizations

Authorization
string
header
required

The control surface credential. Send Authorization: Bearer <token>.

Two kinds of token are accepted and they are told apart by shape, not by a separate header. A token beginning pbk_ or puk_ is an org scoped API key, whose public half and secret half are generated together and of which only a hash of the secret is ever stored; anything else is treated as an OAuth 2.1 access token and verified against the authorization server's keys.

Both resolve to the same context: an org, a principal and a set of scopes. Nothing downstream branches on which channel you used, with one deliberate exception, key management, which requires a signed-in person so that a key can never mint another key.

Scopes are enforced when MCP tools are REGISTERED rather than when they are called, so a tool your credential cannot use is absent from tools/list rather than refused mid gesture.

Path Parameters

requestId
string
required

Original client request identifier.

Query Parameters

kind
enum<string>
required

Original action kind.

Available options:
order,
cancel,
return,
resume,
topup
quoteId
string

Original action field; required only for its action kind. Optional cancel unitId must match the original individual phone request; omission means the original whole-order action.

orderId
string

Original action field; required only for its action kind. Optional cancel unitId must match the original individual phone request; omission means the original whole-order action.

deviceId
string

Original action field; required only for its action kind. Optional cancel unitId must match the original individual phone request; omission means the original whole-order action.

expectedImpactVersion
string

Original action field; required only for its action kind. Optional cancel unitId must match the original individual phone request; omission means the original whole-order action.

expectedIncarnation
string

Original action field; required only for its action kind. Optional cancel unitId must match the original individual phone request; omission means the original whole-order action.

returnQuoteId
string

Original action field; required only for its action kind. Optional cancel unitId must match the original individual phone request; omission means the original whole-order action.

unitId
string

Original action field; required only for its action kind. Optional cancel unitId must match the original individual phone request; omission means the original whole-order action.

quantity
integer

Original order quantity.

Required range: 1 <= x <= 1000
returnQuantity
integer

Original topup phone selection quantity, paired with returnQuoteId.

Required range: 1 <= x <= 1000
expectedEpoch
integer

Original return/resume service epoch.

Required range: x >= 1

Response

Authoritative durable projection.

found
any
required
kind
enum<string>
required
Available options:
order,
cancel,
return,
resume,
topup
requestId
string
required