Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

1Password Items API

Operations for creating, reading, updating, and deleting items within vaults.

1Password Items API is one of 11 APIs that 1Password publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 5 JSON Schema definitions.

Tagged areas include Items. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 5 JSON Schemas.

This API exposes 6 operations across 2 paths, and defines 10 schemas. It is described by OpenAPI 3.1.0, at version 1.8.1.

Requests are made against a single base URL, http://localhost:8080.

6 operations 2 paths 10 schemas 1 DELETE2 GET1 PATCH1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.8.1
Base URL
http://localhost:8080
Authentication
HTTP Bearer
License
Terms of Service
Resource Areas
1

Authentication & Security 1

1Password Items API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — A Connect server access token generated from 1Password. Each request must include this token in the Authorization header.

Paths & Operations 6

Across 2 paths, the API surfaces 6 operations — 1 DELETE, 2 GET, 1 PATCH, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Items 6

Operations for creating, reading, updating, and deleting items within vaults.

GET
/v1/vaults/{vaultUuid}/items
1Password List Items in a Vault
listItems 2 params → 200401404
POST
/v1/vaults/{vaultUuid}/items
1Password Create a New Item
createItem 1 param body → 200400401404
GET
/v1/vaults/{vaultUuid}/items/{itemUuid}
1Password Get Item Details
getItemById 2 params → 200401404
PUT
/v1/vaults/{vaultUuid}/items/{itemUuid}
1Password Replace an Item
replaceItem 2 params body → 200400401404
PATCH
/v1/vaults/{vaultUuid}/items/{itemUuid}
1Password Update an Item
patchItem 2 params body → 200400401404
DELETE
/v1/vaults/{vaultUuid}/items/{itemUuid}
1Password Delete an Item
deleteItem 2 params → 204401404

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are Item (12 properties), Field (9 properties), GeneratorRecipe (3 properties), Url (2 properties). Each schema is shown below with its type and property counts.

GeneratorRecipe
object
Configuration for generating a random value for a field, such as password length and character types.
3 properties
Error
object
Represents an error response from the Connect server.
2 properties
JsonPatch
array
A JSON Patch document as defined by RFC 6902 for applying partial modifications to items.
SectionRef
object
A reference to a section within an item.
1 property
Url
object
Represents a URL associated with an item.
2 properties
VaultRef
object
A reference to a vault.
1 property
FullItem
object
Represents a complete 1Password item including all fields, sections, and associated metadata. Used for creating and updating items.
Field
object
Represents a field within an item that stores a value such as a username, password, or other data.
9 properties
Item
object
Represents a summary of a 1Password item with basic metadata. Use the get item endpoint to retrieve full details.
12 properties
Section
object
Represents a section within an item used to organize fields into logical groups.
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

1password-items-api-openapi.yml Raw ↑

Other APIs 1Password publishes across the network.

1Password Accounts API
1Password Activity API
1Password Audit Events API
1Password Files API
1Password Health API
1Password Introspection API
1Password Item Usages API
1Password Metrics API
1Password Sign-In Attempts API
1Password Vaults API