List Groups

GET 
/org/:orgId/groups

Gets all Groups in the Organization identified by orgID UUID.

Request

Path Parameters

orgId stringrequired

The Organization ID (UUID) for which you are querying.

Responses

200

Success.

application/json

Schema

Schema

any

Example (from schema)

{
  "status": {
    "i18n_message": "response.ok",
    "message": "OK"
  },
  "response": [
    {
      "ID": "306a42c9-a7f3-48c3-743c-10015e29a672",
      "OrgID": "default",
      "Name": "My Group",
      "NumberOfUsers": 0
    },
    {
      "ID": "106b52fb-43e3-4ffb-491a-bb6497300c54",
      "OrgID": "default",
      "Name": "My Other Group",
      "NumberOfUsers": 0
    }
  ]
}

Example

{
  "status": {
    "i18n_message": "response.ok",
    "message": "OK"
  },
  "response": [
    {
      "ID": "306a42c9-a7f3-48c3-743c-10015e29a672",
      "OrgID": "default",
      "Name": "My Group",
      "NumberOfUsers": 0
    },
    {
      "ID": "106b52fb-43e3-4ffb-491a-bb6497300c54",
      "OrgID": "default",
      "Name": "My Other Group",
      "NumberOfUsers": 0
    }
  ]
}

401

This error will occur if calling user does not have access right for the API.

404

This error will occur if the org identified by orgId does not exist.

500

A server error occurred. Check the logs for more details.

Loading...