API Documentation
Syncpoints GET

get

Syncpoints GET

Retrieves the syncpoint definitions (top-level folders) for a specific user or for the current user.
Required Scope: Files/Folder Metadata, Read

Resource URL

https://api.syncplicity.com/ syncpoint/syncpoints.svc/

Query Parameters


Name Values Description
user

If specified, retrieves the syncpoint definitions of the specified user; otherwise, the current user of the application is used.

include

If specified, make service return additional information about specified objects. One or several values, separated by comma.
Possible values:
'participants' – include Participants list (shared users, invited users and shared groups);
'inviter' – include user who invited current user to this syncpoint;
'remoteWipe' – include remote wiped syncpoints;
'children' – include child syncpoints;
'lastnewsfeedevent' – fill LastEvent property with the last news feed;
'deleted' - include deleted syncpoints
If equals participants,
Required Scope: Folder Participation, Read

owner

If specified, response will include only syncpoints of specified owner. Value can be or Email or ID of the user

includeType

If types are not passed, all types except SyncplicityDrive will be returned.
MyDocuments = 1,
MyMusic = 2,
MyPictures = 3,
Desktop = 4,
Favorites = 5,
Custom = 6,
Private = 7,
SyncplicityDrive = 8


Header Parameters


Name Values Description
Accept
(required)

application/json

AppKey
(required)

Consumer Key of the app from Developer Portal

As-User

A Global Administrator, or eDiscovery Administrator who has been assigned the corresponding privilege, can enter another user’s GUID so that all Content API actions are performed on behalf of that user. If this header is not used or the Administrator has not been assigned the corresponding privilege, the API works on behalf of the currently authenticated Global or eDiscovery Administrator.

Request Body

HTTP Basic

OAuth 2.0

API Key

Reset

Make a request and see the response.

Make a request and see the response.

Make a request and see the response.

Response Payload Example


		

Response Payload Schema

Response Error Details

  • HTTP Code
    Error Code
    Description
  • 400
    400

    (Bad request) - invalid Email Format

  • 401
    401

    (Unauthorized) - Not Authorized

  • 403
    403

    (Forbidden) - Not A Business Admin (Forbidden) - User Not Authorized For Action

  • 404
    404

    (Not Found) - user Not Found The "user" query parameter is specified, but the user does not exist

Working...