File list

Documentation for using the OSSN API's GET method to retrieve a list of all files uploaded by a user (including DOCX, PDF, MP4, MP3, ZIP, etc.). Pass the user ID as a parameter to fetch their complete file inventory from the OSSN system.

Endpoint:

Method:

  • POST / GET

Parameter:

Parameter name Required Type Explain
api_key_token Yes string Your API key
container_type Yes integer user or group
container_guid optional integer User guid if you wish to load specific user files
offset no integer -

Example Response

{
    "merchant": "Premium Social Network",
    "url": "http:\/\/local.openteknik.com\/",
    "time_token": 1632345047,
    "payload": {
        "list": [
            {
                "guid": 134,
                "time_created": 1632344926,
                "owner_guid": 1,
                "description": "Test",
                "title": "somefile.pdf",
                "type": "user",
                "subtype": "file",
                "container_type": "user",
                "container_guid": "1",
                "file:File": "http:\/\/local.openteknik.com\/files\/download\/134",
                "icon": "http:\/\/local.openteknik.com\/components\/Files\/images\/icons\/pdf-icon-128x128.png"
            }
        ],
        "offset": false,
        "count": 1
    },
    "code": "100",
    "message": "Request successfully executed"
}

Return payload parameter description

Parameter name Explain
count Total list
offset current offset

Services View All