IntegrationInventoryResponse

Successful operator-only GET integration_inventory result. Bounded sequential observation, not an atomic cross-store snapshot. Retirement rereads hashes and canonical versions. No registration, permission grant, external send, historical replay or queue mutation is performed; credential usability remains unproven. Additional top-level fields may be added by the shared response envelope.

CompanyMarket IntelligenceAI AgentsAfrican Markets

Properties

Name Type Description
status string
scope object
family string
integrations array
legacy_page object
canonical_page object
jobs object Workspace-wide retained delivery/fanout projection, not filtered by the selected subscription family. A missing retained job is not proof that no past external effect occurred. Inventory does not enqu
complete_inventory boolean True only when all three source pages are complete; not an atomic or historical-completeness guarantee.
snapshot_semantics string
external_actions_executed boolean
credential_values_exposed boolean
View JSON Schema on GitHub

JSON Schema

africanmarketos-com-integration-inventory-response-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/africanmarketos-com/json-schema/africanmarketos-com-integration-inventory-response-schema.json",
  "title": "IntegrationInventoryResponse",
  "description": "Successful operator-only GET integration_inventory result. Bounded sequential observation, not an atomic cross-store snapshot. Retirement rereads hashes and canonical versions. No registration, permission grant, external send, historical replay or queue mutation is performed; credential usability remains unproven. Additional top-level fields may be added by the shared response envelope.",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/africanmarketos-com-admin-api-openapi.yml#/components/schemas/IntegrationInventoryResponse",
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "enum": [
        "ok"
      ]
    },
    "scope": {
      "type": "object",
      "properties": {
        "tenant_id": {
          "type": "string",
          "pattern": "^[A-Za-z0-9][A-Za-z0-9._-]{0,119}$"
        },
        "workspace_id": {
          "type": "string",
          "pattern": "^[A-Za-z0-9][A-Za-z0-9._-]{0,119}$"
        }
      },
      "required": [
        "tenant_id",
        "workspace_id"
      ],
      "additionalProperties": false
    },
    "family": {
      "type": "string",
      "enum": [
        "webhook",
        "sink"
      ]
    },
    "integrations": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "pattern": "^[A-Za-z0-9][A-Za-z0-9._-]{0,119}$"
          },
          "family": {
            "type": "string",
            "enum": [
              "webhook",
              "sink"
            ]
          },
          "canonical_present": {
            "type": "boolean"
          },
          "canonical_active_value": {
            "type": "boolean",
            "description": "A non-null canonical value exists; this does not mean status=active or authorize delivery."
          },
          "canonical_version": {
            "type": "integer",
            "minimum": 0
          },
          "canonical_hash": {
            "type": [
              "string",
              "null"
            ],
            "pattern": "^[a-f0-9]{64}$"
          },
          "legacy_hash": {
            "type": [
              "string",
              "null"
            ],
            "pattern": "^[a-f0-9]{64}$"
          },
          "legacy_present": {
            "type": "boolean"
          },
          "status": {
            "type": "string"
          },
          "canonical_status": {
            "type": [
              "string",
              "null"
            ]
          },
          "legacy_status": {
            "type": [
              "string",
              "null"
            ]
          },
          "project_id": {
            "type": [
              "string",
              "null"
            ]
          },
          "destination": {
            "type": "object",
            "properties": {
              "hostname": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "protocol": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "credentials_in_url": {
                "type": "boolean"
              },
              "has_query": {
                "type": "boolean"
              }
            },
            "required": [
              "hostname",
              "protocol",
              "credentials_in_url",
              "has_query"
            ],
            "additionalProperties": false,
            "description": "Destination metadata only. No full URL, path, query value or URL credential value is returned."
          },
          "effective_delivery_mode": {
            "type": "string",
            "description": "Configured/default mode only, not a successful delivery or credential check. Sink default is simulated."
          },
          "configured_auth_fields": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "Matching configuration field names only, never their secret/token/header values."
          },
          "signing_key_id": {
            "type": [
              "string",
              "null"
            ]
          },
          "credential_usability": {
            "type": "string",
            "enum": [
              "not_proven_by_inventory"
            ]
          },
          "created_at": {
            "type": [
              "string",
              "null"
            ]
          },
          "current_delivery_eligibility": {
            "type": "string",
            "enum": [
              "requires_live_credential_project_event_and_effect_checks",
              "blocked_without_active_canonical_subscription"
            ],
            "description": "Active canonical state is necessary, not sufficient: current credential, project, event and effect-claim checks still apply."
          }
        },
        "required": [
          "id",
          "family",
          "canonical_present",
          "canonical_active_value",
          "canonical_version",
          "canonical_hash",
          "legacy_hash",
          "legacy_present",
          "status",
          "canonical_status",
          "legacy_status",
          "project_id",
          "destination",
          "effective_delivery_mode",
          "configured_auth_fields",
          "signing_key_id",
          "credential_usability",
          "created_at",
          "current_delivery_eligibility"
        ],
        "additionalProperties": false
      },
      "maxItems": 80
    },
    "legacy_page": {
      "type": "object",
      "properties": {
        "cursor": {
          "type": [
            "string",
            "null"
          ]
        },
        "complete": {
          "type": "boolean"
        }
      },
      "required": [
        "cursor",
        "complete"
      ],
      "additionalProperties": false
    },
    "canonical_page": {
      "type": "object",
      "properties": {
        "cursor": {
          "type": [
            "string",
            "null"
          ]
        },
        "complete": {
          "type": "boolean"
        }
      },
      "required": [
        "cursor",
        "complete"
      ],
      "additionalProperties": false
    },
    "jobs": {
      "type": "object",
      "properties": {
        "jobs": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string"
              },
              "kind": {
                "type": "string"
              },
              "status": {
                "type": "string"
              },
              "family": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "subscription_id": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "authority_present": {
                "type": "boolean"
              },
              "source_route": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "source_method": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "attempts": {
                "type": "integer",
                "minimum": 0
              },
              "due_at": {
                "type": "number",
                "description": "Unix epoch milliseconds."
              },
              "updated_at": {
                "type": "number",
                "description": "Unix epoch milliseconds."
              },
              "effect": {
                "type": [
                  "object",
                  "null"
                ],
                "properties": {
                  "policy": {
                    "type": "string",
                    "enum": [
                      "idempotent",
                      "review_on_uncertain"
                    ]
                  },
                  "outcome": {
                    "type": "string",
                    "enum": [
                      "unknown",
                      "accepted",
                      "rejected"
                    ]
                  },
                  "first_started_at": {
                    "type": "number",
                    "description": "Unix epoch milliseconds."
                  },
                  "safe_until": {
                    "type": "number",
                    "description": "Unix epoch milliseconds."
                  }
                },
                "required": [
                  "policy",
                  "outcome",
                  "first_started_at",
                  "safe_until"
                ],
                "additionalProperties": false,
                "description": "Retained local effect marker, not independent receiver confirmation or proof that a prior effect can be recalled."
              }
            },
            "required": [
              "id",
              "kind",
              "status",
              "family",
              "subscription_id",
              "authority_present",
              "source_route",
              "source_method",
              "effect"
            ],
            "additionalProperties": false,
            "description": "Redacted retained delivery/fanout job metadata only; payloads, authority values and credentials are omitted. Timing/attempt fields may be absent on historical records."
          },
          "maxItems": 40
        },
        "cursor": {
          "type": [
            "string",
            "null"
          ]
        },
        "list_complete": {
          "type": "boolean"
        },
        "scanned_jobs": {
          "type": "integer",
          "minimum": 0,
          "maximum": 40
        },
        "scope": {
          "type": "string"
        }
      },
      "required": [
        "jobs",
        "cursor",
        "list_complete",
        "scanned_jobs",
        "scope"
      ],
      "additionalProperties": false,
      "description": "Workspace-wide retained delivery/fanout projection, not filtered by the selected subscription family. A missing retained job is not proof that no past external effect occurred. Inventory does not enqueue or retry jobs."
    },
    "complete_inventory": {
      "type": "boolean",
      "description": "True only when all three source pages are complete; not an atomic or historical-completeness guarantee."
    },
    "snapshot_semantics": {
      "type": "string"
    },
    "external_actions_executed": {
      "type": "boolean",
      "enum": [
        false
      ]
    },
    "credential_values_exposed": {
      "type": "boolean",
      "enum": [
        false
      ]
    }
  },
  "required": [
    "status",
    "scope",
    "family",
    "integrations",
    "legacy_page",
    "canonical_page",
    "jobs",
    "complete_inventory",
    "snapshot_semantics",
    "external_actions_executed",
    "credential_values_exposed"
  ],
  "additionalProperties": true
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/africanmarketos-com-integration-inventory-response"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.