Qodex.ai

List existing Shareboxes

GET {{api-server}}/{{token}}/v5/shares

This endpoint retrieves detailed information about existing Shareboxes, including their contents, validity periods, and access settings.

The response of the request can be documented as a JSON schema as follows:

{
    "type": "object",
    "properties": {
        "status": {"type": "string"},
        "shares": {
            "type": "array",
            "items": {
                "type": "object",
                "properties": {
                    "uuid": {"type": "string"},
                    "title": {"type": "string"},
                    "description": {"type": "string"},
                    "items": {
                        "type": "array",
                        "items": {
                            "type": "object",
                            "properties": {
                                "identifiers": {
                                    "type": "array",
                                    "items": {"type": "string"}
                                },
                                "type": {"type": "string"}
                            }
                        }
                    },
                    "starts_at": {"type": "string"},
                    "expires_at": {"type": "string"},
                    "starts_tz": {"type": "string"},
                    "expires_tz": {"type": "string"},
                    "auth": {
                        "type": "array",
                        "items": {
                            "type": "object",
                            "properties": {
                                "pass": {"type": "string"},
                                "user": {"type": "string"}
                            }
                        }
                    },
                    "share_uri": {"type": "string"},
                    "puid": {"type": "string"}
                }
            }
        },
        "info": {
            "type": "object",
            "properties": {
                "duration": {"type": "number"},
                "api_version": {"type": "number"}
            }
        },
        "api_version": {
            "type": "object",
            "properties": {
                "hash": {"type": "string"},
                "datetime": {"type": "string"},
                "module": {"type": "string"}
            }
        }
    }
}

HEADERS

KeyDatatypeRequiredDescription
X-Filerobot-Keystring

RESPONSES

status: OK

{"status":"success","shares":[{"uuid":"028f53bb-0148-409f-88ed-483dd8c33e6e","title":"My share link 08/17/2024 06:29 PM","description":"Short description","items":[{"identifiers":["59aac4eb-ccf1-56b3-a4d6-634e77750000","f2ebf6f6-39f2-56e6-ba74-d9b956c50000"],"type":"file_uuid"}],"starts_at":"2024-08-18T16:29:00Z","expires_at":"2024-08-24T16:29:00Z","starts_tz":"Europe/London","expires_tz":"Europe/London","auth":[{"pass":"123","user":""}],"share_uri":"https://share.filerobot.com/token/v5/s/sY6mkuRLxuhXh81YccsLSwE0fu/my-share-link-08-17-2024-06:29-pm","puid":"sY6mkuRLxuhXh81YccsLSwE0fu"},{"uuid":"fc650800-7501-4423-a5b3-01661d71266c","title":"My share link 08/17/2024 06:48 PM","description":"Short description","items":[{"identifiers":["59aac4eb-ccf1-56b3-a4d6-634e77750000","f2ebf6f6-39f2-56e6-ba74-d9b956c50000"],"type":"file_uuid"}],"starts_at":"2024-08-18T16:29:00Z","expires_at":"2024-08-24T16:29:00Z","starts_tz":"Europe/London","expires_tz":"Europe/London","auth":[{"pass":"123","user":""}],"share_uri":"https://share.filerobot.com/token/v5/s/s2nTJoyufe2oRYl9wktl7AkcqI/my-share-link-08-17-2024-06:48-pm","puid":"s2nTJoyufe2oRYl9wktl7AkcqI"}],"info":{"duration":0.08747076988220215,"api_version":5},"api_version":{"hash":"1ce24f12ff9f3205395f34065a5b87bbfa619e25","datetime":"2024-08-13T12:13:54+07:00","module":"elastic_v2"}}