Webex · Schema

SearchResponse

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name Type Description
result array An array of contact objects.
start number Start at the zero-based offset in the list of matching contacts.
limit number Limit the number of contacts returned to this maximum count.
total number Total number of contacts returned in search results.
View JSON Schema on GitHub

JSON Schema

webex-searchresponse-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/SearchResponse",
  "title": "SearchResponse",
  "type": "object",
  "properties": {
    "result": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ContactResponse"
      },
      "description": "An array of contact objects."
    },
    "start": {
      "type": "number",
      "description": "Start at the zero-based offset in the list of matching contacts."
    },
    "limit": {
      "type": "number",
      "example": 1000,
      "description": "Limit the number of contacts returned to this maximum count."
    },
    "total": {
      "type": "number",
      "example": 1,
      "description": "Total number of contacts returned in search results."
    }
  }
}