Get list of user groups

GET /api-v1/user-group

Headers

TARGET-ORGANIZATION-ID integer(int32)

ID of organization, for which the operation must be performed
WEAL-TOKEN string Required

API token (can be retrieved from account settings)

Query parameters

direction string

Sorting direction

Values are ASC or DESC. Default value is ASC.
pageNumber integer(int32)

Page Number

Default value is 1.
sizePerPage integer(int32)

Size per page

Default value is 60.
sortingField string

Field to sort by

Responses

200

OK
Hide response attributes Show response attributes object
- creatorContactId integer
- description string
- id integer
- name string
- organizationId integer
- type string
  
  Values are GROUP or SUPER_GROUP.
400

400 Bad Request
401

401 Unauthorized
403

403 Access Denied
404

404 Not Found
500

500 Internal Server Error

GET /api-v1/user-group

curl \
 -X GET http://10.10.10.132/api-v1/user-group \
 -H "TARGET-ORGANIZATION-ID: 42" \
 -H "WEAL-TOKEN: string"

Response examples (200)

[
  {
    "creatorContactId": 42,
    "description": "string",
    "id": 42,
    "name": "string",
    "organizationId": 42,
    "type": "GROUP"
  }
]