External DocumentationTo learn more, visit the 1Password Connect Server documentation.
Parameters
| Parameter | Description |
|---|---|
| Item ID | The ID of the item to retrieve details of. Can be obtained by using the List Items action. |
| Operation | Select the operation to perform. |
| Path | An RFC6901 JSON Pointer to one of the following:* An item’s attribute. For example: /title - to update the item’s title.* An item’s field by field ID. For example: /fields/username - for updating the entire username field in an item.* An item’s field attribute. For example: /fields/username/value - for updating only the value of the username field in an item. |
| Value | The value to apply at the specified path. This can be one of the following: * A new item attribute e.g. a new title.* A new value for an item's field (a JSON object that represents the field).* A new value for an item's field attribute e.g. a new username value.Note: The value you provide must match the path you specify. For example if you used the path format /fields/<field_id> the value must represent a field object. |
| Vault ID | The ID of the vault the item belongs to. Can be obtained by using the List Vaults action. |
Example Output
{
"id": "kfl2pmrdx434sdow6pvaxrwpxq",
"title": "New Item 1",
"favorite": true,
"tags": [
"tag1",
"tag2"
],
"version": 12,
"vault": {
"id": "89gk4nl4mdj7updlhn4tcvilok",
"name": ""
},
"category": "LOGIN",
"created_at": "2025-10-05T14:32:14Z",
"updated_at": "2025-10-05T15:04:32.972821076Z",
"additional_information": "XYZ",
"sections": [
{
"id": "credentials",
"label": "Credentials"
}
],
"fields": [
{
"id": "username",
"type": "STRING",
"purpose": "USERNAME",
"label": "username",
"value": "user1"
},
{
"id": "password",
"type": "CONCEALED",
"purpose": "PASSWORD",
"label": "password",
"value": "xqhAkjidE6EX4qPuWJf8",
"password_details": {
"strength": "EXCELLENT"
}
},
{
"id": "notesPlain",
"type": "STRING",
"purpose": "NOTES",
"label": "notesPlain"
},
{
"id": "buwabgpja4rhkh4cbkwvq6fymq",
"type": "URL",
"value": "https://example.com"
},
{
"id": "ba4n4qght3nm2nthhptt4lxps4",
"section": {
"id": "credentials",
"label": "Credentials"
},
"type": "CONCEALED",
"label": "token",
"value": "123456"
}
]
}