API Documentation
Machines GET

get

Machines GET

Retrieve the metadata identifying a sync client related to a specified user.
Required Scope: Devices, Read

Resource URL

https://api.syncplicity.com/ provisioning/machines.svc/

Query Parameters


Name Values Description
user

Unique ID associated with the user, which is needed to get all machines. If it is not specified, the results will be returned for the current user

include

Optional string that extends the method's logic. If not specified, only active machines will be returned. If the include parameter is set to 'inactive', inactive machines will be returned as well (meaning all machines, inactive and active, will be returned)


Header Parameters


Name Values Description
AppKey
(required)

Consumer Key of the app from Developer Portal

Accept
(required)

Accept type of the request

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 user ID: The supplied user ID is invalid

  • 403
    403

    (Forbidden) - Not A Business Admin: The user attempting to execute this request is not a company administrator

  • 404
    404

    (Not Found) - User Not Found: The specified user does not exist

Working...