{ "name": "GetBookingCustomAttributes", "fully_qualified_name": "SquareupApi.GetBookingCustomAttributes@0.1.0", "description": "Retrieve all custom attribute definitions for bookings.\n\nUse this tool to get all custom attribute definitions associated with bookings. It requires appropriate OAuth scopes for buyer or seller level permissions.", "toolkit": { "name": "ArcadeSquareupApi", "description": null, "version": "0.1.0" }, "input": { "parameters": [ { "name": "maximum_results_per_page", "required": false, "description": "Advisory maximum results per page. Minimum is 1, maximum is 100, default is 20.", "value_schema": { "val_type": "integer", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "The maximum number of results to return in a single paged response. This limit is advisory.\nThe response might contain more or fewer results. The minimum value is 1 and the maximum value is 100.\nThe default value is 20. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)." }, "inferrable": true, "http_endpoint_parameter_name": "limit" }, { "name": "pagination_cursor", "required": false, "description": "Cursor for retrieving the next page of results from a previous response.", "value_schema": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "The cursor returned in the paged response from the previous call to this endpoint.\nProvide this cursor to retrieve the next page of results for your original request.\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)." }, "inferrable": true, "http_endpoint_parameter_name": "cursor" } ] }, "output": { "description": "Response from the API endpoint 'ListBookingCustomAttributeDefinitions'.", "available_modes": [ "value", "error", "null" ], "value_schema": { "val_type": "json", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": null } }, "requirements": { "authorization": { "provider_id": "arcade-squareup", "provider_type": "oauth2", "id": null, "oauth2": { "scopes": [ "APPOINTMENTS_READ" ] } }, "secrets": null, "metadata": null }, "deprecation_message": null, "metadata": { "object_type": "api_wrapper_tool", "version": "1.0.0", "description": "Tools that enable LLMs to interact directly with the squareup API." }, "http_endpoint": { "metadata": { "object_type": "http_endpoint", "version": "1.0.0", "description": "" }, "url": "https://connect.squareup.com/v2/bookings/custom-attribute-definitions", "http_method": "GET", "headers": {}, "parameters": [ { "name": "limit", "tool_parameter_name": "maximum_results_per_page", "description": "The maximum number of results to return in a single paged response. This limit is advisory.\nThe response might contain more or fewer results. The minimum value is 1 and the maximum value is 100.\nThe default value is 20. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).", "value_schema": { "val_type": "integer", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "The maximum number of results to return in a single paged response. This limit is advisory.\nThe response might contain more or fewer results. The minimum value is 1 and the maximum value is 100.\nThe default value is 20. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)." }, "accepted_as": "query", "required": false, "deprecated": false, "documentation_urls": [] }, { "name": "cursor", "tool_parameter_name": "pagination_cursor", "description": "The cursor returned in the paged response from the previous call to this endpoint.\nProvide this cursor to retrieve the next page of results for your original request.\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).", "value_schema": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "The cursor returned in the paged response from the previous call to this endpoint.\nProvide this cursor to retrieve the next page of results for your original request.\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)." }, "accepted_as": "query", "required": false, "deprecated": false, "documentation_urls": [] } ], "documentation_urls": [], "secrets": [ { "arcade_key": "auth_token", "parameter_name": "Authorization", "accepted_as": "header", "formatted_value": "Bearer {authorization}", "description": "The OAuth token to use for authentication.", "is_auth_token": true } ] } }