Get groups
| API version | 3.0 |
|---|---|
| Last Update | 05/08/2018 |
| Authentication | YES |
| HTTP Method | POST |
| Content Type | application/json |
| Rate limited | YES |
| Requests per rate limit | 10/min |
| Response Format | JSON |
Use to fetch groups in an account
API URL
Request Parameters
| Key | Datatype | Parameter Type | Required | Description | Default |
|---|---|---|---|---|---|
| access_token | string | URL | Yes | access token which archived from OAuth authentication step | |
| limit | number | Body | Optional | Specify a maximum number of groups will be returned in the response. The value should be in [1,50]. If there are more groups than what the limit asks for, HTTP code will be 406. | 10 |
| page | number | Body | Optional | Specify a page number which groups will be returned in. If the requested page exceeds the number of pages of groups, error code will be 413. It means that the requested page number is too large, no groups will be returned in this case. | 1 |
| search | string | Body | Optional | The keyword to search. In which, the keyword can be a group name or an assigned policy | |
| sort | object | Body | Optional | Specify how to sort groups in result-set By default: sort groups by group_name in ascending order | |
| sort.field | string | Body | Optional | Specify which field will be sorted by Values can be: group_name, domain_name, policy_name, number_of_devices, last_update. | group_name |
| sort.order | string | Body | Optional | Specify sort order. Values can be:
| asc |
Response HTTP Code
See APIs
Response Parameters
| Key | DataType | Description |
|---|---|---|
| group_id | string | a unique group identification |
| group_name | string | group name |
| domain_name | string | domain name of a domain controller where this group is synchronized |
| auto_join | boolean | specify if a device can auto-join this group when it registers to the account |
| policy_id | string | assigned policy id |
| policy_name | string | assigned policy name |
| number_of_devices | int | number of devices assigned to this group |
| description | string | group description |
| created_date | string | A timestamp in GMT format when this group is created |
| last_modified | string | The last timestamp in GMT format when this group is updated |
Example
Example Request
Example Response
Was this page helpful?