Show pending approval

How a call kept for the user's approval stands, by its pending_action_id - and how it ended.

Returns how a call stands that waits for approval in the customer panel, by the pending_action_id of its approval_required answer: pending (waits), approved (being carried out), executed (carried out - result is the answer of the call), failed (carried out, result.failure says why), unverified (whether it took effect is not known), declined, expired or cancelled (nothing was done). A secret in the result is answered as the call itself answers it - over MCP withheld (secrets_withheld) - and only to the access that made the call; the main access reading the call of a sub access gets it withheld. Refused when there is no such call (resource_not_found). Changes nothing.

RReadIdempotent
Tool
manitu_approval_geton https://mcp.manitu.de/mcp
POST
/v1/approval/geton https://api.manitu.de
Try it
readOnlyHint truedestructiveHint falseidempotentHint trueopenWorldHint false

Shows how a call stands that the manitu customer account kept for the user's approval, by the pending_action_id of its approval_required answer. status pending: it still waits for the user in the customer panel - ask again later, not more often than about once a minute, and remind the user if needed; approved: being carried out. executed: carried out, result is the answer of the call; failed: carried out, it failed (result.failure says why) - tell the user, do not simply make the call again; unverified: whether it took effect is not known - check before anything else. declined, expired, cancelled: nothing was done. A secret in result (an auth code) is withheld here as by the call itself (secrets_withheld, secret_withheld_list) - the user who made the call sees it in the customer panel; the main access never gets the secret of a call another access made.

Reasons it may answer: resource_not_found.

pending_action_id (required)string

The pending_action_id that approval_required answered, passed as it is.

min length 1max length 40pattern ^[^\x00-\x1F\x7F]*$
pending_action_idstring

The id, not guessable, bound to the account and the access that made it.

min length 1max length 255
statusany

pending: waits for the person; approved: approved, not carried out yet; executed: carried out, result is its answer; failed: carried out, it failed - result says how; unverified: carried out, whether it took effect is not known; declined: the person said no; expired: nobody decided in time; cancelled: the caller withdrew it.

One of pending approved executed failed unverified declined expired cancelled
operation_idstring | nulloptional

The operation of the route export it carries out; null where the backend does not say.

pattern ^[a-z][a-z0-9]*(_[a-z][a-z0-9]*)*$
created_atstring
Format date-time
expires_atstring

Until when it waits for the person.

Format date-time
decided_atstring | nulloptional

When it was approved, declined, cancelled or expired; null while it is pending.

Format date-time
decided_viastring | nulloptional

Where it was decided: panel - the backend's own user interface; api - a call of the backend (cancelled); an open set, lower_snake_case. null while it is pending.

pattern ^[a-z][a-z0-9]*(_[a-z0-9]+)*$
approvalobjectoptional

The approval it waits for - the ways while it is pending, none once it is decided. Not under approval_required, where it stands beside it as params.approval.

approval.required_levelany

The level of approval the call needs (components/1/approval-levels.json). A reader compares ranks, never names.

One of none client_dialog caller_confirmation client_click signed_in_person fresh_second_factor
approval.concernsarray of any

What the approval is about, at least one, each once: terms (a declaration on terms), price (it costs money), contract (a contract is concluded, changed or ended), irreversible (what is deleted or overwritten cannot be brought back), downtime (a service is unreachable for a while), service_access (someone gets access to a service or its data), account_access (who can access the account changes), ownership (something leaves the account or changes its owner), disclosure (data goes to a party outside the account). A closed set; a new value comes with a new release of the spec. An approval given in advance never covers terms or price.

min items 1unique true
approval.raised_byarray of any

Why the level is above what the operation needs at least, where it is: consumer_price (it costs a consumer money), outside_content (this credential read content from the internet shortly before), account_rule (the account has it so), input_content (what the call sets runs code or sends data out of the account), input_field (the call sends a field the operation asks more for, approval_by_field of the route export). Empty where the level is the operation's own. A closed set; a new value comes with a new release of the spec.

unique true
approval.elementsarray of object

What the approval is about, each shown as it is - may be empty.

approval.elements[].kindany

document, text, declaration - what the person agrees to; subject, change, consequence - what is done and what follows; price - what it costs.

One of document text price declaration subject change consequence
approval.elements[].codestring | nulloptional

