Passwordstate Documentation

Search Password Documents ​

GET /api/searchdocuments/password

Searching for password documents in Password Lists can be achieved by passing a GET request, and either the API Key from the Password List itself, or the Documents API key available on the screen Administration -> System Settings -> API.

  • 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 - the system wide Documents API Key must be used in this instance.
  • 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.
  • System Wide Documents API Key cannot be used on Private Password Lists.
Powershell
PowerShell Request
# Search for password documents within a specific Password List, based on document details
$PasswordstateUrl = 'https://passwordstate/api/searchdocuments/password/<passwordlistid>?search=<searchcriteria>'

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

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

Invoke-Restmethod -Method GET -Uri $PasswordstateUrl -Header @{ "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",
    }
]