1Password stores items and secrets in vaults. Use the Connect API or Service Account connection to list vaults, retrieve or change items, download attached files, and resolve secret references. Returned fields and secrets can be used by later workflow steps.
Access and manage secrets stored in 1Password vaults using the Connect API or Service Account SDK. List vaults, retrieve items with their fields and secrets, download attached files, create new items, update existing ones, delete items, and resolve secret references.
List all vaults accessible by the Connect token or Service Account
Inputs and outputsParameter Type Required Description connectionModestring No Connection mode: "service_account" or "connect" serviceAccountTokenstring No 1Password Service Account token (for Service Account mode) apiKeystring No 1Password Connect API token (for Connect Server mode) serverUrlstring No 1Password Connect server URL (for Connect Server mode) filterstring No SCIM filter expression (e.g., name eq "My Vault")
Parameter Type Description vaultsarray List of accessible vaults ↳ id string Vault ID ↳ name string Vault name ↳ description string Vault description ↳ attributeVersion number Vault attribute version ↳ contentVersion number Vault content version ↳ items number Number of items in the vault ↳ type string Vault type (USER_CREATED, PERSONAL, or EVERYONE) ↳ createdAt string Creation timestamp ↳ updatedAt string Last update timestamp
Get details of a specific vault by ID
Inputs and outputsParameter Type Required Description connectionModestring No Connection mode: "service_account" or "connect" serviceAccountTokenstring No 1Password Service Account token (for Service Account mode) apiKeystring No 1Password Connect API token (for Connect Server mode) serverUrlstring No 1Password Connect server URL (for Connect Server mode) vaultIdstring Yes The vault UUID
Parameter Type Description idstring Vault ID namestring Vault name descriptionstring Vault description attributeVersionnumber Vault attribute version contentVersionnumber Vault content version itemsnumber Number of items in the vault typestring Vault type (USER_CREATED, PERSONAL, or EVERYONE) createdAtstring Creation timestamp updatedAtstring Last update timestamp
List items in a vault. Returns summaries without field values.
Inputs and outputsParameter Type Required Description connectionModestring No Connection mode: "service_account" or "connect" serviceAccountTokenstring No 1Password Service Account token (for Service Account mode) apiKeystring No 1Password Connect API token (for Connect Server mode) serverUrlstring No 1Password Connect server URL (for Connect Server mode) vaultIdstring Yes The vault UUID to list items from filterstring No SCIM filter expression (e.g., title eq "API Key" or tag eq "production")
Parameter Type Description itemsarray List of items in the vault (summaries without field values) ↳ id string Item ID ↳ title string Item title ↳ vault object Vault reference ↳ id string Vault ID ↳ category string Item category (e.g., LOGIN, API_CREDENTIAL) ↳ urls array URLs associated with the item ↳ href string URL ↳ label string URL label ↳ primary boolean Whether this is the primary URL ↳ favorite boolean Whether the item is favorited ↳ tags array Item tags ↳ version number Item version number ↳ state string Item state (ARCHIVED, or absent/null when active) ↳ createdAt string Creation timestamp ↳ updatedAt string Last update timestamp ↳ lastEditedBy string ID of the last editor
Get full details of an item including all fields and secrets
Inputs and outputsParameter Type Required Description connectionModestring No Connection mode: "service_account" or "connect" serviceAccountTokenstring No 1Password Service Account token (for Service Account mode) apiKeystring No 1Password Connect API token (for Connect Server mode) serverUrlstring No 1Password Connect server URL (for Connect Server mode) vaultIdstring Yes The vault UUID itemIdstring Yes The item UUID to retrieve
Parameter Type Description responsejson Deprecated — kept for backward compatibility with workflows saved before per-operation outputs were added below. Never populated; use the operation-specific outputs instead. vaultsjson List of accessible vaults [{id, name, description, items, type, createdAt, updatedAt}] idstring Vault or item ID namestring Vault name descriptionstring Vault description itemsjson Number of items in the vault (Get Vault) or item summaries [{id, title, category, tags, favorite, version, updatedAt}] (List Items) typestring Vault type (USER_CREATED, PERSONAL, or EVERYONE) titlestring Item title categorystring Item category (e.g., LOGIN, API_CREDENTIAL, SECURE_NOTE) vaultjson Vault reference the item belongs to {id} fieldsjson Item fields including secrets [{id, label, type, purpose, value}] sectionsjson Item sections [{id, label}] filesjson Files attached to the item [{id, name, size, section}] — fetch content with Get Item File tagsjson Item tags urlsjson URLs associated with the item [{href, label, primary}] favoriteboolean Whether the item is favorited versionnumber Item version number statestring Item state (ARCHIVED, or absent/null when active) lastEditedBystring ID of the last editor createdAtstring Creation timestamp updatedAtstring Last update timestamp successboolean Whether the item was successfully deleted valuestring The resolved secret value referencestring The original secret reference URI filefile Downloaded file attachment
Download the content of a file attached to an item
Inputs and outputsParameter Type Required Description connectionModestring No Connection mode: "service_account" or "connect" serviceAccountTokenstring No 1Password Service Account token (for Service Account mode) apiKeystring No 1Password Connect API token (for Connect Server mode) serverUrlstring No 1Password Connect server URL (for Connect Server mode) vaultIdstring Yes The vault UUID itemIdstring Yes The item UUID the file is attached to fileIdstring Yes The file ID (from the item's "files" array, e.g. via Get Item)
Parameter Type Description filefile Downloaded file attachment
Create a new item in a vault
Inputs and outputsParameter Type Required Description connectionModestring No Connection mode: "service_account" or "connect" serviceAccountTokenstring No 1Password Service Account token (for Service Account mode) apiKeystring No 1Password Connect API token (for Connect Server mode) serverUrlstring No 1Password Connect server URL (for Connect Server mode) vaultIdstring Yes The vault UUID to create the item in categorystring Yes Item category (e.g., LOGIN, PASSWORD, API_CREDENTIAL, SECURE_NOTE, SERVER, DATABASE) titlestring No Item title tagsstring No Comma-separated list of tags fieldsstring No JSON array of field objects (e.g., [{"label":"username","value":"admin","type":"STRING","purpose":"USERNAME"}]). "purpose" is honored in Connect Server mode; in Service Account mode 1Password infers it from the field label/type instead.
Parameter Type Description responsejson Deprecated — kept for backward compatibility with workflows saved before per-operation outputs were added below. Never populated; use the operation-specific outputs instead. vaultsjson List of accessible vaults [{id, name, description, items, type, createdAt, updatedAt}] idstring Vault or item ID namestring Vault name descriptionstring Vault description itemsjson Number of items in the vault (Get Vault) or item summaries [{id, title, category, tags, favorite, version, updatedAt}] (List Items) typestring Vault type (USER_CREATED, PERSONAL, or EVERYONE) titlestring Item title categorystring Item category (e.g., LOGIN, API_CREDENTIAL, SECURE_NOTE) vaultjson Vault reference the item belongs to {id} fieldsjson Item fields including secrets [{id, label, type, purpose, value}] sectionsjson Item sections [{id, label}] filesjson Files attached to the item [{id, name, size, section}] — fetch content with Get Item File tagsjson Item tags urlsjson URLs associated with the item [{href, label, primary}] favoriteboolean Whether the item is favorited versionnumber Item version number statestring Item state (ARCHIVED, or absent/null when active) lastEditedBystring ID of the last editor createdAtstring Creation timestamp updatedAtstring Last update timestamp successboolean Whether the item was successfully deleted valuestring The resolved secret value referencestring The original secret reference URI filefile Downloaded file attachment
Replace an entire item with new data (full update)
Inputs and outputsParameter Type Required Description connectionModestring No Connection mode: "service_account" or "connect" serviceAccountTokenstring No 1Password Service Account token (for Service Account mode) apiKeystring No 1Password Connect API token (for Connect Server mode) serverUrlstring No 1Password Connect server URL (for Connect Server mode) vaultIdstring Yes The vault UUID itemIdstring Yes The item UUID to replace itemstring Yes JSON object representing the full item (e.g., {"vault":{"id":"..."},"category":"LOGIN","title":"My Item","fields":[...]})
Parameter Type Description responsejson Deprecated — kept for backward compatibility with workflows saved before per-operation outputs were added below. Never populated; use the operation-specific outputs instead. vaultsjson List of accessible vaults [{id, name, description, items, type, createdAt, updatedAt}] idstring Vault or item ID namestring Vault name descriptionstring Vault description itemsjson Number of items in the vault (Get Vault) or item summaries [{id, title, category, tags, favorite, version, updatedAt}] (List Items) typestring Vault type (USER_CREATED, PERSONAL, or EVERYONE) titlestring Item title categorystring Item category (e.g., LOGIN, API_CREDENTIAL, SECURE_NOTE) vaultjson Vault reference the item belongs to {id} fieldsjson Item fields including secrets [{id, label, type, purpose, value}] sectionsjson Item sections [{id, label}] filesjson Files attached to the item [{id, name, size, section}] — fetch content with Get Item File tagsjson Item tags urlsjson URLs associated with the item [{href, label, primary}] favoriteboolean Whether the item is favorited versionnumber Item version number statestring Item state (ARCHIVED, or absent/null when active) lastEditedBystring ID of the last editor createdAtstring Creation timestamp updatedAtstring Last update timestamp successboolean Whether the item was successfully deleted valuestring The resolved secret value referencestring The original secret reference URI filefile Downloaded file attachment
Update an existing item using JSON Patch operations (RFC6902)
Inputs and outputsParameter Type Required Description connectionModestring No Connection mode: "service_account" or "connect" serviceAccountTokenstring No 1Password Service Account token (for Service Account mode) apiKeystring No 1Password Connect API token (for Connect Server mode) serverUrlstring No 1Password Connect server URL (for Connect Server mode) vaultIdstring Yes The vault UUID itemIdstring Yes The item UUID to update operationsstring Yes JSON array of RFC6902 patch operations (e.g., [{"op":"replace","path":"/title","value":"New Title"}])
Parameter Type Description responsejson Deprecated — kept for backward compatibility with workflows saved before per-operation outputs were added below. Never populated; use the operation-specific outputs instead. vaultsjson List of accessible vaults [{id, name, description, items, type, createdAt, updatedAt}] idstring Vault or item ID namestring Vault name descriptionstring Vault description itemsjson Number of items in the vault (Get Vault) or item summaries [{id, title, category, tags, favorite, version, updatedAt}] (List Items) typestring Vault type (USER_CREATED, PERSONAL, or EVERYONE) titlestring Item title categorystring Item category (e.g., LOGIN, API_CREDENTIAL, SECURE_NOTE) vaultjson Vault reference the item belongs to {id} fieldsjson Item fields including secrets [{id, label, type, purpose, value}] sectionsjson Item sections [{id, label}] filesjson Files attached to the item [{id, name, size, section}] — fetch content with Get Item File tagsjson Item tags urlsjson URLs associated with the item [{href, label, primary}] favoriteboolean Whether the item is favorited versionnumber Item version number statestring Item state (ARCHIVED, or absent/null when active) lastEditedBystring ID of the last editor createdAtstring Creation timestamp updatedAtstring Last update timestamp successboolean Whether the item was successfully deleted valuestring The resolved secret value referencestring The original secret reference URI filefile Downloaded file attachment
Delete an item from a vault
Inputs and outputsParameter Type Required Description connectionModestring No Connection mode: "service_account" or "connect" serviceAccountTokenstring No 1Password Service Account token (for Service Account mode) apiKeystring No 1Password Connect API token (for Connect Server mode) serverUrlstring No 1Password Connect server URL (for Connect Server mode) vaultIdstring Yes The vault UUID itemIdstring Yes The item UUID to delete
Parameter Type Description successboolean Whether the item was successfully deleted
Resolve a secret reference (op://vault/item/field) to its value. Service Account mode only.
Inputs and outputsParameter Type Required Description connectionModestring No Connection mode: must be "service_account" for this operation serviceAccountTokenstring Yes 1Password Service Account token secretReferencestring Yes Secret reference URI (e.g., op://vault-name/item-name/field-name or op://vault-name/item-name/section-name/field-name)
Parameter Type Description valuestring The resolved secret value referencestring The original secret reference URI