What it is, as a code - required by a reader for document, text and declaration, which are logged by it.

pattern ^[a-z][a-z0-9]*(_[a-z0-9]+)*$
approval.elements[].titlestring | nulloptional

Its title, in language.

approval.elements[].languagestring | nulloptional

The language of title and text - the binding wording.

pattern ^[a-z]{2,3}(-[A-Za-z0-9]{2,8})*$
approval.elements[].urlstring | nulloptional

Where the document is; a document only.

approval.elements[].textstring | nulloptional

The text, shown as it is: of a text, a declaration (a sentence in the first person) or a consequence.

approval.elements[].labelstring | nulloptional

Of a subject or a change: what it is about (Server, Package).

approval.elements[].valuestring | nulloptional

Of a subject: which one (vs-1002).

approval.elements[].beforestring | nulloptional

Of a change: the value now.

approval.elements[].afterstring | nulloptional

Of a change: the value after.

approval.elements[].priceobjectoptional

Of a price: what it costs.

approval.elements[].price.chargesarray of object

The charges, at least one - e.g. a prorated amount now and the new plan per year.

min items 1
approval.elements[].price.charges[].codestring

What the charge is for, a lower_snake_case code of the backend, e.g. domain_fee, plan_fee - the reader translates it.

pattern ^[a-z0-9]+(_[a-z0-9]+)*$
approval.elements[].price.charges[].billingobject

How the charge is billed.

approval.elements[].price.charges[].billing.kindstring

one_time: charged once; recurring: charged per period; usage: charged by use, per unit, settled per period. An open set: a reader that does not know a kind shows the price by its summary.

pattern ^[a-z0-9]+(_[a-z0-9]+)*$
approval.elements[].price.charges[].billing.periodobjectoptional

The billing period - with recurring and usage, not with one_time.

approval.elements[].price.charges[].billing.period.unitstring

hour, day, month, year, or the unit a usage charge counts in - an open set of lower_snake_case codes. A reader that does not know one shows the price by its summary.

pattern ^[a-z0-9]+(_[a-z0-9]+)*$
approval.elements[].price.charges[].billing.period.lengthinteger

How many of the unit, at least 1.

min 1
approval.elements[].price.charges[].billing.perobjectoptional

The unit a usage charge counts, e.g. 1 hour - with usage, and only there.

approval.elements[].price.charges[].billing.per.unitstring

hour, day, month, year, or the unit a usage charge counts in - an open set of lower_snake_case codes. A reader that does not know one shows the price by its summary.

pattern ^[a-z0-9]+(_[a-z0-9]+)*$
approval.elements[].price.charges[].billing.per.lengthinteger

How many of the unit, at least 1.

min 1
approval.elements[].price.charges[].usageobjectoptional

What bounds a usage charge - with usage only.

approval.elements[].price.charges[].usage.capanyoptional

The most the charge comes to per billing period - binding, with the digits of the currency.

approval.elements[].price.charges[].usage.includedobjectoptional

How much of the unit is in the price before the rate applies - in the unit of billing.per.

approval.elements[].price.charges[].usage.included.unitstring

hour, day, month, year, or the unit a usage charge counts in - an open set of lower_snake_case codes. A reader that does not know one shows the price by its summary.

pattern ^[a-z0-9]+(_[a-z0-9]+)*$
approval.elements[].price.charges[].usage.included.lengthinteger

How many of the unit, at least 1.

min 1
approval.elements[].price.charges[].conditionstringoptional

When the charge is due at all, a lower_snake_case code: on_success - only when what it is for succeeds. An open set; not there: always.

pattern ^[a-z0-9]+(_[a-z0-9]+)*$
approval.elements[].price.charges[].service_periodobjectoptional

The days the charge covers, the first and the last both included - e.g. the rest of a period on a change of plan.

approval.elements[].price.charges[].service_period.fromstring

The first day.

Format date
approval.elements[].price.charges[].service_period.tostring

The last day.

Format date
approval.elements[].price.charges[].phasesarray of object

What the charge amounts to, phase by phase, in order: each begins where the one before it ends. A one_time charge has one phase, without cycles; the last phase of a recurring or usage charge has cycles null, and only that one.

min items 1
approval.elements[].price.charges[].phases[].kindstring

trial, promo or regular. An open set: a reader that does not know a kind shows the price by its summary.

