API Documentation
User groups GET

get

User groups GET

Retrieve the groups for which the specified user is a member.
Required Scope: Groups, Read

 

URL Parameters

  • Param Name
    Type
    Description
  • USER_GUID
    string
    Target user's internal Guid. If not defined, the API will use the current user (the application's credentials)

Resource URL

https://api.syncplicity.com/ provisioning/user_groups.svc/user/{USER_GUID}/groups

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) - Wrong UUID Format: User Guid is invalid

  • 403
    403

    (Forbidden) - Not A Business Admin: The current user is not a company administrator for the specified group
    (Forbidden) - Not This Company User: The user attempting to execute this request is not a member of the company

  • 404
    404

    (Not Found) - User Not Found: User with specified Guid does not exist

Working...