Checking authentication...

Groups

Manage distribution groups

7 tools

Get Group

Read Idempotent

POST /v1/tools/sharefile/getGroup

Get details of a distribution group

Prefer minimal output: • basic info → summary_only: true • member list → include_contacts: true Full response only when you need Owner or Description.

Parameters

Name	Type	Required	Description
`group_id`	string	required	Group ID to retrieve
`include_contacts`	boolean	optional	Include group members/contacts (default false)
`summary_only`	boolean	optional	Essential fields only (Id, Name, IsShared, count)

Flags

Name	Type	Description
`summary_only`	boolean	Essential fields only (Id, Name, IsShared, count)

Request

curl -X POST https://api.syncello.io/v1/tools/sharefile/getGroup \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"
  -d '{
  "group_id": "example"
}'

Response

{
  "IsShared": true,
  "Contacts": [
    {
      "FirstName": "Dana",
      "LastName": "Client",
      "Company": "Northwind Traders",
      "IsConfirmed": false,
      "IsDisabled": false,
      "LastAnyLogin": "1900-01-01T05:00:00Z",
      "CreatedDate": "2026-07-02T18:22:33Z",
      "Name": "Client, Dana",
      "Email": "dana@northwind.example.com",
      "Id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
      "url": "https://acmefiles.sf-api.com/sf/v3/Contacts(b2c3d4e5-f6a7-8901-bcde-f12345678901)"
    }
  ],
  "Name": "Project Stakeholders",
  "Id": "g1a2b3c4-d5e6-7f80-9a1b-2c3d4e5f6a7b",
  "url": "https://acmefiles.sf-api.com/sf/v3/Groups(g1a2b3c4-d5e6-7f80-9a1b-2c3d4e5f6a7b)"
}

Alternate mode

{
  "Id": "g1a2b3c4-d5e6-7f80-9a1b-2c3d4e5f6a7b",
  "Name": "Project Stakeholders",
  "IsShared": true
}

Try It

Try it

List Groups

Read Idempotent

POST /v1/tools/sharefile/listGroups

List distribution groups in the account

List distribution groups. Use is_shared=true to filter to shared groups only.

Parameters

Name	Type	Required	Description
`top`	number	optional	Maximum number of groups to return
`skip`	number	optional	Number of groups to skip (pagination)
`is_shared`	boolean	optional	Filter to only shared groups
`summary_only`	boolean	optional	Return only Id, Name, IsShared, NumberOfContacts

Flags

Name	Type	Description
`summary_only`	boolean	Return only Id, Name, IsShared, NumberOfContacts

Request

curl -X POST https://api.syncello.io/v1/tools/sharefile/listGroups \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

Response

{
  "total_count": 1,
  "returned_count": 1,
  "has_more": false,
  "groups": [
    {
      "IsShared": true,
      "Name": "Project Stakeholders",
      "odata.type": "ShareFile.Api.Models.Group",
      "Id": "g1a2b3c4-d5e6-7f80-9a1b-2c3d4e5f6a7b",
      "url": "https://acmefiles.sf-api.com/sf/v3/Groups(g1a2b3c4-d5e6-7f80-9a1b-2c3d4e5f6a7b)"
    }
  ]
}

Try It

Try it

Create Group

Write

POST /v1/tools/sharefile/createGroup

Create a new distribution group

Create a distribution group for sharing with multiple users. Add members using user IDs or email addresses. Note: The ShareFile API does not support group descriptions.

Parameters

Name	Type	Required	Description
`name`	string	required	Name of the group
`is_shared`	boolean	optional	Make this a shared group (visible to other users)
`contacts`	array	optional	Array of user IDs or email addresses to add as members

Request

curl -X POST https://api.syncello.io/v1/tools/sharefile/createGroup \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"
  -d '{
  "name": "example"
}'

Response

{
  "IsShared": true,
  "Name": "Project Stakeholders",
  "odata.type": "ShareFile.Api.Models.Group",
  "Id": "g1a2b3c4-d5e6-7f80-9a1b-2c3d4e5f6a7b",
  "url": "https://acmefiles.sf-api.com/sf/v3/Groups(g1a2b3c4-d5e6-7f80-9a1b-2c3d4e5f6a7b)"
}

Try It

Try it

Update Group

Write

POST /v1/tools/sharefile/updateGroup

Update group properties (name, shared status)

Update group name or shared status.

Parameters

Name	Type	Required	Description
`group_id`	string	required	ID of the group to update
`name`	string	optional	New name for the group
`is_shared`	boolean	optional	Update shared status

Request

curl -X POST https://api.syncello.io/v1/tools/sharefile/updateGroup \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"
  -d '{
  "group_id": "example"
}'

Response

{
  "IsShared": false,
  "Name": "Project Stakeholders (Renamed)",
  "odata.type": "ShareFile.Api.Models.Group",
  "Id": "g1a2b3c4-d5e6-7f80-9a1b-2c3d4e5f6a7b",
  "url": "https://acmefiles.sf-api.com/sf/v3/Groups(g1a2b3c4-d5e6-7f80-9a1b-2c3d4e5f6a7b)"
}

Try It

Try it

Delete Group

Destructive

POST /v1/tools/sharefile/deleteGroup

Delete a distribution group

Delete a distribution group. This does not delete the member users, only the group.

Parameters

Name	Type	Required	Description
`group_id`	string	required	ID of the group to delete

Request

curl -X POST https://api.syncello.io/v1/tools/sharefile/deleteGroup \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"
  -d '{
  "group_id": "example"
}'

Response

{
  "message": "Group g1a2b3c4-d5e6-7f80-9a1b-2c3d4e5f6a7b deleted successfully"
}

Try It

Try it

Add Group Members

Write

POST /v1/tools/sharefile/addGroupMembers

Add members to a distribution group

Add users to a distribution group. You can use user IDs or email addresses.

Parameters

Name	Type	Required	Description
`group_id`	string	required	ID of the group
`members`	array	required	User IDs or email addresses to add

Request

curl -X POST https://api.syncello.io/v1/tools/sharefile/addGroupMembers \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"
  -d '{
  "group_id": "example",
  "members": "..."
}'

Response

{
  "message": "Added 1 member(s) to group",
  "members_added": [
    "b2c3d4e5-f6a7-8901-bcde-f12345678901"
  ]
}

Try It

Try it

Remove Group Member

Destructive

POST /v1/tools/sharefile/removeGroupMember

Remove a member from a distribution group

Remove a user from a distribution group. This does not delete the user, only removes them from the group.

Parameters

Name	Type	Required	Description
`group_id`	string	required	ID of the group
`user_id`	string	required	ID of the user to remove

Request

curl -X POST https://api.syncello.io/v1/tools/sharefile/removeGroupMember \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"
  -d '{
  "group_id": "example",
  "user_id": "example"
}'

Response

{
  "message": "Removed user b2c3d4e5-f6a7-8901-bcde-f12345678901 from group g1a2b3c4-d5e6-7f80-9a1b-2c3d4e5f6a7b"
}