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 LocationCustomAttributes API

The LocationCustomAttributes API from Square — 6 operation(s) for locationcustomattributes.

Square LocationCustomAttributes 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 LocationCustomAttributes. 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 27 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 27 schemas 2 DELETE4 GET4 POST1 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 LocationCustomAttributes 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, 4 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

LocationCustomAttributes 11
GET
/v2/locations/custom-attribute-definitions
Square List Location Custom Attribute Definitions
ListLocationCustomAttributeDefinitions 3 params → 200
POST
/v2/locations/custom-attribute-definitions
Square Create Location Custom Attribute Definition
CreateLocationCustomAttributeDefinition body → 200
DELETE
/v2/locations/custom-attribute-definitions/{key}
Square Delete Location Custom Attribute Definition
DeleteLocationCustomAttributeDefinition 1 param → 200
GET
/v2/locations/custom-attribute-definitions/{key}
Square Retrieve Location Custom Attribute Definition
RetrieveLocationCustomAttributeDefinition 2 params → 200
PUT
/v2/locations/custom-attribute-definitions/{key}
Square Update Location Custom Attribute Definition
UpdateLocationCustomAttributeDefinition 1 param body → 200
POST
/v2/locations/custom-attributes/bulk-delete
Square Bulk Delete Location Custom Attributes
BulkDeleteLocationCustomAttributes body → 200
POST
/v2/locations/custom-attributes/bulk-upsert
Square Bulk Upsert Location Custom Attributes
BulkUpsertLocationCustomAttributes body → 200
GET
/v2/locations/{location_id}/custom-attributes
Square List Location Custom Attributes
ListLocationCustomAttributes 5 params → 200
DELETE
/v2/locations/{location_id}/custom-attributes/{key}
Square Delete Location Custom Attribute
DeleteLocationCustomAttribute 2 params → 200
GET
/v2/locations/{location_id}/custom-attributes/{key}
Square Retrieve Location Custom Attribute
RetrieveLocationCustomAttribute 4 params → 200
POST
/v2/locations/{location_id}/custom-attributes/{key}
Square Upsert Location Custom Attribute
UpsertLocationCustomAttribute 2 params body → 200

Schemas 27

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

BulkDeleteLocationCustomAttributesRequest
object
Represents a [BulkDeleteLocationCustomAttributes](api-endpoint:LocationCustomAttributes-BulkDeleteLocationCustomAttributes) request.
1 property 1 required
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
CreateLocationCustomAttributeDefinitionRequest
object
Represents a [CreateLocationCustomAttributeDefinition](api-endpoint:LocationCustomAttributes-CreateLocationCustomAttributeDefinition) request.
2 properties 1 required
RetrieveLocationCustomAttributeDefinitionResponse
object
Represents a [RetrieveLocationCustomAttributeDefinition](api-endpoint:LocationCustomAttributes-RetrieveLocationCustomAttributeDefinition) response. Either cust…
2 properties
UpdateLocationCustomAttributeDefinitionResponse
object
Represents an [UpdateLocationCustomAttributeDefinition](api-endpoint:LocationCustomAttributes-UpdateLocationCustomAttributeDefinition) response. Either customa…
2 properties
BulkDeleteLocationCustomAttributesResponse
object
Represents a [BulkDeleteLocationCustomAttributes](api-endpoint:LocationCustomAttributes-BulkDeleteLocationCustomAttributes) response, which contains a map of r…
2 properties 1 required
CustomAttribute
object
A custom attribute value. Each custom attribute value has a corresponding CustomAttributeDefinition object.
7 properties
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…
ListLocationCustomAttributesResponse
object
Represents a [ListLocationCustomAttributes](api-endpoint:LocationCustomAttributes-ListLocationCustomAttributes) response. Either customattributes, an empty obj…
3 properties
BulkUpsertLocationCustomAttributesRequest
object
Represents a [BulkUpsertLocationCustomAttributes](api-endpoint:LocationCustomAttributes-BulkUpsertLocationCustomAttributes) request.
1 property 1 required
DeleteLocationCustomAttributeResponse
object
Represents a [DeleteLocationCustomAttribute](api-endpoint:LocationCustomAttributes-DeleteLocationCustomAttribute) response. Either an empty object {} (for a su…
1 property
RetrieveLocationCustomAttributeResponse
object
Represents a [RetrieveLocationCustomAttribute](api-endpoint:LocationCustomAttributes-RetrieveLocationCustomAttribute) response. Either customattributedefinitio…
2 properties
UpdateLocationCustomAttributeDefinitionRequest
object
Represents an [UpdateLocationCustomAttributeDefinition](api-endpoint:LocationCustomAttributes-UpdateLocationCustomAttributeDefinition) request.
2 properties 1 required
BulkUpsertLocationCustomAttributesRequestLocationCustomAttributeUpsertRequest
object
Represents an individual upsert request in a [BulkUpsertLocationCustomAttributes](api-endpoint:LocationCustomAttributes-BulkUpsertLocationCustomAttributes) req…
3 properties 2 required
VisibilityFilter
string
Enumeration of visibility-filter values used to set the ability to view custom attributes or custom attribute definitions.
ListLocationCustomAttributeDefinitionsResponse
object
Represents a [ListLocationCustomAttributeDefinitions](api-endpoint:LocationCustomAttributes-ListLocationCustomAttributeDefinitions) response. Either customattr…
3 properties
UpsertLocationCustomAttributeRequest
object
Represents an [UpsertLocationCustomAttribute](api-endpoint:LocationCustomAttributes-UpsertLocationCustomAttribute) 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.
BulkUpsertLocationCustomAttributesResponseLocationCustomAttributeUpsertResponse
object
Represents a response for an individual upsert request in a [BulkUpsertLocationCustomAttributes](api-endpoint:LocationCustomAttributes-BulkUpsertLocationCustom…
3 properties
BulkDeleteLocationCustomAttributesRequestLocationCustomAttributeDeleteRequest
object
Represents an individual delete request in a [BulkDeleteLocationCustomAttributes](api-endpoint:LocationCustomAttributes-BulkDeleteLocationCustomAttributes) req…
1 property
BulkDeleteLocationCustomAttributesResponseLocationCustomAttributeDeleteResponse
object
Represents an individual delete response in a [BulkDeleteLocationCustomAttributes](api-endpoint:LocationCustomAttributes-BulkDeleteLocationCustomAttributes) re…
2 properties
UpsertLocationCustomAttributeResponse
object
Represents an [UpsertLocationCustomAttribute](api-endpoint:LocationCustomAttributes-UpsertLocationCustomAttribute) response. Either customattributedefinition o…
2 properties
DeleteLocationCustomAttributeDefinitionResponse
object
Represents a response from a delete request containing error messages if there are any.
1 property
BulkUpsertLocationCustomAttributesResponse
object
Represents a [BulkUpsertLocationCustomAttributes](api-endpoint:LocationCustomAttributes-BulkUpsertLocationCustomAttributes) response, which contains a map of r…
2 properties
ErrorCategory
string
Indicates which high-level category of error has occurred during a request to the Connect API.
CreateLocationCustomAttributeDefinitionResponse
object
Represents a [CreateLocationCustomAttributeDefinition](api-endpoint:LocationCustomAttributes-CreateLocationCustomAttributeDefinition) response. Either customat…
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

square-locationcustomattributes-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 BookingCustomAttributes API
Square Bookings API
Square Cards API
Square CashDrawers API
Square Catalog API
Square Checkout API
Square CustomerCustomAttributes API
Where this information came from

This is an independent, third-party profile of Square LocationCustomAttributes 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.