API Documentation
Syncpoint GET

get

Syncpoint GET

Retrieves the syncpoint definition of a specific endpoint.
Required Scope: Files/Folder Metadata, Read

 

URL Parameters

  • Param Name
    Type
    Description
  • SYNCPOINT_ID
    string
    ID of the syncpoint

Resource URL

https://api.syncplicity.com/ syncpoint/syncpoint.svc/{SYNCPOINT_ID}

Query Parameters


Name Values Description
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;
'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


Header Parameters


Name Values Description
AppKey
(required)

Consumer Key of the app from Developer Portal

Accept
(required)

Accept type of the request

Content-Type

Content-Type of the request

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

    Format of the supplied email address is wrong

  • 403
    403

    (Forbidden) - Not A Business - Admin Current user is not an administrator and the "user" query parameter is specified
    (Forbidden) - User Not Authorized For Action

  • 404
    404

    (Not Found) - User Not Found

Working...