Users
Manage users (employees and clients)
6 tools
Get Current User
POST /v1/tools/sharefile/getCurrentUser
Get the currently authenticated user's profile
Prefer minimal output: • basic info → summary_only: true Full response only when you need preferences or company details.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
include_security | boolean | optional | Include security settings (lock status, login attempts) |
include_preferences | boolean | optional | Include user preferences |
summary_only | boolean | optional | Essential fields only (Id, Email, FullName) |
Flags
| Name | Type | Description |
|---|---|---|
summary_only | boolean | Essential fields only (Id, Email, FullName) |
Request
curl -X POST https://api.syncello.io/v1/tools/sharefile/getCurrentUser \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json"Response
{
"IsAdministrator": true,
"CanCreateFolders": true,
"CanUseFileBox": true,
"CanManageUsers": true,
"IsVirtualClient": false,
"Company": "Acme Corporation",
"FullName": "Jane Doe",
"FirstName": "Jane",
"LastName": "Doe",
"DateCreated": "2024-01-15T16:06:13Z",
"FullNameShort": "J. Doe",
"Initials": "JD",
"Emails": [
"jane@example.com"
],
"IsConfirmed": true,
"IsDeleted": false,
"Roles": [
"Employee",
"CanManageAccount",
"CanCreateFolders"
],
"IsBillingContact": true,
"Email": "jane@example.com",
"Username": "jane@example.com",
"Domain": "acmefiles",
"Id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"url": "https://acmefiles.sf-api.com/sf/v3/Users(a1b2c3d4-e5f6-7890-abcd-ef1234567890)"
} Try It
Try it
Sign in to execute this tool
Sign InGet User
POST /v1/tools/sharefile/getUser
Get a specific user by ID or email
Prefer minimal output: • basic info → summary_only: true • storage quota → include_disk_space: true • security status → include_security: true Full response only when you need all profile fields.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
user_id | string | optional | User ID to retrieve |
email | string | optional | User email to look up (alternative to user_id) |
include_security | boolean | optional | Include security settings |
include_preferences | boolean | optional | Include user preferences |
include_disk_space | boolean | optional | Include disk space usage |
summary_only | boolean | optional | Essential fields only (Id, Email, FullName, status) |
Flags
| Name | Type | Description |
|---|---|---|
summary_only | boolean | Essential fields only (Id, Email, FullName, status) |
Request
curl -X POST https://api.syncello.io/v1/tools/sharefile/getUser \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json"Response
{
"Company": "Northwind Traders",
"FullName": "Dana Client",
"FirstName": "Dana",
"LastName": "Client",
"DateCreated": "2026-05-10T18:22:33Z",
"FullNameShort": "D. Client",
"Initials": "DC",
"Emails": [
"dana@northwind.example.com"
],
"IsConfirmed": false,
"IsDeleted": false,
"Roles": [
"Client",
"CanChangePassword",
"CanManageMySettings"
],
"IsBillingContact": false,
"Email": "dana@northwind.example.com",
"Username": "dana@northwind.example.com",
"Domain": "acmefiles",
"Id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
"url": "https://acmefiles.sf-api.com/sf/v3/Users(b2c3d4e5-f6a7-8901-bcde-f12345678901)"
}Alternate mode
{
"Id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
"Email": "dana@northwind.example.com",
"FullName": "Dana Client",
"IsConfirmed": false
} Try It
Try it
Sign in to execute this tool
Sign InList Users
POST /v1/tools/sharefile/listUsers
List users in the ShareFile account with optional filtering
List users in the account. Use is_employee=true for employees only, is_employee=false for clients only. Use is_confirmed=true to filter to confirmed users.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
top | number | optional | Maximum number of users to return (default 100) |
skip | number | optional | Number of users to skip (pagination) |
filter | string | optional | OData filter (e.g., "IsEmployee eq true") |
orderby | string | optional | OData orderby (e.g., "LastName asc") |
is_employee | boolean | optional | Filter to only employees (true) or only clients (false) |
is_confirmed | boolean | optional | Filter to only confirmed users |
summary_only | boolean | optional | Return only Id, Email, FullName, IsEmployee, IsConfirmed |
Flags
| Name | Type | Description |
|---|---|---|
summary_only | boolean | Return only Id, Email, FullName, IsEmployee, IsConfirmed |
Request
curl -X POST https://api.syncello.io/v1/tools/sharefile/listUsers \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json"Response
{
"total_count": 2,
"returned_count": 2,
"has_more": false,
"users": [
{
"FullName": "Jane Doe",
"FirstName": "Jane",
"LastName": "Doe",
"Company": "Acme Corporation",
"Email": "jane@example.com",
"IsEmployee": true,
"IsConfirmed": true,
"Id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"url": "https://acmefiles.sf-api.com/sf/v3/Users(a1b2c3d4-e5f6-7890-abcd-ef1234567890)"
},
{
"FullName": "Dana Client",
"FirstName": "Dana",
"LastName": "Client",
"Company": "Northwind Traders",
"Email": "dana@northwind.example.com",
"IsEmployee": false,
"IsConfirmed": false,
"Id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
"url": "https://acmefiles.sf-api.com/sf/v3/Users(b2c3d4e5-f6a7-8901-bcde-f12345678901)"
}
]
} Try It
Try it
Sign in to execute this tool
Sign InCreate User
POST /v1/tools/sharefile/createUser
Create a new user (employee or client) in the ShareFile account
Creates a new user in the account. Use is_employee=true to create an employee, false (default) for a client. Employees have more privileges than clients.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
email | string | required | Email address for the new user (required) |
first_name | string | optional | First name of the user |
last_name | string | optional | Last name of the user |
company | string | optional | Company name |
is_employee | boolean | optional | Create as employee (true) or client (false). Default: false |
password | string | optional | Initial password (optional - user may need to set via email) |
notify | boolean | optional | Send welcome email notification (default: true) |
add_shared | boolean | optional | Add user to Shared Address Book |
add_personal | boolean | optional | Add user to Personal Address Book |
Request
curl -X POST https://api.syncello.io/v1/tools/sharefile/createUser \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json"
-d '{
"email": "example"
}'Response
{
"Company": "Northwind Traders",
"TotalSharedFiles": 0,
"Contacted": 0,
"FullName": "Dana Client",
"ReferredBy": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"FirstName": "Dana",
"LastName": "Client",
"DateCreated": "2026-07-02T18:22:33Z",
"FullNameShort": "D. Client",
"Initials": "DC",
"Emails": [
"dana@northwind.example.com"
],
"IsConfirmed": false,
"IsDeleted": false,
"Roles": [
"Client",
"CanChangePassword",
"CanManageMySettings"
],
"IsBillingContact": false,
"Email": "dana@northwind.example.com",
"Username": "dana@northwind.example.com",
"Domain": "acmefiles",
"Id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
"url": "https://acmefiles.sf-api.com/sf/v3/Users(b2c3d4e5-f6a7-8901-bcde-f12345678901)"
} Try It
Try it
Sign in to execute this tool
Sign InUpdate User
POST /v1/tools/sharefile/updateUser
Update user properties (name, company, security settings)
Update user profile properties. Use is_disabled=true to disable a user account.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
user_id | string | required | ID of the user to update |
first_name | string | optional | Updated first name |
last_name | string | optional | Updated last name |
company | string | optional | Updated company name |
is_disabled | boolean | optional | Disable (true) or enable (false) the user |
Request
curl -X POST https://api.syncello.io/v1/tools/sharefile/updateUser \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json"
-d '{
"user_id": "example"
}'Response
{
"Company": "Northwind Traders LLC",
"FullName": "Dana Client",
"FirstName": "Dana",
"LastName": "Client",
"DateCreated": "2026-07-02T18:22:33Z",
"Emails": [
"dana@northwind.example.com"
],
"IsConfirmed": false,
"IsDeleted": false,
"Roles": [
"Client",
"CanChangePassword",
"CanManageMySettings"
],
"Email": "dana@northwind.example.com",
"Username": "dana@northwind.example.com",
"Domain": "acmefiles",
"Id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
"url": "https://acmefiles.sf-api.com/sf/v3/Users(b2c3d4e5-f6a7-8901-bcde-f12345678901)"
} Try It
Try it
Sign in to execute this tool
Sign InDelete User
POST /v1/tools/sharefile/deleteUser
Delete a user from the ShareFile account
Delete or disable a user. Use completely=true to permanently delete (cannot be undone). Default behavior is to disable the account.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
user_id | string | required | ID of the user to delete |
completely | boolean | optional | If true, permanently delete. If false, disable only (default: false) |
Request
curl -X POST https://api.syncello.io/v1/tools/sharefile/deleteUser \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json"
-d '{
"user_id": "example"
}'Response
{
"message": "User b2c3d4e5-f6a7-8901-bcde-f12345678901 permanently deleted successfully"
} Try It
Try it
Sign in to execute this tool
Sign In