pattern ^[a-z0-9]+(_[a-z0-9]+)*$
approval.elements[].price.charges[].phases[].cyclesinteger | nulloptional

How many billing periods the phase lasts; null: without end. Not there with one_time.

min 1
approval.elements[].price.charges[].phases[].periodobjectoptional

The billing period of this phase, where it differs from billing.period - e.g. three months free of a yearly plan.

approval.elements[].price.charges[].phases[].period.unitstring

hour, day, month, year, or the unit a usage charge counts in - an open set of lower_snake_case codes. A reader that does not know one shows the price by its summary.

pattern ^[a-z0-9]+(_[a-z0-9]+)*$
approval.elements[].price.charges[].phases[].period.lengthinteger

How many of the unit, at least 1.

min 1
approval.elements[].price.charges[].phases[].amountany

What is charged per period of the phase - never per month unless the period is one. With usage: per unit of billing.per, and it may have more digits than the currency.

approval.elements[].price.summarystringoptional

The whole price in one sentence, in the language of the answer, as the backend writes it - what a reader shows where it does not know a code. Never instead of the charges.

min length 1max length 1000
approval.waysarray of object

How it can be given, the best first; the last is the fallback. A reader takes the first it can use and passes over a kind it does not know. Empty once a kept call is decided.

approval.ways[].kindstring

call_again - the caller sends the same call again with token in the input field parameter, after an explicit yes of the person; panel - a person approves it in the backend's own user interface, at url. An open set, lower_snake_case.

pattern ^[a-z][a-z0-9]*(_[a-z0-9]+)*$
approval.ways[].tokenstringoptional

Of call_again: what to send with the same call again - bound to this call and its input.

min length 1max length 255
approval.ways[].parameterstringoptional

Of call_again: the input field the token goes in - a protocol parameter of the operation, approval_token.

pattern ^[a-z][a-z0-9]*(_[a-z0-9]+)*$
approval.ways[].urlstringoptional

Of panel: the page where the person approves it. A pointer only - the person signs in there all the same.

min length 1
approval.expires_atstring | null

Until when the approval can be given; null where the backend does not say.

Format date-time
resultobject | nulloptional

The structured answer of the operation it carried out, once executed, failed or unverified; null until then.

created_byobject

Who made it - for the main access, which sees the calls of every access of the account.

created_by.account_user_idinteger

The access that made it.

created_by.typestring

primary: the main access; secondary: a sub access.

One of primary secondary ngcobalt_site_mail_user
created_by.descriptionstring | null

The description written for it, null if nothing - not its name or user name.

One of X-API-Key, Authorization: Bearer … - never more than one in a request. More

pending_action_id (required)string

The pending_action_id that approval_required answered, passed as it is.

min length 1max length 40pattern ^[^\x00-\x1F\x7F]*$
pending_action_idstring

The id, not guessable, bound to the account and the access that made it.

min length 1max length 255
statusany

pending: waits for the person; approved: approved, not carried out yet; executed: carried out, result is its answer; failed: carried out, it failed - result says how; unverified: carried out, whether it took effect is not known; declined: the person said no; expired: nobody decided in time; cancelled: the caller withdrew it.

One of pending approved executed failed unverified declined expired cancelled
operation_idstring | nulloptional

The operation of the route export it carries out; null where the backend does not say.

pattern ^[a-z][a-z0-9]*(_[a-z][a-z0-9]*)*$
created_atstring
Format date-time
expires_atstring

Until when it waits for the person.

Format date-time
decided_atstring | nulloptional

When it was approved, declined, cancelled or expired; null while it is pending.

Format date-time
decided_viastring | nulloptional

Where it was decided: panel - the backend's own user interface; api - a call of the backend (cancelled); an open set, lower_snake_case. null while it is pending.

pattern ^[a-z][a-z0-9]*(_[a-z0-9]+)*$
approvalobjectoptional

The approval it waits for - the ways while it is pending, none once it is decided. Not under approval_required, where it stands beside it as params.approval.

approval.required_levelany

The level of approval the call needs (components/1/approval-levels.json). A reader compares ranks, never names.

One of none client_dialog caller_confirmation client_click signed_in_person fresh_second_factor
approval.concernsarray of any

