Webex · Schema

UserDetailsResponseEnvelopeDTO

The response envelope for user details operations.

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name Type Description
meta object Metadata of response with paging information. Includes orgId, page, pageSize, totalPages, totalRecords, and pagination links.
data array The response data payload containing user details.
View JSON Schema on GitHub

JSON Schema

webex-userdetailsresponseenvelopedto-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/UserDetailsResponseEnvelopeDTO",
  "title": "UserDetailsResponseEnvelopeDTO",
  "type": "object",
  "description": "The response envelope for user details operations.",
  "properties": {
    "meta": {
      "type": "object",
      "additionalProperties": {},
      "description": "Metadata of response with paging information. Includes orgId, page, pageSize, totalPages, totalRecords, and pagination links.",
      "example": {
        "orgid": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1",
        "page": 1,
        "pageSize": 100,
        "totalPages": 3,
        "totalRecords": 300,
        "links": {
          "next": "/organization/bde75a64-f4d5-4ffc-a239-feb607c17ef8/user/fetch-user-details-by-ids?page=2&pageSize=100",
          "last": "/organization/bde75a64-f4d5-4ffc-a239-feb607c17ef8/user/fetch-user-details-by-ids?page=2&pageSize=100",
          "prev": "/organization/bde75a64-f4d5-4ffc-a239-feb607c17ef8/user/fetch-user-details-by-ids?page=0&pageSize=100",
          "self": "/organization/bde75a64-f4d5-4ffc-a239-feb607c17ef8/user/fetch-user-details-by-ids?page=1&pageSize=100",
          "first": "/organization/bde75a64-f4d5-4ffc-a239-feb607c17ef8/user/fetch-user-details-by-ids?page=0&pageSize=100"
        }
      }
    },
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/UserDetailsResponseDTO"
      },
      "description": "The response data payload containing user details."
    }
  }
}