messagebird · Schema

GroupList

Properties

Name Type Description
offset integer The offset of the result set.
limit integer The limit applied to the result set.
count integer The number of items returned.
totalCount integer The total number of groups.
items array
View JSON Schema on GitHub

JSON Schema

messagebird-grouplist-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/GroupList",
  "title": "GroupList",
  "type": "object",
  "properties": {
    "offset": {
      "type": "integer",
      "description": "The offset of the result set."
    },
    "limit": {
      "type": "integer",
      "description": "The limit applied to the result set."
    },
    "count": {
      "type": "integer",
      "description": "The number of items returned."
    },
    "totalCount": {
      "type": "integer",
      "description": "The total number of groups."
    },
    "items": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Group"
      }
    }
  }
}