PagoPA · Schema

PurposeTemplate

CompanyPaymentsGovernmentPublic SectorDigital IdentityInteroperabilityNotificationsItaly

Properties

Name	Type	Description
id	string
targetDescription	string
targetTenantKind	object
creatorId	string	The ID of the Tenant that created the Purpose Template
state	object
createdAt	string
updatedAt	string
purposeTitle	string
purposeDescription	string
purposeIsFreeOfCharge	boolean
purposeFreeOfChargeReason	string
purposeDailyCalls	integer	Maximum number of daily calls that the purpose can perform
handlesPersonalData	boolean

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/pagopa/main/json-schema/pagopa-purpose-template-schema.json",
  "title": "PurposeTemplate",
  "x-generated": "2026-10-09",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/pagopa-pdnd-interop-v2-openapi.yml#/components/schemas/PurposeTemplate",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid"
    },
    "targetDescription": {
      "type": "string"
    },
    "targetTenantKind": {
      "$ref": "#/$defs/TargetTenantKind"
    },
    "creatorId": {
      "type": "string",
      "format": "uuid",
      "description": "The ID of the Tenant that created the Purpose Template"
    },
    "state": {
      "$ref": "#/$defs/PurposeTemplateState"
    },
    "createdAt": {
      "type": "string",
      "format": "date-time"
    },
    "updatedAt": {
      "type": "string",
      "format": "date-time"
    },
    "purposeTitle": {
      "type": "string"
    },
    "purposeDescription": {
      "type": "string"
    },
    "purposeIsFreeOfCharge": {
      "type": "boolean"
    },
    "purposeFreeOfChargeReason": {
      "type": "string"
    },
    "purposeDailyCalls": {
      "description": "Maximum number of daily calls that the purpose can perform",
      "type": "integer",
      "format": "int32",
      "minimum": 1,
      "maximum": 1000000000
    },
    "handlesPersonalData": {
      "type": "boolean"
    }
  },
  "required": [
    "id",
    "targetDescription",
    "targetTenantKind",
    "creatorId",
    "state",
    "createdAt",
    "purposeTitle",
    "purposeDescription",
    "purposeIsFreeOfCharge",
    "handlesPersonalData"
  ],
  "$defs": {
    "PurposeTemplateState": {
      "type": "string",
      "description": "Purpose Template State",
      "enum": [
        "PUBLISHED",
        "DRAFT",
        "SUSPENDED",
        "ARCHIVED"
      ]
    },
    "TargetTenantKind": {
      "type": "string",
      "description": "The Target Tenant Kind of a Purpose Template",
      "enum": [
        "PA",
        "PRIVATE"
      ]
    }
  }
}

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/pagopa-purpose-template"

All schemas

curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

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.

GitHub Google LinkedIn

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