How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Square BookingCustomAttributes API

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

Square BookingCustomAttributes API is one of 45 APIs that Square publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include BookingCustomAttributes. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and an AsyncAPI specification.

This API exposes 11 operations across 6 paths, and defines 26 schemas. It is described by OpenAPI 3.2.0, at version 2.0.

Requests are made against a single base URL, https://connect.squareup.com.

11 operations 6 paths 26 schemas 2 DELETE4 GET3 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.0
Server
https://connect.squareup.com
Authentication
OAuth 2.0, API Key
License
Terms of Service
Resource Areas
1

Authentication & Security 2

Square BookingCustomAttributes API declares 2 security schemes for authenticating requests. It supports OAuth 2.0 (oauth2) using the authorizationCode flow, exposing 57 scopes. An API key is passed in the header as Authorization (oauth2ClientSecret).

Paths & Operations 11

Across 6 paths, the API surfaces 11 operations — 2 DELETE, 4 GET, 3 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

BookingCustomAttributes 11
GET
/v2/bookings/custom-attribute-definitions
Square List Booking Custom Attribute Definitions
ListBookingCustomAttributeDefinitions 2 params → 200
POST
/v2/bookings/custom-attribute-definitions
Square Create Booking Custom Attribute Definition
CreateBookingCustomAttributeDefinition body → 200
DELETE
/v2/bookings/custom-attribute-definitions/{key}
Square Delete Booking Custom Attribute Definition
DeleteBookingCustomAttributeDefinition 1 param → 200
GET
/v2/bookings/custom-attribute-definitions/{key}
Square Retrieve Booking Custom Attribute Definition
RetrieveBookingCustomAttributeDefinition 2 params → 200
PUT
/v2/bookings/custom-attribute-definitions/{key}
Square Update Booking Custom Attribute Definition
UpdateBookingCustomAttributeDefinition 1 param body → 200
POST
/v2/bookings/custom-attributes/bulk-delete
Square Bulk Delete Booking Custom Attributes
BulkDeleteBookingCustomAttributes body → 200
POST
/v2/bookings/custom-attributes/bulk-upsert
Square Bulk Upsert Booking Custom Attributes
BulkUpsertBookingCustomAttributes body → 200
GET
/v2/bookings/{booking_id}/custom-attributes
Square List Booking Custom Attributes
ListBookingCustomAttributes 4 params → 200
DELETE
/v2/bookings/{booking_id}/custom-attributes/{key}
Square Delete Booking Custom Attribute
DeleteBookingCustomAttribute 2 params → 200
GET
/v2/bookings/{booking_id}/custom-attributes/{key}
Square Retrieve Booking Custom Attribute
RetrieveBookingCustomAttribute 4 params → 200
PUT
/v2/bookings/{booking_id}/custom-attributes/{key}
Square Upsert Booking Custom Attribute
UpsertBookingCustomAttribute 2 params body → 200

Schemas 26

The contract defines 26 schemas that model the data the API accepts and returns. The most detailed are CustomAttributeDefinition (8 properties), CustomAttribute (7 properties), Error (4 properties), ListBookingCustomAttributeDefinitionsResponse (3 properties). Each schema is shown below with its type and property counts.

