Orishare
API reference

List the requests waiting for, or decided by, a person (newest first)

GET
/pending_actions

Authorization

AuthorizationBearer <token>

Secret API key bound to an environment.

In: header

Query Parameters

limit?integer
Range1 <= value <= 200
Default50
cursor?string
status?string

Value in

  • "pending"
  • "executing"
  • "executed"
  • "failed"
  • "declined"
  • "expired"
scope?string

organization: every environment of the organization this credential may read (within an AI connection’s narrowing), not only the selected one. Default environment.

Value in

  • "environment"
  • "organization"

Header Parameters

X-Orishare-Environment?string

Required for selected-environment authorization branches; API keys use their bound environment.

Length1 <= length

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/pending_actions"
{  "data": [    {      "id": "string",      "object": "pending_action",      "environment_id": "string",      "status": "pending",      "operation_id": "string",      "summary": "string",      "request": {        "method": "POST",        "path": "string",        "route": "string",        "path_params": {          "property1": null,          "property2": null        },        "query": {          "property1": null,          "property2": null        },        "body": null,        "if_match": "string"      },      "gate": {        "property1": null,        "property2": null      },      "note": "string",      "channel": "mcp",      "requested_by": {        "kind": "secret_key",        "id": "string",        "user_id": "string",        "name": "string"      },      "executes_as": "requester",      "stalled": true,      "expires_at": "string",      "decided_by": "string",      "decided_at": "string",      "decision_note": "string",      "executed_at": "string",      "result": {        "status": -9007199254740991,        "body": null      },      "review_url": "string",      "checks": {        "will_fail": true,        "problems": [          {            "code": "customer_not_found",            "message": "string"          }        ]      },      "resolved_body": null,      "created_at": "string",      "updated_at": "string",      "version": -9007199254740991    }  ],  "next_cursor": "string",  "has_more": true}

Ask a person to approve one exact request that the production gate held: it runs, exactly as recorded, when an owner or admin approves it in the dashboard

POST
/pending_actions

Authorization

AuthorizationBearer <token>

Secret API key bound to an environment.

In: header

Header Parameters

Idempotency-Key*string

Required. Official clients generate a UUID when omitted by the caller.

Length1 <= length <= 255
X-Orishare-Environment?string

Required for selected-environment authorization branches; API keys use their bound environment.

Length1 <= length

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/pending_actions" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{    "operation_id": "delete_segments_id",    "path": {      "id": "seg_00000000000000000000000000000001"    },    "note": "The segment was a test"  }'
{  "id": "string",  "object": "pending_action",  "environment_id": "string",  "status": "pending",  "operation_id": "string",  "summary": "string",  "request": {    "method": "POST",    "path": "string",    "route": "string",    "path_params": {      "property1": null,      "property2": null    },    "query": {      "property1": null,      "property2": null    },    "body": null,    "if_match": "string"  },  "gate": {    "property1": null,    "property2": null  },  "note": "string",  "channel": "mcp",  "requested_by": {    "kind": "secret_key",    "id": "string",    "user_id": "string",    "name": "string"  },  "executes_as": "requester",  "stalled": true,  "expires_at": "string",  "decided_by": "string",  "decided_at": "string",  "decision_note": "string",  "executed_at": "string",  "result": {    "status": -9007199254740991,    "body": null  },  "review_url": "string",  "checks": {    "will_fail": true,    "problems": [      {        "code": "customer_not_found",        "message": "string"      }    ]  },  "resolved_body": null,  "created_at": "string",  "updated_at": "string",  "version": -9007199254740991}

Read one pending action: the exact request, its status and, once it ran, its answer

GET
/pending_actions/{id}

Authorization

AuthorizationBearer <token>

Secret API key bound to an environment.

In: header

Path Parameters

id*string

Header Parameters

X-Orishare-Environment?string

Required for selected-environment authorization branches; API keys use their bound environment.

