Passwordstate Documentation

Retrieving All Passwords in a Password List ​

GET /api/passwords

You can retrieve all Passwords in a Password List by specifying the PasswordListID & APIKey values, with a simple GET request.

Note 1: If you omit the 'QueryAll' parameter, the API will interpret the PasswordListID as PasswordID, due to the syntax of the API Controller.

Note 2: By default, the retrieval of all Passwords records will add one Audit record for every Password record returned. If you wish to prevent audit records from being added, you can set the PreventAuditing parameter to true - if this parameter is omitted, the default option is false.

Powershell
# PowerShell Request
$PasswordstateUrl = 'https://passwordstate/api/passwords/<PasswordListID>?QueryAll&PreventAuditing=<value>'
Invoke-Restmethod -Method GET -Uri $PasswordstateUrl -Header @{ "APIKey" = "<apikey>" }
Json
# Response
[
    {
        "PasswordID": 46865,
        "Title": "$25 Winners",
        "UserName": "",
        "Description": "Must be for a pool",
        "GenericField1": "",
        "GenericField2": "",
        "GenericField3": "",
        "GenericField4": "",
        "GenericField5": "",
        "GenericField6": "",
        "GenericField7": "",
        "GenericField8": "",
        "GenericField9": "",
        "GenericField10": "",
        "GenericFieldInfo": [],
        "AccountTypeID": 0,
        "Notes": "",
        "URL": "",
        "Password": "q6xnfuW&B",
        "ExpiryDate": "",
        "AllowExport": true,
        "AccountType": "",
        "OTP": "",
        "OTPUri": "" 
     },
    {
        "PasswordID": 46903,
        "Title": "atelerik",
        "UserName": "useraccount1",
        "Description": "Terlerik Login",
        "GenericField1": "",
        "GenericField2": "",
        "GenericField3": "",
        "GenericField4": "",
        "GenericField5": "",
        "GenericField6": "",
        "GenericField7": "",
        "GenericField8": "",
        "GenericField9": "",
        "GenericField10": "",
        "GenericFieldInfo": [],
        "AccountTypeID": 0,
        "Notes": "",
        "URL": "http://www.telerik.com",
        "Password": "ZHn#3+A^yc",
        "ExpiryDate": "",
        "AllowExport": true,
        "AccountType": "",
        "OTP": "",
        "OTPUri": ""
    },
    ...
]