API Documentation
User GET

get

User GET

Retrieves basic information about a Syncplicity user account using the user's email.
Note: if the call is made on behalf of a non-administrator or on behalf of the specified user, only the email address will be echoed back if the account exists.
Required Scope: Users, Read

 

URL Parameters

  • Param Name
    Type
    Description
  • USER_EMAIL
    string
    Email address of the target user

Resource URL

https://api.syncplicity.com/ provisioning/user.svc/{USER_EMAIL}

Query Parameters


Name Values Description
include

An optional parameter that extends the logic of the API. If the value is 'active_users' or empty string then the API will return only users that are active. If the value is 'inactive_users' then the API will search only inactive users. Finally if the value is 'all_users' then the API will search through active and inactive users


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 Email Format: The format of the supplied email address is bad
    (Bad request) - Invalid Include Modifier Value

  • 403
    403

    (Forbidden) - Not A Business Admin: The user attempting to execute this request is not a company administrator, or user with this email does not exists

Working...