BulkDeleteBookingCustomAttributesResponse
object
Represents a [BulkDeleteBookingCustomAttributes](api-endpoint:BookingCustomAttributes-BulkDeleteBookingCustomAttributes) response, which contains a map of resp…
2 properties
ListBookingCustomAttributesResponse
object
Represents a [ListBookingCustomAttributes](api-endpoint:BookingCustomAttributes-ListBookingCustomAttributes) response. Either customattributes, an empty object…
3 properties
CustomAttributeDefinition
object
Represents a definition for custom attribute values. A custom attribute definition specifies the key, visibility, schema, and other properties for a custom att…
8 properties
UpsertBookingCustomAttributeResponse
object
Represents an [UpsertBookingCustomAttribute](api-endpoint:BookingCustomAttributes-UpsertBookingCustomAttribute) response. Either customattributedefinition or e…
2 properties
RetrieveBookingCustomAttributeResponse
object
Represents a [RetrieveBookingCustomAttribute](api-endpoint:BookingCustomAttributes-RetrieveBookingCustomAttribute) response. Either customattributedefinition o…
2 properties
BookingCustomAttributeUpsertRequest
object
Represents an individual upsert request in a [BulkUpsertBookingCustomAttributes](api-endpoint:BookingCustomAttributes-BulkUpsertBookingCustomAttributes) reques…
3 properties 2 required
CustomAttribute
object
A custom attribute value. Each custom attribute value has a corresponding CustomAttributeDefinition object.
7 properties
BulkUpsertBookingCustomAttributesRequest
object
Represents a [BulkUpsertBookingCustomAttributes](api-endpoint:BookingCustomAttributes-BulkUpsertBookingCustomAttributes) request.
1 property 1 required
UpsertBookingCustomAttributeRequest
object
Represents an [UpsertBookingCustomAttribute](api-endpoint:BookingCustomAttributes-UpsertBookingCustomAttribute) request.
2 properties 1 required
CustomAttributeDefinitionVisibility
string
The level of permission that a seller or other applications requires to view this custom attribute definition. The Visibility field controls who can read and w…
BulkUpsertBookingCustomAttributesResponse
object
Represents a [BulkUpsertBookingCustomAttributes](api-endpoint:BookingCustomAttributes-BulkUpsertBookingCustomAttributes) response, which contains a map of resp…
2 properties
RetrieveBookingCustomAttributeDefinitionResponse
object
Represents a [RetrieveBookingCustomAttributeDefinition](api-endpoint:BookingCustomAttributes-RetrieveBookingCustomAttributeDefinition) response. Either customa…
2 properties
DeleteBookingCustomAttributeDefinitionResponse
object
Represents a [DeleteBookingCustomAttributeDefinition](api-endpoint:BookingCustomAttributes-DeleteBookingCustomAttributeDefinition) response containing error me…
1 property
UpdateBookingCustomAttributeDefinitionResponse
object
Represents an [UpdateBookingCustomAttributeDefinition](api-endpoint:BookingCustomAttributes-UpdateBookingCustomAttributeDefinition) response. Either customattr…
2 properties
BookingCustomAttributeDeleteResponse
object
Represents a response for an individual upsert request in a [BulkDeleteBookingCustomAttributes](api-endpoint:BookingCustomAttributes-BulkDeleteBookingCustomAtt…
2 properties
CreateBookingCustomAttributeDefinitionResponse
object
Represents a [CreateBookingCustomAttributeDefinition](api-endpoint:BookingCustomAttributes-CreateBookingCustomAttributeDefinition) response. Either customattri…
2 properties
BookingCustomAttributeDeleteRequest
object
Represents an individual delete request in a [BulkDeleteBookingCustomAttributes](api-endpoint:BookingCustomAttributes-BulkDeleteBookingCustomAttributes) reques…
2 properties 2 required
ListBookingCustomAttributeDefinitionsResponse
object
Represents a [ListBookingCustomAttributeDefinitions](api-endpoint:BookingCustomAttributes-ListBookingCustomAttributeDefinitions) response. Either customattribu…
3 properties
BulkDeleteBookingCustomAttributesRequest
object
Represents a [BulkDeleteBookingCustomAttributes](api-endpoint:BookingCustomAttributes-BulkDeleteBookingCustomAttributes) request.
1 property 1 required
BookingCustomAttributeUpsertResponse
object
Represents a response for an individual upsert request in a [BulkUpsertBookingCustomAttributes](api-endpoint:BookingCustomAttributes-BulkUpsertBookingCustomAtt…
3 properties
UpdateBookingCustomAttributeDefinitionRequest
object
Represents an [UpdateBookingCustomAttributeDefinition](api-endpoint:BookingCustomAttributes-UpdateBookingCustomAttributeDefinition) request.
2 properties 1 required
Error
object
Represents an error encountered during a request to the Connect API. See [Handling errors](https://developer.squareup.com/docs/build-basics/handling-errors) fo…
4 properties 2 required
ErrorCode
string
Indicates the specific error that occurred during a request to a Square API.
CreateBookingCustomAttributeDefinitionRequest
object
Represents a [CreateBookingCustomAttributeDefinition](api-endpoint:BookingCustomAttributes-CreateBookingCustomAttributeDefinition) request.
2 properties 1 required
DeleteBookingCustomAttributeResponse
object
Represents a [DeleteBookingCustomAttribute](api-endpoint:BookingCustomAttributes-DeleteBookingCustomAttribute) response. Either an empty object {} (for a succe…
1 property
ErrorCategory
string
Indicates which high-level category of error has occurred during a request to the Connect API.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

square-bookingcustomattributes-api-openapi.yml Raw ↑

Other APIs Square publishes across the network.

Square Reporting API
Square Channels API
Square Transfer Orders API
Square ApplePay API
Square BankAccounts API
Square Bookings API
Square Cards API
Square CashDrawers API
Square Catalog API
Square Checkout API
Square CustomerCustomAttributes API
Square CustomerGroups API
Where this information came from

This is an independent, third-party profile of Square BookingCustomAttributes API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.