Namirial · Schema
TemplateGetElementsResponse
The response model for requesting document elements of a draft or template.
CompanyDigital TrustE-SignatureIdentity VerificationDigital IdentityTrust ServicesCompliance
Properties
| Name | Type | Description |
|---|---|---|
| UnassignedElements | object | The elements which are not assigned to any action. |
| Activities | array | The steps for the envelope. |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://artifacts.apis.io/namirial/json-schema/namirial-template-get-elements-response-schema.json",
"title": "TemplateGetElementsResponse",
"description": "The response model for requesting document elements of a draft or template.",
"x-generated": "2026-11-10",
"x-method": "derived",
"x-generator": "derive-json-schema.py",
"x-source": "openapi/namirial-template-api-openapi.yml#/components/schemas/TemplateGetElementsResponse",
"type": "object",
"properties": {
"UnassignedElements": {
"$ref": "#/$defs/TemplateGetElementsElements",
"description": "The elements which are not assigned to any action."
},
"Activities": {
"description": "The steps for the envelope.",
"type": "array",
"items": {
"$ref": "#/$defs/TemplateGetElementsActivity"
}
}
},
"$defs": {
"TemplateGetElementsATrustCertificateSignatureType": {
"description": "The configuration of the A-Trust certificate signature.",
"type": "object",
"properties": {
"TemplateId": {
"description": "The identifier of the A-Trust template.",
"type": "string"
},
"Preferred": {
"description": "If true, the signature type is set as preferred.",
"type": "boolean"
}
}
},
"TemplateGetElementsAction": {
"description": "The action of the activity.",
"type": "object",
"properties": {
"SignAutomatic": {
"$ref": "#/$defs/TemplateGetElementsSignAutomatic",
"description": "The definition of the automatic sign action."
},
"Sign": {
"$ref": "#/$defs/TemplateGetElementsSign",
"description": "The definition of the sign action."
},
"SignBulk": {
"$ref": "#/$defs/TemplateGetElementsSignBulk",
"description": "The definition of the bulk."
}
}
},
"TemplateGetElementsActivity": {
"description": "Defines an activity in the process.",
"type": "object",
"properties": {
"Id": {
"description": "The identifier of the activity.",
"type": "string"
},
"Action": {
"$ref": "#/$defs/TemplateGetElementsAction",
"description": "The action assigned to the activity."
}
}
},
"TemplateGetElementsAllowedSignatureTypes": {
"description": "The definition of the allowed signature types for the signature.",
"type": "object",
"properties": {
"ClickToSign": {
"$ref": "#/$defs/TemplateGetElementsClickToSignSignatureType",
"description": "Allow signing with \"click to sign\"."
},
"DrawToSign": {
"$ref": "#/$defs/TemplateGetElementsDrawToSignSignatureType",
"description": "Allow signing with \"draw to sign\"."
},
"TypeToSign": {
"$ref": "#/$defs/TemplateGetElementsTypeToSignSignatureType",
"description": "Allow signing with \"type to sign\"."
},
"LocalCertificate": {
"$ref": "#/$defs/TemplateGetElementsLocalCertificateSignatureType",
"description": "Allow signing with a local certificate."
},
"DisposableCertificate": {
"$ref": "#/$defs/TemplateGetElementsDisposableCertificateSignatureType",
"description": "Allow signing with a disposable certificate."
},
"SwissComOnDemand": {
"$ref": "#/$defs/TemplateGetElementsSwissComOnDemandSignatureType",
"description": "Allow signing with a Swisscom On-Demand certificate."
},
"ATrustCertificate": {
"$ref": "#/$defs/TemplateGetElementsATrustCertificateSignatureType",
"description": "Allow signing with an A-Trust certificate."
},
"Biometric": {
"$ref": "#/$defs/TemplateGetElementsBiometricSignatureType",
"description": "Allow signing with a biometric signature."
},
"RemoteCertificate": {
"$ref": "#/$defs/TemplateGetElementsRemoteCertificateSignatureType",
"description": "Allow signing with a remote certificate."
},
"OneTimePassword": {
"$ref": "#/$defs/TemplateGetElementsOneTimePasswordSignatureType",
"description": "Allow signing with a one time password (SMS-OTP)."
},
"SwedishBankId": {
"$ref": "#/$defs/TemplateGetElementsSwedishBankIdSignatureType",
"description": "Allow signing with Swedish BankID."
},
"SignaturePlugins": {
"description": "Allow signing with signature plugins.",
"type": "array",
"items": {
"$ref": "#/$defs/TemplateGetElementsSignaturePluginSignatureType"
}
}
}
},
"TemplateGetElementsAttachment": {
"description": "The configuration of the attachment element.",
"type": "object",
"properties": {
"ElementId": {
"description": "The identifier of the element.",
"type": "string"
},
"DocumentNumber": {
"format": "int32",
"description": "The reference number of the containing document. It starts with 1.",
"type": "integer"
},
"Required": {
"description": "If true, the element is required.",
"type": "boolean"
},
"DisplayName": {
"description": "The displayed name.",
"type": "string"
},
"DisplayIconType": {
"description": "The type of the displayed icon.",
"enum": [
"Paperclip",
"Graph",
"PushPin",
"Tag"
],
"type": "string"
},
"GuidingOrder": {
"format": "int32",
"description": "The order of the element.",
"type": "integer"
},
"Source": {
"description": "The element source from where a field originates.",
"enum": [
"Document",
"AdvancedDocumentTag",
"UserDefined"
],
"type": "string",
"x-ms-enum": {
"name": "FormFieldSource",
"modelAsString": false
}
},
"FieldDefinition": {
"$ref": "#/$defs/TemplateGetElementsAttachmentDefinition",
"description": "The definition of the attachment element."
}
}
},
"TemplateGetElementsAttachmentDefinition": {
"description": "The settings of a positionable element.",
"type": "object",
"properties": {
"Position": {
"$ref": "#/$defs/TemplateGetElementsPosition",
"description": "The position of the within the document."
},
"Size": {
"$ref": "#/$defs/TemplateGetElementsSize",
"description": "The size of the form field."
}
}
},
"TemplateGetElementsBiometricSignatureType": {
"description": "The configuration of the Biometric signature.",
"type": "object",
"properties": {
"BiometricVerification": {
"description": "If true, a biometric verification is performed.",
"type": "boolean"
},
"AllowBiometricStoringOnly": {
"description": "If true, the biometric signature might be stored without verification.",
"type": "boolean"
},
"StoreSignedResponseWithoutBioData": {
"description": "If true, the signed response is stored without biometric data.",
"type": "boolean"
},
"BiometricServerUserId": {
"description": "The identifier of the user on the biometric server.",
"type": "string"
},
"SignaturePositioning": {
"description": "The allowed positioning of the biometric signature.",
"enum": [
"WithinField",
"OnPage",
"IntersectsWithField"
],
"type": "string",
"x-ms-enum": {
"name": "BiometricSignaturePositioning",
"modelAsString": false
}
},
"Preferred": {
"description": "If true, the signature type is set as preferred.",
"type": "boolean"
}
}
},
"TemplateGetElementsCheckBox": {
"description": "The configuration of the check box.",
"type": "object",
"properties": {
"ElementId": {
"description": "The identifier of the element.",
"type": "string"
},
"DocumentNumber": {
"format": "int32",
"description": "The reference number of the containing document. It starts with 1.",
"type": "integer"
},
"Required": {
"description": "If true, the element is required.",
"type": "boolean"
},
"IsChecked": {
"description": "If true, the check box is checked.",
"type": "boolean"
},
"GuidingOrder": {
"format": "int32",
"description": "The order of the element.",
"type": "integer"
},
"Source": {
"description": "The element source from where a field originates.",
"enum": [
"Document",
"AdvancedDocumentTag",
"UserDefined"
],
"type": "string",
"x-ms-enum": {
"name": "FormFieldSource",
"modelAsString": false
}
},
"FieldDefinition": {
"$ref": "#/$defs/TemplateGetElementsCheckBoxDefinition",
"description": "The definition of the check box."
}
}
},
"TemplateGetElementsCheckBoxDefinition": {
"description": "The configuration of a check box.",
"type": "object",
"properties": {
"ExportValue": {
"description": "The value of the check box when it is checked.",
"type": "string"
},
"Position": {
"$ref": "#/$defs/TemplateGetElementsPosition",
"description": "The position of the within the document."
},
"Size": {
"$ref": "#/$defs/TemplateGetElementsSize",
"description": "The size of the form field."
},
"ReadOnly": {
"description": "If true, the element is readonly.",
"type": "boolean"
}
}
},
"TemplateGetElementsChoiceItem": {
"description": "The configuration of the choice item.",
"type": "object",
"properties": {
"ExportValue": {
"description": "The value of the element when the choice item is selected.",
"type": "string"
},
"DisplayValue": {
"description": "The displayed value of the choice item.",
"type": "string"
}
}
},
"TemplateGetElementsClickToSignSignatureType": {
"description": "The configuration of the signature image.",
"type": "object",
"properties": {
"UseExternalSignatureImage": {
"description": "The external signature image mode.",
"enum": [
"Optional",
"Required",
"Disabled"
],
"type": "string"
},
"Preferred": {
"description": "If true, the signature type is set as preferred.",
"type": "boolean"
},
"StampImprintConfiguration": {
"$ref": "#/$defs/TemplateGetElementsClickToSignStampImprint",
"description": "The configuration of the stamp imprint of the signature."
}
}
},
"TemplateGetElementsClickToSignStampImprint": {
"description": "The configuration of the stamp imprint used by multiple signature types.",
"type": "object",
"properties": {
"DisplayExtraInformation": {
"description": "If true, the extra information is displayed.",
"type": "boolean"
},
"FontName": {
"description": "The name of the font. The font needs to be installed on the server. \nIf it is not available on the server, a fallback font is used.",
"type": "string"
},
"FontSizeInPt": {
"format": "int32",
"description": "The size of the font in points.",
"type": "integer"
},
"DisplayEmail": {
"description": "If true, the email address of the signer is displayed.",
"type": "boolean"
},
"DisplayIp": {
"description": "If true, the IP address of the signer is displayed.",
"type": "boolean"
},
"DisplayName": {
"description": "If true, the name of the signer is displayed.",
"type": "boolean"
},
"DisplaySignatureDate": {
"description": "If true, the timestamp of signing is displayed.",
"type": "boolean"
}
}
},
"TemplateGetElementsComboBox": {
"description": "The configuration of the combo box.",
"type": "object",
"properties": {
"ElementId": {
"description": "The identifier of the element.",
"type": "string"
},
"DocumentNumber": {
"format": "int32",
"description": "The reference number of the containing document. It starts with 1.",
"type": "integer"
},
"Required": {
"description": "If true, the element is required.",
"type": "boolean"
},
"Value": {
"description": "The selected value of the combo box.",
"type": "string"
},
"GuidingOrder": {
"format": "int32",
"description": "The order of the element.",
"type": "integer"
},
"Source": {
"description": "The element source from where a field originates.",
"enum": [
"Document",
"AdvancedDocumentTag",
"UserDefined"
],
"type": "string",
"x-ms-enum": {
"name": "FormFieldSource",
"modelAsString": false
}
},
"FieldDefinition": {
"$ref": "#/$defs/TemplateGetElementsComboBoxDefinition",
"description": "The definition of the combo box."
}
}
},
"TemplateGetElementsComboBoxDefinition": {
"description": "The configuration of the combo box.",
"type": "object",
"properties": {
"TextFormat": {
"$ref": "#/$defs/TemplateGetElementsTextFormat",
"description": "The configuration of the text format."
},
"Items": {
"description": "A list of items that can be selected for the element.",
"type": "array",
"items": {
"$ref": "#/$defs/TemplateGetElementsChoiceItem"
}
},
"IsEditable": {
"description": "If true, the combo box is editable.",
"type": "boolean"
},
"ReadOnly": {
"description": "If true, the element is readonly.",
"type": "boolean"
},
"Position": {
"$ref": "#/$defs/TemplateGetElementsPosition",
"description": "The position of the within the document."
},
"Size": {
"$ref": "#/$defs/TemplateGetElementsSize",
"description": "The size of the form field."
}
}
},
"TemplateGetElementsDate": {
"description": "The configuration of the predefined element showing the date.",
"type": "object",
"properties": {
"ElementId": {
"description": "The identifier of the element.",
"type": "string"
},
"DocumentNumber": {
"format": "int32",
"description": "The reference number of the containing document. It starts with 1.",
"type": "integer"
},
"DateFormat": {
"description": "The format of the date.",
"type": "string"
},
"Source": {
"description": "The element source from where a field originates.",
"enum": [
"Document",
"AdvancedDocumentTag",
"UserDefined"
],
"type": "string",
"x-ms-enum": {
"name": "FormFieldSource",
"modelAsString": false
}
},
"FieldDefinition": {
"$ref": "#/$defs/TemplateGetElementsPredefinedElementDefinition",
"description": "The definition of the predefined element."
}
}
},
"TemplateGetElementsDateValidationConfiguration": {
"description": "The validation rules for dates.",
"type": "object",
"properties": {
"DateFormat": {
"description": "The format of the dates.",
"type": "string"
},
"Range": {
"$ref": "#/$defs/TemplateGetElementsFieldValidationRange",
"description": "The range of the values."
}
}
},
"TemplateGetElementsDisposableCertificateSignatureType": {
"description": "The configuration of the DisposableCertificate signature.",
"type": "object",
"properties": {
"IsLongLived": {
"description": "If true, the disposable certificate is long lived.",
"type": "boolean"
},
"ValidityInSeconds": {
"format": "int32",
"description": "The validity of the certificate in seconds.",
"type": "integer"
},
"UseExternalSignatureImage": {
"description": "The external signature image mode.",
"enum": [
"Optional",
"Required",
"Disabled"
],
"type": "string"
},
"Preferred": {
"description": "If true, the signature type is set as preferred.",
"type": "boolean"
},
"StampImprintConfiguration": {
"$ref": "#/$defs/TemplateGetElementsDisposableCertificateStampImprint",
"description": "The configuration of the stamp imprint of the signature."
}
}
},
"TemplateGetElementsDisposableCertificateStampImprint": {
"description": "The configuration of the stamp imprint used by multiple signature types.",
"type": "object",
"properties": {
"DisplayExtraInformation": {
"description": "If true, the extra information is displayed.",
"type": "boolean"
},
"FontName": {
"description": "The name of the font. The font needs to be installed on the server. \nIf it is not available on the server, a fallback font is used.",
"type": "string"
},
"FontSizeInPt": {
"format": "int32",
"description": "The size of the font in points.",
"type": "integer"
},
"DisplayIp": {
"description": "If true, the IP address of the signer is displayed.",
"type": "boolean"
},
"DisplayName": {
"description": "If true, the name of the signer is displayed.",
"type": "boolean"
},
"DisplaySignatureDate": {
"description": "If true, the timestamp of signing is displayed.",
"type": "boolean"
}
}
},
"TemplateGetElementsDrawToSignSignatureType": {
"description": "The configuration of the signature image.",
"type": "object",
"properties": {
"UseExternalSignatureImage": {
"description": "The external signature image mode.",
"enum": [
"Optional",
"Required",
"Disabled"
],
"type": "string"
},
"Preferred": {
"description": "If true, the signature type is set as preferred.",
"type": "boolean"
},
"StampImprintConfiguration": {
"$ref": "#/$defs/TemplateGetElementsDrawToSignStampImprint",
"description": "The configuration of the stamp imprint of the signature."
}
}
},
"TemplateGetElementsDrawToSignStampImprint": {
"description": "The configuration of the stamp imprint used by multiple signature types.",
"type": "object",
"properties": {
"DisplayExtraInformation": {
"description": "If true, the extra information is displayed.",
"type": "boolean"
},
"FontName": {
"description": "The name of the font. The font needs to be installed on the server. \nIf it is not available on the server, a fallback font is used.",
"type": "string"
},
"FontSizeInPt": {
"format": "int32",
"description": "The size of the font in points.",
"type": "integer"
},
"DisplayEmail": {
"description": "If true, the email address of the signer is displayed.",
"type": "boolean"
},
"DisplayIp": {
"description": "If true, the IP address of the signer is displayed.",
"type": "boolean"
},
"DisplayName": {
"description": "If true, the name of the signer is displayed.",
"type": "boolean"
},
"DisplaySignatureDate": {
"description": "If true, the timestamp of signing is displayed.",
"type": "boolean"
}
}
},
"TemplateGetElementsElements": {
"description": "The configurable elements of the documents.",
"type": "object",
"properties": {
"TextBoxes": {
"description": "The text boxes.",
"type": "array",
"items": {
"$ref": "#/$defs/TemplateGetElementsTextBox"
}
},
"CheckBoxes": {
"description": "The check boxes.",
"type": "array",
"items": {
"$ref": "#/$defs/TemplateGetElementsCheckBox"
}
},
"ComboBoxes": {
"description": "The combo boxes.",
"type": "array",
"items": {
"$ref": "#/$defs/TemplateGetElementsComboBox"
}
},
"RadioButtons": {
"description": "The radio buttons.",
"type": "array",
"items": {
"$ref": "#/$defs/TemplateGetElementsRadioButtonGroup"
}
},
"ListBoxes": {
"description": "The list boxes.",
"type": "array",
"items": {
"$ref": "#/$defs/TemplateGetElementsListBox"
}
},
"Signatures": {
"description": "The signatures.",
"type": "array",
"items": {
"$ref": "#/$defs/TemplateGetElementsSignatureField"
}
},
"Attachments": {
"description": "The attachments.",
"type": "array",
"items": {
"$ref": "#/$defs/TemplateGetElementsAttachment"
}
},
"PredefinedFieldElements": {
"$ref": "#/$defs/TemplateGetElementsPredefinedFieldElements",
"description": "The predefined field elements."
},
"LinkConfiguration": {
"$ref": "#/$defs/TemplateGetElementsLinkConfiguration",
"description": "The links in the documents."
},
"AreaReadConfirmations": {
"description": "The areas which have to be read.",
"type": "array",
"items": {
"$ref": "#/$defs/TemplateGetElementsReadAreaConfirmation"
}
},
"PageReadConfirmations": {
"description": "The pages which have to be read.",
"type": "array",
"items": {
"$ref": "#/$defs/TemplateGetElementsReadPagesConfirmation"
}
},
"DocumentReadConfirmations": {
"description": "The documents which have to be read.",
"type": "array",
"items": {
"$ref": "#/$defs/TemplateGetElementsReadDocumentConfirmation"
}
}
}
},
"TemplateGetElementsEmail": {
"description": "The configuration of the predefined element.",
"type": "object",
"properties": {
"ElementId": {
"description": "The identifier of the element.",
"type": "string"
},
"DocumentNumber": {
"format": "int32",
"description": "The reference number of the containing document. It starts with 1.",
"type": "integer"
},
"Source": {
"description": "The element source from where a field originates.",
"enum": [
"Document",
"AdvancedDocumentTag",
"UserDefined"
],
"type": "string",
"x-ms-enum": {
"name": "FormFieldSource",
"modelAsString": false
}
},
"FieldDefinition": {
"$ref": "#/$defs/TemplateGetElementsPredefinedElementDefinition",
"description": "The definition of the predefined element."
}
}
},
"TemplateGetElementsFieldValidation": {
"description": "The configuration of the field validation rules.",
"type": "object",
"properties": {
"Type": {
"description": "The type of the value.",
"enum": [
"None",
"Date",
"Email",
"Number",
"Phone",
"Time"
],
"type": "string",
"x-ms-enum": {
"name": "FieldValidationType",
"modelAsString": false
}
},
"DateValidationConfiguration": {
"$ref": "#/$defs/TemplateGetElementsDateValidationConfiguration",
"description": "The validation rules for dates."
},
"NumberValidationConfiguration": {
"$ref": "#/$defs/TemplateGetElementsNumberValidationConfiguration",
"description": "The validation rules for numbers."
},
"PhoneValidationConfiguration": {
"$ref": "#/$defs/TemplateGetElementsPhoneValidationConfiguration",
"description": "The validation rules for phone numbers."
},
"TimeValidationConfiguration": {
"$ref": "#/$defs/TemplateGetElementsTimeValidationConfiguration",
"description": "The validation rules for time values."
}
}
},
"TemplateGetElementsFieldValidationRange": {
"description": "The validation rules for a value range.",
"type": "object",
"properties": {
"From": {
"description": "The lower boundary of the range.",
"type": "string"
},
"To": {
"description": "The upper boundary of the range.",
"type": "string"
}
}
},
"TemplateGetElementsFullName": {
"description": "The configuration of the predefined element.",
"type": "object",
"properties": {
"ElementId": {
"description": "The identifier of the element.",
"type": "string"
},
"DocumentNumber": {
"format": "int32",
"description": "The reference number of the containing document. It starts with 1.",
"type": "integer"
},
"Source": {
"description": "The element source from where a field originates.",
"enum": [
"Document",
"AdvancedDocumentTag",
"UserDefined"
],
"type": "string",
"x-ms-enum": {
"name": "FormFieldSource",
"modelAsString": false
}
},
"FieldDefinition": {
"$ref": "#/$defs/TemplateGetElementsPredefinedElementDefinition",
"description": "The definition of the predefined element."
}
}
},
"TemplateGetElementsGivenName": {
"description": "The configuration of the predefined element.",
"type": "object",
"properties": {
"ElementId": {
"description": "The identifier of the element.",
"type": "string"
},
"DocumentNumber": {
"format": "int32",
"description": "The reference number of the containing document. It starts with 1.",
"type": "integer"
},
"Source": {
"description": "The element source from where a field originates.",
"enum": [
"Document",
"AdvancedDocumentTag",
"UserDefined"
],
"type": "string",
"x-ms-enum": {
"name": "FormFieldSource",
"modelAsString": false
}
},
"FieldDefinition": {
"$ref": "#/$defs/TemplateGetElementsPredefinedElementDefinition",
"description": "The definition of the predefined element."
}
}
},
"TemplateGetElementsHyperLink": {
"description": "The definition of the hyperlink element.",
"type": "object",
"properties": {
"Id": {
"description": "The identifier of the hyperlink.",
"type": "string"
},
"Uri": {
"description": "The URI of the hyperlink.",
"type": "string"
},
"DocumentNumber": {
"format": "int32",
"description": "The reference number of the containing document. It starts with 1.",
"type": "integer"
},
"Source": {
"description": "The element source from where a field originates.",
"enum": [
"Document",
"AdvancedDocumentTag",
"UserDefined"
],
"type": "string",
"x-ms-enum": {
"name": "FormFieldSource",
"modelAsString": false
}
},
"FieldDefinition": {
"$ref": "#/$defs/TemplateGetElementsLinkDefinition",
"description": "The definition of the hyperlink element."
}
}
},
"TemplateGetElementsInitials": {
"description": "The configuration of the predefined element showing the initials.",
"type": "object",
"properties": {
"ElementId": {
"description": "The identifier of the element.",
"type": "string"
},
"IncludeMiddleNameInitials": {
"description": "If true, the initials from the middle names are included as well. \nThe initials are read from the given name. Additional names are expected to be separated by a space.",
"type": "boolean"
},
"DocumentNumber": {
"format": "int32",
"description": "The reference number of the containing document. It starts with 1.",
"type": "integer"
},
"Source": {
"description": "The element source from where a field originates.",
"enum": [
"Document",
"AdvancedDocumentTag",
"UserDefined"
],
"type": "string",
"x-ms-enum": {
"name": "FormFieldSource",
"modelAsString": false
}
},
"FieldDefinition": {
"$ref": "#/$defs/TemplateGetElementsPredefinedElementDefinition",
"description": "The definition of the predefined element."
}
}
},
"TemplateGetElementsLinkConfiguration": {
"description": "The configuration of the link elements.",
"type": "object",
"properties": {
"HyperLinks": {
"description": "The list of hyperlink elements.",
"type": "array",
"items": {
"$ref": "#/$defs/TemplateGetElementsHyperLink"
}
}
}
},
"TemplateGetElementsLinkDefinition": {
"description": "The settings of a positionable element.",
"type": "object",
"properties": {
"Position": {
"$ref": "#/$defs/TemplateGetElementsPosition",
"description": "The position of the within the document."
},
"Size": {
"$ref": "#/$defs/TemplateGetElementsSize",
"description": "The size of the form field."
}
}
},
"TemplateGetElementsListBox": {
"description": "The configuration of the list box.",
"type": "object",
"properties": {
"ElementId": {
"description": "The identifier of the element.",
"type": "string"
},
"DocumentNumber": {
"format": "int32",
"description": "The reference number of the containing document. It starts with 1.",
"type": "integer"
},
"Required": {
"description": "If true, the element is required.",
"type": "boolean"
# --- truncated at 32 KB (73 KB total) ---
# Full source: https://artifacts.apis.io/namirial/json-schema/namirial-template-get-elements-response-schema.json
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.
Call it yourself
curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/namirial-template-get-elements-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.