Atlassian · Schema

FoundGroups

The list of groups found in a search, including header text (Showing X of Y matching groups) and total of matched groups.

CodeCollaborationPlatformProductivitySoftware Development

Properties

Name Type Description
groups array
header string Header text indicating the number of groups in the response and the total number of groups found in the search.
total integer The total number of groups found in the search.
View JSON Schema on GitHub

JSON Schema

atlassian-foundgroups-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/FoundGroups",
  "title": "FoundGroups",
  "additionalProperties": false,
  "description": "The list of groups found in a search, including header text (Showing X of Y matching groups) and total of matched groups.",
  "properties": {
    "groups": {
      "items": {
        "$ref": "#/components/schemas/FoundGroup"
      },
      "type": "array"
    },
    "header": {
      "description": "Header text indicating the number of groups in the response and the total number of groups found in the search.",
      "type": "string"
    },
    "total": {
      "description": "The total number of groups found in the search.",
      "format": "int32",
      "type": "integer"
    }
  },
  "type": "object",
  "xml": {
    "name": "groupsuggestions"
  }
}