Atlassian · Schema

FoundUsers

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

CodeCollaborationPlatformProductivitySoftware Development

Properties

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

JSON Schema

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