List groups

v1.0.0

Returns a list of all groups. This list is paged.

Input

{
  "type": "object",
  "properties": {
    "limit": {
      "type": "integer"
    },
    "offset": {
      "type": "integer"
    },
    "order": {
      "type": "string",
      "enum": [
        "asc",
        "desc"
      ]
    },
    "orderby": {
      "type": "string",
      "enum": [
        "name",
        "createdOn"
      ]
    }
  },
  "additionalProperties": false
}

Output

{
  "type": "object",
  "description": "Describes the response received when searching for groups.",
  "required": [
    "count",
    "groups"
  ],
  "properties": {
    "count": {
      "type": "integer",
      "description": "The total number of groups that matched the query that produced the result set (may be \nmore than the number of groups in the result set)."
    },
    "groups": {
      "type": "array",
      "description": "The groups returned in the result set.",
      "items": {
        "type": "object",
        "description": "Models a single group from the result set returned when searching for groups.",
        "required": [
          "description",
          "createdBy",
          "createdOn",
          "id",
          "modifiedBy",
          "modifiedOn"
        ],
        "properties": {
          "createdBy": {
            "type": "string"
          },
          "createdOn": {
            "type": "string",
            "format": "date-time"
          },
          "description": {
            "type": "string"
          },
          "id": {
            "type": "string"
          },
          "modifiedBy": {
            "type": "string"
          },
          "modifiedOn": {
            "type": "string",
            "format": "date-time"
          }
        }
      }
    }
  }
}