Passwordstate Documentation

Search Password Documents ​

GET /userapi/searchdocuments/password

Searching for password documents in Password Lists can be achieved by passing a GET request, and the User's API Key set on their Preferences screen. The level of access to documents is the same as when the user is logged into the web User Interface.

  • You can search for Password record documents within a specific Password List by specifying the PasswordListID, or if you leave this blank, you can search across all Password Lists.
  • If you want to return all Password record documents in a Password List, or across all Password Lists, you can also leave 'searchcriteria' blank.
  • Searching is performed on the Document Name and Description, as well as the name of the Password List the document belongs to.
  • Searching only in specific Password records for documents is not supported - you instead search within a Password List for the Password documents.
Powershell
PowerShell Request
# Search for password documents within a specific Password List, based on document details
$PasswordstateUrl = 'https://passwordstate/userapi/searchdocuments/password/<passwordlistid>?search=<searchcriteria>'

# Search for password documents across all Password Lists, based on document properties
$PasswordstateUrl = 'https://passwordstate/userapi/searchdocuments/password/?search=<searchcriteria>'
                           
# Return all password documents in a Password List
$PasswordstateUrl = 'https://passwordstate/userapi/searchdocuments/password/<passwordlistid>?search='

# Return all password documents in all Password Lists
$PasswordstateUrl = 'https://passwordstate/userapi/searchdocuments/password/?search='

Invoke-Restmethod -Method GET -Uri $PasswordstateUrl -Header @{ "UserID" = "<UserID>" ; "APIKey" = "<APIKey>" }
Json
# Response
HTTP/1.1 200          
[
    {
        "DocumentID": 27,
        "DocumentName": "Domain_Password_Policies.pdf",
        "DocumentDescription": "",
        "Modified": "2026-07-02 12:14:00",
        "ModifiedBy": "Fistname Surname",
        "FileSize": "214 KB",
        "PasswordListID": 183,
        "PasswordList": "Active Directory",
        "TreePath": "\Infrastructure\Active Directory",
        "PasswordID": 51268,
        "Title": "Domain Account",
    }
]