Groups API

List


Resource: /api/v2/groups


HTTPS Request Method: GET

Description: Get the list of all groups associated with the account. It includes only group ids and names.

Group list results are limited to 50 records and can be paginated.


Required Parameters:

  • api_key


Optional Parameters:

  • * page - (integer). The page you want to request. Every page is 50 records long at most. If not present, page 1 is assumed.
  • group[id] - (integer)
  • group[user_id] - (integer)
  • group[name] - (string)
  • group[is_auto] - (boolean)
  • group[updated_on] - (datetime)

Dates and datetimes should be in YYYY-MM-DD or YYYY-MM-DD HH:MM:SS format and can be given as ranges if separated by a comma.


Example Request:

curl -X GET -d '{"api_key": "123456", "group": {"updated_on": "2015-02-01"}}' -H "Content-type: application/json" -H "Accept: application/json" https://YOURSUBDOMAIN.exceedlms.com/api/v2/groups


Example Response:

[
{
"id": 24,
"name": "Remote Users"
}
]

 

Read


Resource: /api/v2/groups/{id}


HTTPS Request Method: GET

Description: Lookup a group based on the id.

Example Request:

curl -i -X GET -H "Content-type: application/json" -H "Accept: application/json

 

 

Have more questions? Submit a request

0 Comments

Article is closed for comments.