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 Files API

Operations for listing and retrieving files attached to items.

1Password Files 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 Files. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 5 JSON Schemas.

This API exposes 3 operations across 3 paths, and defines 3 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.

3 operations 3 paths 3 schemas 3 GET

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 Files 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 3

Across 3 paths, the API surfaces 3 operations — 3 GET. Each is listed below with its method, path, parameters, and response codes.

Files 3

Operations for listing and retrieving files attached to items.

GET
/v1/vaults/{vaultUuid}/items/{itemUuid}/files
1Password List Files Attached to an Item
listFiles 3 params → 200401404
GET
/v1/vaults/{vaultUuid}/items/{itemUuid}/files/{fileUuid}
1Password Get File Details
getFileById 4 params → 200401404
GET
/v1/vaults/{vaultUuid}/items/{itemUuid}/files/{fileUuid}/content
1Password Get File Content
getFileContent 3 params → 200401404

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are File (6 properties), Error (2 properties), SectionRef (1 property). Each schema is shown below with its type and property counts.

Error
object
Represents an error response from the Connect server.
2 properties
File
object
Represents a file attached to an item in a vault.
6 properties
SectionRef
object
A reference to a section within an item.
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

Other APIs 1Password publishes across the network.

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