Safe items
Add an item to your vault
POST /object/item
Add a new login, card, secure note, or identity to your safe.
Parameters :
No parameters
Request body :
The request body must contain an object representing the item to add to your safe. Indicate item type with "type": and only provide data in the appropriate type's object (e.g. "login":{} or "identity":{})
Request body examples
{
"organizationId": "org id value",
"collectionId": "collection id value",
"folderId": null,
"type": 1,
"name": "Shared Account",
"notes": null,
"favorite": false,
"fields": [
{
"Security Question": "What is your name?"
}
],
"login": {
"uris": [
{
"match": 0,
"uri": "https://domain.com/login"
}
],
"username": "user@email.ca",
"password": "Password Value",
"totp": null
},
"reprompt": true
}{
"organizationId": null,
"collectionId": null,
"folderId": "id number",
"type": 2,
"name": "Secure Note Name",
"notes": "Secure Notes ",
"favorite": false,
"fields": [],
"secureNote": {
"type": 0
},
"reprompt": false
}{
"organizationId": "org id value",
"collectionId": "collection id value",
"folderId": null,
"type": 3,
"name": "Credit Card Name",
"notes": null,
"favorite": true,
"fields": [],
"card": {
"cardholderName": "James Bond",
"brand": "visa",
"number": "1111222233334444",
"expMonth": "07",
"expYear": "2024",
"code": "098"
},
"reprompt": true
}{
"organizationId": null,
"collectionId": null,
"folderId": "id number",
"type": 4,
"name": "Identity Name",
"notes": "notes value.",
"favorite": false,
"fields": [],
"identity": {
"title": "Mr",
"firstName": "James",
"middleName": "007",
"lastName": "Bond",
"address1": "133 Any St",
"address2": "apt 7",
"address3": null,
"city": "New York",
"state": "NY",
"postalCode": "00007",
"country": "US",
"company": "007 Inc.",
"email": "James@bond.com",
"phone": "555123456512",
"ssn": "000-000-0097",
"username": "jbond",
"passportNumber": "US-123456789",
"licenseNumber": "D111-22-33"
},
"reprompt": false
}Request URL examples
https://domain.com
Edit an item in your vault
PUT /object/item/{id}
Edit an existing login, card, secure note, or identity in your safe by specifying a unique object identifier in the path and the new object contents in the request body.
Parameters :
Id - Unique identifier of the item to edit.
Request body:
The request body must contain an object representing the edits to make to the item.
Request body examples
{
"organizationId": "org id value",
"collectionId": "collection id value",
"folderId": null,
"type": 1,
"name": "Shared Account",
"notes": null,
"favorite": false,
"fields": [
{
"Security Question": "What is your name?"
}
],
"login": {
"uris": [
{
"match": 0,
"uri": "https://domain.com/login"
}
],
"username": "user@email.ca",
"password": "Password Value",
"totp": null
},
"reprompt": true
}{
"organizationId": null,
"collectionId": null,
"folderId": "id number",
"type": 2,
"name": "Secure Note Name",
"notes": "Secure Notes ",
"favorite": false,
"fields": [],
"secureNote": {
"type": 0
},
"reprompt": false
}{
"organizationId": "org id value",
"collectionId": "collection id value",
"folderId": null,
"type": 3,
"name": "Credit Card Name",
"notes": null,
"favorite": true,
"fields": [],
"card": {
"cardholderName": "James Bond",
"brand": "visa",
"number": "1111222233334444",
"expMonth": "07",
"expYear": "2024",
"code": "098"
},
"reprompt": true
}{
"organizationId": null,
"collectionId": null,
"folderId": "id number",
"type": 4,
"name": "Identity Name",
"notes": "notes value.",
"favorite": false,
"fields": [],
"identity": {
"title": "Mr",
"firstName": "James",
"middleName": "007",
"lastName": "Bond",
"address1": "133 Any St",
"address2": "apt 7",
"address3": null,
"city": "New York",
"state": "NY",
"postalCode": "00007",
"country": "US",
"company": "007 Inc.",
"email": "James@bond.com",
"phone": "555123456512",
"ssn": "000-000-0097",
"username": "jbond",
"passportNumber": "US-123456789",
"licenseNumber": "D111-22-33"
},
"reprompt": false
}Request URL examples
https://domain.com
Retrieve an item from your vault
GET /object/item/{id}
Retrieve an existing item from your safe by specifying a unique object identifier in the path.
Parameters:
Id- Unique identifier of the item to retrieve.
Request URL examples:
https://domain.com
Delete an item from your vault
DELETE /object/item/{id}
Delete an existing item from your safe by specifying the unique object identifier in the path.
Parameters:
Id- Unique identifier of the item to retrieve.
Request URL examples:
https://domain.com
Restore a deleted item
POST /restore/item/{id}
Restore an item that was sent to the trash by specifying the unique object identifier in the path.
Parameters:
Id- Unique identifier of the item to restore.
Request URL examples:
https://domain.com
Retrieve a list of items from your vault
GET /list/object/items
Retrieve a list of existing items in your safe. By default, this will return a list of all existing items in your safe, however you can specify filters or search terms as query parameters to narrow list results.
Using multiple filters will perform a logical OR operation. Using filters and search terms will perform a logical AND operation
Parameters:
organizationidcollectionidfolderidurltrashsearch
Request URL examples:
https://domain.com/list/object/items?organizationid=1234567890&collectionid=1234567890