Passwordstate Documentation

Search Password List Documents ​

GET /userapi/searchdocuments/passwordlist

Searching for 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 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 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.
Powershell
PowerShell Request
# Search within a specific Password List, based on document details
$PasswordstateUrl = 'https://passwordstate/userapi/searchdocuments/passwordlist/<passwordlistid>?search=<searchcriteria>'

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

# Return all documents in all Password Lists
$PasswordstateUrl = 'https://passwordstate/userapi/searchdocuments/passwordlist/?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"
    }
]