How to obtain a list of a user's files

User files can be retrieved by using the following URL and specifying a user ID, starting record number and ending record number.  If left blank, this will default to the first 50 records.  Invoices are returned in order of descending date.

 

 Method URL
 GET  https://api.fairwarningsoftware.com/v1.1.1/user/files/[user-id]/[start]/[limit]

 

 Status Response
 200

 {
    "categories" : [
        {
            "category" : {
                "file_category_name" : <file_category_name>
                "files" : [
                    {
                        "file" : {
                            "file_id" : <file_id>,
                            "company_id" : <company_id>,
                            "user_id" : <user_id>,
                            "file_display_to_user" : <file_display_to_user>,
                            "file_category_id" : <file_category_id>,
                            "file_title" : <file_title>,
                            "file_name" : <file_name>,
                            "file_original_name" : <file_original_name>,
                            "file_date" : <file_date>,
                            "file_expiration_date" : <file_expiration_date>,
                            "file_category_name" : <file_category_name>,
                            "file_link" : <file_link>
                        }
                    }
                }
            ]
        }
    ],
    "record_count" : <record_count>
}
401  {"error":"The API keys provided are invalid."}
403  {"error":"API keys are missing."}
500  {"error": <custom error>}

 

 Field  Type Description
file_category_name string The name of the category for the files it contains.
    files object And object containing an array of files.
        file object An object containing data about a single file.
            file_id int The unique identifier for a file.
            company_id
 int The user's company ID.
            user_id
 int The user's ID.
            file_display_to_user
 bool Whether the file should be displayed to the user.  This will also be true.
            file_category_id
 int The ID of the category the file belongs to.
            file_title
 string The custom title assigned to the file.
            file_name string The actual name of the file.
            file_original_name string The original name of the file.
            file_date string The timestamp the file was uploaded.
            file_expiration_date string The date the file expires.
            file_link string The URL where the file can be accessed.