GetBreakType

{
  "type": "object",
  "description": "The response to a request to get a `BreakType`. The response contains\nthe requested `BreakType` objects and might contain a set of `Error` objects if\nthe request resulted in errors.",
  "properties": {
    "break_type": {
      "type": "object",
      "description": "A defined break template that sets an expectation for possible `Break`\ninstances on a `Shift`.",
      "required": [
        "break_name",
        "expected_duration",
        "is_paid",
        "location_id"
      ],
      "properties": {
        "break_name": {
          "type": "string",
          "description": "A human-readable name for this type of break. The name is displayed to\nemployees in Square products."
        },
        "created_at": {
          "type": "string",
          "description": "A read-only timestamp in RFC 3339 format."
        },
        "expected_duration": {
          "type": "string",
          "description": "Format: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]S. The expected length of\nthis break. Precision less than minutes is truncated."
        },
        "id": {
          "type": "string",
          "description": "The UUID for this object."
        },
        "is_paid": {
          "type": "boolean",
          "description": "Whether this break counts towards time worked for compensation\npurposes."
        },
        "location_id": {
          "type": "string",
          "description": "The ID of the business location this type of break applies to."
        },
        "updated_at": {
          "type": "string",
          "description": "A read-only timestamp in RFC 3339 format."
        },
        "version": {
          "type": "integer",
          "description": "Used for resolving concurrency issues. The request fails if the version\nprovided does not match the server version at the time of the request. If a value is not\nprovided, Square's servers execute a \"blind\" write; potentially\noverwriting another writer's data."
        }
      }
    },
    "errors": {
      "type": "array",
      "description": "Any errors that occurred during the request.",
      "items": {
        "type": "object",
        "description": "Represents an error encountered during a request to the Connect API.\n\nSee [Handling errors](https://developer.squareup.com/docs/build-basics/handling-errors) for more information.",
        "required": [
          "category",
          "code"
        ],
        "properties": {
          "category": {
            "type": "string",
            "description": "The high-level category for the error."
          },
          "code": {
            "type": "string",
            "description": "The specific code of the error."
          },
          "detail": {
            "type": "string",
            "description": "A human-readable description of the error for debugging purposes."
          },
          "field": {
            "type": "string",
            "description": "The name of the field provided in the original request (if any) that\nthe error pertains to."
          }
        }
      }
    }
  }
}