Mindbody · Schema

GetClientsResponse

Implementation of the 'GetClientsResponse' model.

FitnessWellnessBeautySchedulingBookingPoint of SaleStudiosSalonsSpasWebhooks

Properties

Name Type Description
PaginationResponse object Contains information about the pagination properties to use.
Clients array The requested clients.
View JSON Schema on GitHub

JSON Schema

public-api-v6-get-clients-response-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/mindbody/refs/heads/main/json-schema/public-api-v6-get-clients-response-schema.json",
  "title": "GetClientsResponse",
  "description": "Implementation of the 'GetClientsResponse' model.",
  "type": "object",
  "properties": {
    "PaginationResponse": {
      "$ref": "#/components/schemas/PaginationResponse",
      "description": "Contains information about the pagination properties to use."
    },
    "Clients": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ClientWithSuspensionInfo"
      },
      "description": "The requested clients.",
      "example": [
        {}
      ]
    }
  }
}