View information about FTP users


This action requires the following tokens:

  • ftp-user-read


Required arguments are marked in bold, and optional arguments are marked in italics.

Argument Type Default Description
username String   Only show the FTP user with the given username
limit Integer 20 The maximum number of results to include in the output
offset Integer 0 The number of results to skip when outputting
orderfield String username

Defines the field to order the results by; can be any of the following:

  • username – Order on the username
order String asc Sort the results by the field given in orderfield in ascending or descending order, by using ‘asc‘ or ‘desc‘ respectively


This action produces the following extra headers on success, besides the default headers:

Name Type Description
count Integer The total number of results that would be returned when pagination would be disabled

This action produces the following output on success:

An array containing zero or more elements, each one being an object containing the following fields:

Name Type Description
username String The username for this FTP user
password String The password for this FTP user

The account to which the FTP user belongs

The value of this field is an object containing the following fields:

Name Type Description
id Hash Account ID
name String Account name


This action will always return one of the default status codes.