Return a list of all user groups

Description

Returns a list of all user groups in a company.

GET /v1/security/user_groups

Parameters

Parameter	In	Type	Required	Description
pageSize	query	integer	false	Limit number of results returned (Max 100).
page	query	integer	false	Page number to retrieve in the paginated results (0-based index).

Code Samples

curl

curl -X GET https://h.app.wdesk.com/s/wdata/oc/api/v1/security/user_groups \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer {access-token}'

httpie

http GET https://h.app.wdesk.com/s/wdata/oc/api/v1/security/user_groups \
    Accept:application/json \
    Authorization:"Bearer {access-token}"

wget

wget --method=GET "https://h.app.wdesk.com/s/wdata/oc/api/v1/security/user_groups" \
    --output-document -  \ 
    --header 'Accept: application/json' \ 
    --header 'Authorization: Bearer {access-token}'

python

import requests

headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://h.app.wdesk.com/s/wdata/oc/api/v1/security/user_groups', headers = headers)

print(r.json())

Returns

200 - OK

Returns a UserGroupsResponse containing an array of UserGroup objects for a company.

Example Responses

OK

{
  "data": [
    {
      "id": "1",
      "name": "Admins",
      "default": true,
      "created_at": "2018-03-14 20:10:39.520585"
    }
  ]
}