List file sharing instances

POST

/data-sharing

Query and filter data sharing instances. An instance is created when a user shares a
file outside the organization either publicly or to a specific email address.
If the same file is shared multiple times, it will create multiple instances.
Use the file_id field to group by file.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/jsonRequired

Examples

Responses

🟢200

application/json

Successful operation

Body

🟠400

🟠401Unauthorized

🟠403Forbidden

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/data-sharing' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "query": "name='\''WINPC-4291'\'' AND status IN ('\''active'\'', '\''pending'\'')",
    "distinct_count": "string",
    "sort": "name desc, id",
    "limit": 10,
    "offset": 0,
    "include_total_count": true
}'

Response Example

200 - Example 1

{
    "pagination": {
        "count": 0,
        "total_count": 1000
    },
    "distinct_values": [
        {
            "value": null,
            "count": 0
        }
    ],
    "items": [
        {
            "id": "8CA67511-744C-4D74-B26E-7281CF88712F",
            "file_name": "IRR Calculator",
            "shared_with_domain": "gmail.com",
            "shared_with_email": "external.person@example.com",
            "timestamp": "2021-01-01T00:00:00Z",
            "external_id": "Ey2XECROYhlstoaUm",
            "employee_name": "Joe Smith",
            "employee_email": "joe.smith@example.com",
            "source": "unspecified",
            "risk_score": 9.2,
            "dlp_policies_violated": [
                "Confidential Data Policy"
            ],
            "file_id": "1A2B3C4D5E6F7G8H9I0J",
            "allowlisted": true
        }
    ]
}

Modified at 2026-02-10 23:10:01

Query database share user additions

List documents