GetByLocationIdResponseDTO

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/highlevel/main/json-schema/highlevel-get-by-location-id-response-dto-schema.json",
  "title": "GetByLocationIdResponseDTO",
  "x-generated": "2026-09-22",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/_original/highlevel-social-media-posting-openapi.json#/components/schemas/GetByLocationIdResponseDTO",
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean",
      "description": "Success or Failure"
    },
    "statusCode": {
      "type": "number",
      "description": "Status Code"
    },
    "message": {
      "type": "string",
      "description": "Message"
    },
    "results": {
      "description": "Requested Results",
      "allOf": [
        {
          "$ref": "#/$defs/GetByLocationIdResponseSchema"
        }
      ]
    }
  },
  "required": [
    "success",
    "statusCode",
    "message"
  ],
  "$defs": {
    "CategorySchema": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "description": "Category Name"
        },
        "primaryColor": {
          "type": "string",
          "description": "Color For Category"
        },
        "secondaryColor": {
          "type": "string",
          "description": "Secondary Color"
        },
        "locationId": {
          "type": "string",
          "description": "Location ID"
        },
        "_id": {
          "type": "string",
          "description": "ID"
        },
        "createdBy": {
          "type": "string",
          "description": "Created By User"
        },
        "deleted": {
          "type": "boolean",
          "description": "Deleted Value"
        },
        "createdAt": {
          "format": "date-time",
          "type": "string"
        },
        "updatedAt": {
          "format": "date-time",
          "type": "string"
        }
      },
      "required": [
        "deleted"
      ]
    },
    "GetByLocationIdResponseSchema": {
      "type": "object",
      "properties": {
        "count": {
          "type": "number",
          "description": "Count"
        },
        "categories": {
          "description": "Meta Data",
          "type": "array",
          "items": {
            "$ref": "#/$defs/CategorySchema"
          }
        }
      },
      "required": [
        "count",
        "categories"
      ]
    }
  }
}