Atlassian · Schema

UserList

A paginated list of users sharing the filter. This includes users that are members of the groups or can browse the projects that the filter is shared with.

CodeCollaborationPlatformProductivitySoftware Development

Properties

Name Type Description
end-index integer The index of the last item returned on the page.
items array The list of items.
max-results integer The maximum number of results that could be on the page.
size integer The number of items on the page.
start-index integer The index of the first item returned on the page.
View JSON Schema on GitHub

JSON Schema

atlassian-userlist-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/UserList",
  "title": "UserList",
  "additionalProperties": false,
  "description": "A paginated list of users sharing the filter. This includes users that are members of the groups or can browse the projects that the filter is shared with.",
  "properties": {
    "end-index": {
      "description": "The index of the last item returned on the page.",
      "format": "int32",
      "readOnly": true,
      "type": "integer",
      "xml": {
        "attribute": true,
        "name": "end-index"
      }
    },
    "items": {
      "description": "The list of items.",
      "items": {
        "$ref": "#/components/schemas/User"
      },
      "readOnly": true,
      "type": "array"
    },
    "max-results": {
      "description": "The maximum number of results that could be on the page.",
      "format": "int32",
      "readOnly": true,
      "type": "integer",
      "xml": {
        "attribute": true,
        "name": "max-results"
      }
    },
    "size": {
      "description": "The number of items on the page.",
      "format": "int32",
      "readOnly": true,
      "type": "integer",
      "xml": {
        "attribute": true
      }
    },
    "start-index": {
      "description": "The index of the first item returned on the page.",
      "format": "int32",
      "readOnly": true,
      "type": "integer",
      "xml": {
        "attribute": true,
        "name": "start-index"
      }
    }
  },
  "type": "object"
}