What the approval is about, at least one, each once: terms (a declaration on terms), price (it costs money), contract (a contract is concluded, changed or ended), irreversible (what is deleted or overwritten cannot be brought back), downtime (a service is unreachable for a while), service_access (someone gets access to a service or its data), account_access (who can access the account changes), ownership (something leaves the account or changes its owner), disclosure (data goes to a party outside the account). A closed set; a new value comes with a new release of the spec. An approval given in advance never covers terms or price.

min items 1unique true
approval.raised_byarray of any

Why the level is above what the operation needs at least, where it is: consumer_price (it costs a consumer money), outside_content (this credential read content from the internet shortly before), account_rule (the account has it so), input_content (what the call sets runs code or sends data out of the account), input_field (the call sends a field the operation asks more for, approval_by_field of the route export). Empty where the level is the operation's own. A closed set; a new value comes with a new release of the spec.

unique true
approval.elementsarray of object

What the approval is about, each shown as it is - may be empty.

approval.elements[].kindany

document, text, declaration - what the person agrees to; subject, change, consequence - what is done and what follows; price - what it costs.

One of document text price declaration subject change consequence
approval.elements[].codestring | nulloptional

What it is, as a code - required by a reader for document, text and declaration, which are logged by it.

pattern ^[a-z][a-z0-9]*(_[a-z0-9]+)*$
approval.elements[].titlestring | nulloptional

Its title, in language.

approval.elements[].languagestring | nulloptional

The language of title and text - the binding wording.

pattern ^[a-z]{2,3}(-[A-Za-z0-9]{2,8})*$
approval.elements[].urlstring | nulloptional

Where the document is; a document only.

approval.elements[].textstring | nulloptional

The text, shown as it is: of a text, a declaration (a sentence in the first person) or a consequence.

approval.elements[].labelstring | nulloptional

Of a subject or a change: what it is about (Server, Package).

approval.elements[].valuestring | nulloptional

Of a subject: which one (vs-1002).

approval.elements[].beforestring | nulloptional

Of a change: the value now.

approval.elements[].afterstring | nulloptional

Of a change: the value after.

approval.elements[].priceobjectoptional

Of a price: what it costs.

approval.elements[].price.chargesarray of object

The charges, at least one - e.g. a prorated amount now and the new plan per year.

min items 1
approval.elements[].price.charges[].codestring

What the charge is for, a lower_snake_case code of the backend, e.g. domain_fee, plan_fee - the reader translates it.

pattern ^[a-z0-9]+(_[a-z0-9]+)*$
approval.elements[].price.charges[].billingobject

How the charge is billed.

approval.elements[].price.charges[].billing.kindstring

one_time: charged once; recurring: charged per period; usage: charged by use, per unit, settled per period. An open set: a reader that does not know a kind shows the price by its summary.

pattern ^[a-z0-9]+(_[a-z0-9]+)*$
approval.elements[].price.charges[].billing.periodobjectoptional

The billing period - with recurring and usage, not with one_time.

approval.elements[].price.charges[].billing.period.unitstring

hour, day, month, year, or the unit a usage charge counts in - an open set of lower_snake_case codes. A reader that does not know one shows the price by its summary.

pattern ^[a-z0-9]+(_[a-z0-9]+)*$
approval.elements[].price.charges[].billing.period.lengthinteger

How many of the unit, at least 1.

min 1
approval.elements[].price.charges[].billing.perobjectoptional

The unit a usage charge counts, e.g. 1 hour - with usage, and only there.

approval.elements[].price.charges[].billing.per.unitstring

hour, day, month, year, or the unit a usage charge counts in - an open set of lower_snake_case codes. A reader that does not know one shows the price by its summary.

pattern ^[a-z0-9]+(_[a-z0-9]+)*$
approval.elements[].price.charges[].billing.per.lengthinteger

How many of the unit, at least 1.

min 1
approval.elements[].price.charges[].usageobjectoptional

What bounds a usage charge - with usage only.

approval.elements[].price.charges[].usage.capanyoptional

The most the charge comes to per billing period - binding, with the digits of the currency.

approval.elements[].price.charges[].usage.includedobjectoptional

How much of the unit is in the price before the rate applies - in the unit of billing.per.

approval.elements[].price.charges[].usage.included.unitstring

hour, day, month, year, or the unit a usage charge counts in - an open set of lower_snake_case codes. A reader that does not know one shows the price by its summary.

