Square

Square BookingCustomAttributes API

The BookingCustomAttributes API from Square — 6 operation(s) for bookingcustomattributes.

Documentation GitHub OpenAPI

Operations 11

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /v2/bookings/custom-attribute-definitions List booking custom field definitions · Square List Booking Custom Attribute Definitions #

Ask an LLM

“What custom fields have been defined for bookings?”

“Can I page through all booking custom attribute definitions?”

Tell an agent

List all booking custom attribute definitions.

Show up to {limit} booking custom field definitions.

POST /v2/bookings/custom-attribute-definitions Define a new custom field for bookings · Square Create Booking Custom Attribute Definition #

Ask an LLM

“How do I add a custom field, like a pet's name, to appointments?”

“Can I define my own data field that applies to every booking?”

Tell an agent

Create booking custom attribute definition {custom_attribute_definition}.

Define a new custom field for appointments: {custom_attribute_definition}.

DELETE /v2/bookings/custom-attribute-definitions/{key} Delete a booking custom field definition · Square Delete Booking Custom Attribute Definition #

Ask an LLM

“How do I remove a custom field definition from bookings entirely?”

“What happens to booking values when I delete their custom attribute definition?”

Tell an agent destructive · confirm first

Delete booking custom attribute definition {key}.

Remove the booking custom field {key} from my account.

GET /v2/bookings/custom-attribute-definitions/{key} Get a booking custom field definition · Square Retrieve Booking Custom Attribute Definition #

Ask an LLM

“What is the schema of one booking custom attribute definition?”

“Can I read a specific version of a booking custom field definition?”

Tell an agent

Get the booking custom attribute definition {key}.

Show version {version} of booking custom field definition {key}.

PUT /v2/bookings/custom-attribute-definitions/{key} Update a booking custom field definition · Square Update Booking Custom Attribute Definition #

Ask an LLM

“How do I rename or change the description of a booking custom field?”

“Can I change the visibility of an existing booking custom attribute definition?”

Tell an agent

Update booking custom attribute definition {key} with {custom_attribute_definition}.

Change the definition of booking custom field {key}.

POST /v2/bookings/custom-attributes/bulk-delete Delete custom field values on many bookings · Square Bulk Delete Booking Custom Attributes #

Ask an LLM

“Can I clear a custom field value from many bookings at once?”

“Is there a bulk way to delete booking custom attributes?”

Tell an agent destructive · confirm first

Bulk delete these booking custom attributes: {values}.

Remove custom field values from multiple bookings: {values}.

POST /v2/bookings/custom-attributes/bulk-upsert Set custom field values on many bookings · Square Bulk Upsert Booking Custom Attributes #

Ask an LLM

“How do I set a custom field value on lots of appointments in one call?”

“Can I bulk create or update booking custom attributes?”

Tell an agent

Bulk upsert booking custom attributes {values}.

Set these custom field values across several bookings: {values}.

GET /v2/bookings/{booking_id}/custom-attributes List a booking's custom field values · Square List Booking Custom Attributes #

Ask an LLM

“What custom field values are stored on a specific appointment?”

“Can I get a booking's custom attributes together with their definitions?”

Tell an agent

List custom attributes on booking {booking_id}.

Show custom field values for booking {booking_id} with definitions: {with_definitions}.

DELETE /v2/bookings/{booking_id}/custom-attributes/{key} Delete a custom field value from a booking · Square Delete Booking Custom Attribute #

Ask an LLM

“How do I clear one custom field value from a single appointment?”

“Can I remove a custom attribute from one booking without touching its definition?”

Tell an agent destructive · confirm first

Delete custom attribute {key} from booking {booking_id}.

Clear the {key} field on appointment {booking_id}.

GET /v2/bookings/{booking_id}/custom-attributes/{key} Get one custom field value on a booking · Square Retrieve Booking Custom Attribute #

Ask an LLM

“How do I read a single custom field value from an appointment?”

“Can I fetch one booking custom attribute along with its definition?”

Tell an agent

Get custom attribute {key} on booking {booking_id}.

Read the {key} field value of appointment {booking_id}.

PUT /v2/bookings/{booking_id}/custom-attributes/{key} Set a custom field value on a booking · Square Upsert Booking Custom Attribute #

Ask an LLM

“How do I save a custom field value on one appointment?”

“Can I update an existing custom attribute on a single booking?”

Tell an agent

Set custom attribute {key} on booking {booking_id} to {custom_attribute}.

Upsert the {key} field on appointment {booking_id}.

Square BookingCustomAttributes API

Operations 11

Documentation

Specifications

Schemas & Data

Work with this as data

MCP server

Tools for apis

Call it yourself

Get an API key

OpenAPI Specification