API Documentation
Groups GET

get

Groups GET

Retrieves all groups for a given company. Only members of the company belonging to this group are authorized to make this call.
Required Scope: Groups, Read

 

URL Parameters

  • Param Name
    Type
    Description
  • COMPANY_GUID
    string
    Unique ID associated with the company

Resource URL

https://api.syncplicity.com/ provisioning/groups.svc/{COMPANY_GUID}/groups

Query Parameters


Name Values Description
include

An optional parameter that extends the logic of the API. If the value is 'members' then the API will return members of the group in addition to the group information. If the value is then the API will return just the group metadata
If equals members,
Required Scope: Group Members, Read


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
  • 403
    403

    (Forbidden) - Not A Business Admin: The current user is not a company administrator for the specified group

  • 404
    404

    (Not Found) - Group Not Found: The specified group does not exist

Working...