getGroups

READ

Get groups.

POST /api/v1/users/getGroups

curl -X POST '<your-host>/api/v1/users/getGroups' \
  -H 'Authorization: Bearer <api-key>' \
  -H 'Content-Type: application/json' \
  -d '{
    "args": {}
  }'

Response

{
  "results": [
    {
      "companyId": "string",
      "id": "string",
      "isCustomerOrgGroup": true,
      "isCustomerTypeGroup": true,
      "isEmployeeTypeGroup": true,
      "isSupplierOrgGroup": true,
      "isSupplierTypeGroup": true,
      "name": "string",
      "parentId": "string",
      "users": "…"
    }
  ],
  "count": null
}

Parameters

ParameterType

Input schema

schema

{
  "type": "object",
  "properties": {
    "args": {
      "type": "object",
      "properties": {
        "limit": {
          "type": "integer",
          "default": 100
        },
        "offset": {
          "type": "integer",
          "default": 0
        },
        "search": {
          "type": [
            "string",
            "null"
          ]
        },
        "uid": {
          "type": [
            "string",
            "null"
          ]
        }
      }
    }
  }
}