Length1 <= length

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/pending_actions/string"
{  "id": "string",  "object": "pending_action",  "environment_id": "string",  "status": "pending",  "operation_id": "string",  "summary": "string",  "request": {    "method": "POST",    "path": "string",    "route": "string",    "path_params": {      "property1": null,      "property2": null    },    "query": {      "property1": null,      "property2": null    },    "body": null,    "if_match": "string"  },  "gate": {    "property1": null,    "property2": null  },  "note": "string",  "channel": "mcp",  "requested_by": {    "kind": "secret_key",    "id": "string",    "user_id": "string",    "name": "string"  },  "executes_as": "requester",  "stalled": true,  "expires_at": "string",  "decided_by": "string",  "decided_at": "string",  "decision_note": "string",  "executed_at": "string",  "result": {    "status": -9007199254740991,    "body": null  },  "review_url": "string",  "checks": {    "will_fail": true,    "problems": [      {        "code": "customer_not_found",        "message": "string"      }    ]  },  "resolved_body": null,  "created_at": "string",  "updated_at": "string",  "version": -9007199254740991,  "confirmation": {    "csrf_token": "string"  }}

Approve a pending action and run its exact request once (signed-in dashboard owner or admin only)

POST
/pending_action_approvals

Authorization

session
__Secure-orishare.session_token<token>

Browser session; local and staging use their configured runtime cookie prefix.

In: cookie

Header Parameters

Idempotency-Key*string

Required. Official clients generate a UUID when omitted by the caller.

Length1 <= length <= 255
X-Orishare-Environment*string

Required for selected-environment authorization branches; API keys use their bound environment.

Length1 <= length

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/pending_action_approvals" \  -H "Idempotency-Key: string" \  -H "X-Orishare-Environment: string" \  -H "Content-Type: application/json" \  -d '{    "pending_action_id": "pact_00000000000000000000000000000001"  }'
{  "id": "string",  "object": "pending_action",  "environment_id": "string",  "status": "pending",  "operation_id": "string",  "summary": "string",  "request": {    "method": "POST",    "path": "string",    "route": "string",    "path_params": {      "property1": null,      "property2": null    },    "query": {      "property1": null,      "property2": null    },    "body": null,    "if_match": "string"  },  "gate": {    "property1": null,    "property2": null  },  "note": "string",  "channel": "mcp",  "requested_by": {    "kind": "secret_key",    "id": "string",    "user_id": "string",    "name": "string"  },  "executes_as": "requester",  "stalled": true,  "expires_at": "string",  "decided_by": "string",  "decided_at": "string",  "decision_note": "string",  "executed_at": "string",  "result": {    "status": -9007199254740991,    "body": null  },  "review_url": "string",  "checks": {    "will_fail": true,    "problems": [      {        "code": "customer_not_found",        "message": "string"      }    ]  },  "resolved_body": null,  "created_at": "string",  "updated_at": "string",  "version": -9007199254740991}

Decline a pending action; it never runs (signed-in dashboard owner or admin only)

POST
/pending_action_declines

Authorization

session
__Secure-orishare.session_token<token>

Browser session; local and staging use their configured runtime cookie prefix.

In: cookie

Header Parameters

Idempotency-Key*string

Required. Official clients generate a UUID when omitted by the caller.

Length1 <= length <= 255
X-Orishare-Environment*string

Required for selected-environment authorization branches; API keys use their bound environment.

Length1 <= length

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/pending_action_declines" \  -H "Idempotency-Key: string" \  -H "X-Orishare-Environment: string" \  -H "Content-Type: application/json" \  -d '{    "pending_action_id": "pact_00000000000000000000000000000001"  }'
{  "id": "string",  "object": "pending_action",  "environment_id": "string",  "status": "pending",  "operation_id": "string",  "summary": "string",  "request": {    "method": "POST",    "path": "string",    "route": "string",    "path_params": {      "property1": null,      "property2": null    },    "query": {      "property1": null,      "property2": null    },    "body": null,    "if_match": "string"  },  "gate": {    "property1": null,    "property2": null  },  "note": "string",  "channel": "mcp",  "requested_by": {    "kind": "secret_key",    "id": "string",    "user_id": "string",    "name": "string"  },  "executes_as": "requester",  "stalled": true,  "expires_at": "string",  "decided_by": "string",  "decided_at": "string",  "decision_note": "string",  "executed_at": "string",  "result": {    "status": -9007199254740991,    "body": null  },  "review_url": "string",  "checks": {    "will_fail": true,    "problems": [      {        "code": "customer_not_found",        "message": "string"      }    ]  },  "resolved_body": null,  "created_at": "string",  "updated_at": "string",  "version": -9007199254740991}

Partner rewards

Gift-card suppliers and brand partners: catalogue items, offer links, orders, reconciliation and settlement.

Playbooks

First-party playbook manifests, install/upgrade/uninstall previews as change sets, and installations with ownership drift.