1Password · JSON Structure

1Password Item Structure

Represents a complete 1Password item stored in a vault, including its fields, sections, URLs, tags, and associated metadata. Items are the primary unit of secret storage in 1Password.

Type: object Properties: 14 Required: 2
Password ManagerPasswordsSecuritySecrets

1Password Item is a JSON Structure definition published by 1Password, describing 14 properties, of which 2 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

id title vault category urls favorite tags version state fields sections createdAt updatedAt lastEditedBy

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://developer.1password.com/schemas/1password/item.json",
  "name": "1Password Item",
  "description": "Represents a complete 1Password item stored in a vault, including its fields, sections, URLs, tags, and associated metadata. Items are the primary unit of secret storage in 1Password.",
  "type": "object",
  "required": [
    "vault",
    "category"
  ],
  "properties": {
    "id": {
      "type": "uuid",
      "description": "The unique identifier for the item."
    },
    "title": {
      "type": "string",
      "description": "The title of the item displayed in the 1Password interface."
    },
    "vault": {
      "$ref": "#/$defs/VaultRef"
    },
    "category": {
      "type": "string",
      "description": "The category that determines the item template and available fields.",
      "enum": [
        "LOGIN",
        "PASSWORD",
        "API_CREDENTIAL",
        "SERVER",
        "DATABASE",
        "CREDIT_CARD",
        "MEMBERSHIP",
        "PASSPORT",
        "SOFTWARE_LICENSE",
        "OUTDOOR_LICENSE",
        "SECURE_NOTE",
        "WIRELESS_ROUTER",
        "BANK_ACCOUNT",
        "DRIVER_LICENSE",
        "IDENTITY",
        "REWARD_PROGRAM",
        "DOCUMENT",
        "EMAIL_ACCOUNT",
        "SOCIAL_SECURITY_NUMBER",
        "MEDICAL_RECORD",
        "SSH_KEY",
        "CUSTOM"
      ]
    },
    "urls": {
      "type": "array",
      "description": "URLs associated with the item, such as website login pages.",
      "items": {
        "$ref": "#/$defs/Url"
      }
    },
    "favorite": {
      "type": "boolean",
      "description": "Whether the item is marked as a favorite."
    },
    "tags": {
      "type": "array",
      "description": "Tags applied to the item for organization.",
      "items": {
        "type": "string"
      }
    },
    "version": {
      "type": "int32",
      "description": "The version number of the item, incremented on each update.",
      "minimum": 0
    },
    "state": {
      "type": "string",
      "description": "The current state of the item.",
      "enum": [
        "ARCHIVED",
        "DELETED"
      ]
    },
    "fields": {
      "type": "array",
      "description": "The fields of the item containing secrets and metadata values.",
      "items": {
        "$ref": "#/$defs/Field"
      }
    },
    "sections": {
      "type": "array",
      "description": "Sections used to organize fields into logical groups within the item.",
      "items": {
        "$ref": "#/$defs/Section"
      }
    },
    "createdAt": {
      "type": "datetime",
      "description": "The ISO 8601 date and time the item was created."
    },
    "updatedAt": {
      "type": "datetime",
      "description": "The ISO 8601 date and time the item was last updated."
    },
    "lastEditedBy": {
      "type": "uuid",
      "description": "The UUID of the user who last edited the item."
    }
  },
  "definitions": {
    "VaultRef": {
      "type": "object",
      "description": "A reference to a 1Password vault by its unique identifier.",
      "required": [
        "id"
      ],
      "properties": {
        "id": {
          "type": "uuid",
          "description": "The unique identifier of the vault."
        }
      },
      "name": "VaultRef"
    },
    "Url": {
      "type": "object",
      "description": "A URL associated with an item.",
      "properties": {
        "primary": {
          "type": "boolean",
          "description": "Whether this is the primary URL for the item."
        },
        "href": {
          "type": "uri",
          "description": "The URL value."
        }
      },
      "name": "Url"
    },
    "Field": {
      "type": "object",
      "description": "A field within an item that stores a single value such as a username, password, or other data.",
      "properties": {
        "id": {
          "type": "string",
          "description": "The unique identifier for the field."
        },
        "section": {
          "type": "object",
          "description": "Reference to the section this field belongs to.",
          "properties": {
            "id": {
              "type": "string",
              "description": "The unique identifier of the section."
            }
          }
        },
        "type": {
          "type": "string",
          "description": "The data type of the field.",
          "enum": [
            "STRING",
            "EMAIL",
            "CONCEALED",
            "URL",
            "TOTP",
            "DATE",
            "MONTH_YEAR",
            "MENU"
          ]
        },
        "purpose": {
          "type": "string",
          "description": "The purpose of the field indicating its role within the item.",
          "enum": [
            "USERNAME",
            "PASSWORD",
            "NOTES"
          ]
        },
        "label": {
          "type": "string",
          "description": "The human-readable label for the field."
        },
        "value": {
          "type": "string",
          "description": "The value stored in the field."
        },
        "generate": {
          "type": "boolean",
          "description": "Whether the field value should be auto-generated."
        },
        "entropy": {
          "type": "double",
          "description": "The entropy (strength) of the generated value in bits."
        },
        "recipe": {
          "$ref": "#/$defs/GeneratorRecipe"
        }
      },
      "name": "Field"
    },
    "GeneratorRecipe": {
      "type": "object",
      "description": "Configuration for generating a random value for a field.",
      "properties": {
        "length": {
          "type": "int32",
          "description": "The length of the generated value.",
          "minimum": 1,
          "maximum": 64
        },
        "characterSets": {
          "type": "array",
          "description": "The character sets to include when generating the value.",
          "items": {
            "type": "string",
            "enum": [
              "LETTERS",
              "DIGITS",
              "SYMBOLS"
            ]
          }
        },
        "excludeCharacters": {
          "type": "string",
          "description": "Characters to exclude from the generated value."
        }
      },
      "name": "GeneratorRecipe"
    },
    "Section": {
      "type": "object",
      "description": "A section within an item used to organize fields into logical groups.",
      "properties": {
        "id": {
          "type": "string",
          "description": "The unique identifier for the section."
        },
        "label": {
          "type": "string",
          "description": "The human-readable label for the section."
        }
      },
      "name": "Section"
    }
  }
}