pattern ^[a-z0-9]+(_[a-z0-9]+)*$
approval.elements[].price.charges[].usage.included.lengthinteger

How many of the unit, at least 1.

min 1
approval.elements[].price.charges[].conditionstringoptional

When the charge is due at all, a lower_snake_case code: on_success - only when what it is for succeeds. An open set; not there: always.

pattern ^[a-z0-9]+(_[a-z0-9]+)*$
approval.elements[].price.charges[].service_periodobjectoptional

The days the charge covers, the first and the last both included - e.g. the rest of a period on a change of plan.

approval.elements[].price.charges[].service_period.fromstring

The first day.

Format date
approval.elements[].price.charges[].service_period.tostring

The last day.

Format date
approval.elements[].price.charges[].phasesarray of object

What the charge amounts to, phase by phase, in order: each begins where the one before it ends. A one_time charge has one phase, without cycles; the last phase of a recurring or usage charge has cycles null, and only that one.

min items 1
approval.elements[].price.charges[].phases[].kindstring

trial, promo or regular. An open set: a reader that does not know a kind shows the price by its summary.

pattern ^[a-z0-9]+(_[a-z0-9]+)*$
approval.elements[].price.charges[].phases[].cyclesinteger | nulloptional

How many billing periods the phase lasts; null: without end. Not there with one_time.

min 1
approval.elements[].price.charges[].phases[].periodobjectoptional

The billing period of this phase, where it differs from billing.period - e.g. three months free of a yearly plan.

approval.elements[].price.charges[].phases[].period.unitstring

hour, day, month, year, or the unit a usage charge counts in - an open set of lower_snake_case codes. A reader that does not know one shows the price by its summary.

pattern ^[a-z0-9]+(_[a-z0-9]+)*$
approval.elements[].price.charges[].phases[].period.lengthinteger

How many of the unit, at least 1.

min 1
approval.elements[].price.charges[].phases[].amountany

What is charged per period of the phase - never per month unless the period is one. With usage: per unit of billing.per, and it may have more digits than the currency.

approval.elements[].price.summarystringoptional

The whole price in one sentence, in the language of the answer, as the backend writes it - what a reader shows where it does not know a code. Never instead of the charges.

min length 1max length 1000
approval.waysarray of object

How it can be given, the best first; the last is the fallback. A reader takes the first it can use and passes over a kind it does not know. Empty once a kept call is decided.

approval.ways[].kindstring

call_again - the caller sends the same call again with token in the input field parameter, after an explicit yes of the person; panel - a person approves it in the backend's own user interface, at url. An open set, lower_snake_case.

pattern ^[a-z][a-z0-9]*(_[a-z0-9]+)*$
approval.ways[].tokenstringoptional

Of call_again: what to send with the same call again - bound to this call and its input.

min length 1max length 255
approval.ways[].parameterstringoptional

Of call_again: the input field the token goes in - a protocol parameter of the operation, approval_token.

pattern ^[a-z][a-z0-9]*(_[a-z0-9]+)*$
approval.ways[].urlstringoptional

Of panel: the page where the person approves it. A pointer only - the person signs in there all the same.

min length 1
approval.expires_atstring | null

Until when the approval can be given; null where the backend does not say.

Format date-time
resultobject | nulloptional

The structured answer of the operation it carried out, once executed, failed or unverified; null until then.

created_byobject

Who made it - for the main access, which sees the calls of every access of the account.

created_by.account_user_idinteger

The access that made it.

created_by.typestring

primary: the main access; secondary: a sub access.

One of primary secondary ngcobalt_site_mail_user
created_by.descriptionstring | null

The description written for it, null if nothing - not its name or user name.

200Success.400The input is wrong, or the request itself (INVALID_INPUT). Each entry names its field and its reason - correct the input and call again.401No credential was presented, or it was not recognised (UNAUTHENTICATED).403The credential is valid, but may not do this (PERMISSION_DENIED). The reason says why - another credential is the way, not a repeat.404What the call names does not exist, or not for this caller (NOT_FOUND). Look it up again - do not guess another.429Too many calls. The Retry-After header says when to try again.500The server failed. Nothing about the request was wrong. Whether a change took effect is not known - check before trying it again.503The channel this operation forwards through is unavailable.
resource_not_foundWhat the call names does not exist in the account, or not for this access.NOT_FOUND
Example