Square

Square CustomerCustomAttributes API

The CustomerCustomAttributes API from Square — 5 operation(s) for customercustomattributes.

GitHub OpenAPI
Business capability
Customer Data Management BC-420.10

Operations 10

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/customers/custom-attribute-definitions List customer custom attribute definitions · Square List Customer Custom Attribute Definitions #
Ask an LLM
“What custom fields have been defined for customer profiles?”
“Can I page through all customer attribute definitions in my account?”
Tell an agent
List customer custom attribute definitions.
Show customer attribute definitions, {limit} per page.
POST /v2/customers/custom-attribute-definitions Define a new customer custom attribute · Square Create Customer Custom Attribute Definition #
Ask an LLM
“How do I add a custom field like favorite drink to customer profiles?”
“Can I set the data type and visibility of a new customer attribute?”
Tell an agent
Create customer custom attribute definition {custom_attribute_definition}.
Define a new customer profile field using {custom_attribute_definition}.
DELETE /v2/customers/custom-attribute-definitions/{key} Delete a customer custom attribute definition · Square Delete Customer Custom Attribute Definition #
Ask an LLM
“Will deleting a customer attribute definition wipe its values from all profiles?”
“How do I retire a custom field from customer profiles?”
Tell an agent destructive · confirm first
Delete customer custom attribute definition {key}.
Remove customer attribute definition {key} and its values on every profile.
GET /v2/customers/custom-attribute-definitions/{key} Get a customer custom attribute definition · Square Retrieve Customer Custom Attribute Definition #
Ask an LLM
“What schema does a customer custom attribute definition use?”
“Can I read a specific version of a customer attribute definition?”
Tell an agent
Get customer custom attribute definition {key}.
Show customer attribute definition {key} at version {version}.
PUT /v2/customers/custom-attribute-definitions/{key} Update a customer custom attribute definition · Square Update Customer Custom Attribute Definition #
Ask an LLM
“Can I change the name or visibility of a customer attribute definition?”
“Which parts of a customer custom attribute definition are editable?”
Tell an agent
Update customer custom attribute definition {key} with {custom_attribute_definition}.
Rename customer attribute definition {key} per {custom_attribute_definition}.
POST /v2/customers/custom-attributes/bulk-upsert Set custom attributes on many customers · Square Bulk Upsert Customer Custom Attributes #
Ask an LLM
“Can I set custom field values on many customer profiles in one request?”
“Is there a bulk way to fill a custom attribute across customers?”
Tell an agent
Bulk upsert customer custom attributes {values}.
Write the customer attribute values in {values} across those profiles.
GET /v2/customers/{customer_id}/custom-attributes List a customer's custom attributes · Square List Customer Custom Attributes #
Ask an LLM
“Which custom attribute values are stored on a customer profile?”
“Can I get a customer's attributes with their definitions included?”
Tell an agent
List custom attributes for customer {customer_id}.
List customer {customer_id}'s custom attributes with definitions {with_definitions}.
DELETE /v2/customers/{customer_id}/custom-attributes/{key} Delete one custom attribute from a customer · Square Delete Customer Custom Attribute #
Ask an LLM
“Can I clear one custom field value from a customer profile?”
“Why might deleting a customer attribute owned by another app fail?”
Tell an agent destructive · confirm first
Delete custom attribute {key} from customer {customer_id}.
Clear customer {customer_id}'s value for attribute {key}.
GET /v2/customers/{customer_id}/custom-attributes/{key} Get one customer custom attribute · Square Retrieve Customer Custom Attribute #
Ask an LLM
“What value does a customer have for one particular custom field?”
“Can I read a single customer attribute along with its definition?”
Tell an agent
Get custom attribute {key} for customer {customer_id}.
Read customer {customer_id}'s value for attribute {key}.
POST /v2/customers/{customer_id}/custom-attributes/{key} Set one custom attribute on a customer · Square Upsert Customer Custom Attribute #
Ask an LLM
“How do I set a custom field value on a single customer profile?”
“Does setting a customer attribute replace the previous value?”
Tell an agent
Set attribute {key} on customer {customer_id} to {custom_attribute}.
Upsert customer {customer_id}'s custom attribute {key} with {custom_attribute}.

Documentation

📖
Documentation
https://developer.squareup.com/docs/payments-overview
📖
APIReference
https://developer.squareup.com/reference/square/payments-api
📖
Documentation
https://developer.squareup.com/docs/orders-api/what-it-does
📖
APIReference
https://developer.squareup.com/reference/square/orders-api
📖
Documentation
https://developer.squareup.com/docs/catalog-api/what-it-does
📖
APIReference
https://developer.squareup.com/reference/square/catalog-api
📖
Documentation
https://developer.squareup.com/docs/inventory-api/what-it-does
📖
APIReference
https://developer.squareup.com/reference/square/inventory-api
📖
Documentation
https://developer.squareup.com/docs/customers
📖
APIReference
https://developer.squareup.com/reference/square/customers-api
📖
Documentation
https://developer.squareup.com/docs/locations-api
📖
APIReference
https://developer.squareup.com/reference/square/locations-api
📖
Documentation
https://developer.squareup.com/docs/team/overview
📖
APIReference
https://developer.squareup.com/reference/square/team-api
📖
Documentation
https://developer.squareup.com/docs/labor-api/what-it-does
📖
APIReference
https://developer.squareup.com/reference/square/labor-api
📖
Documentation
https://developer.squareup.com/docs/bookings-api/what-it-is
📖
APIReference
https://developer.squareup.com/reference/square/bookings-api
📖
Documentation
https://developer.squareup.com/docs/loyalty-api/overview
📖
APIReference
https://developer.squareup.com/reference/square/loyalty-api
📖
Documentation
https://developer.squareup.com/docs/gift-cards/using-gift-cards-api
📖
APIReference
https://developer.squareup.com/reference/square/gift-cards-api
📖
Documentation
https://developer.squareup.com/docs/invoices-api/overview
📖
APIReference
https://developer.squareup.com/reference/square/invoices-api
📖
Documentation
https://developer.squareup.com/docs/subscriptions-api/overview
📖
APIReference
https://developer.squareup.com/reference/square/subscriptions-api
📖
Documentation
https://developer.squareup.com/docs/checkout-api
📖
APIReference
https://developer.squareup.com/reference/square/checkout-api
📖
Documentation
https://developer.squareup.com/docs/terminal-api/overview
📖
APIReference
https://developer.squareup.com/reference/square/terminal-api
📖
Documentation
https://developer.squareup.com/docs/payments-refunds
📖
APIReference
https://developer.squareup.com/reference/square/refunds-api
📖
Documentation
https://developer.squareup.com/docs/disputes-api/overview
📖
APIReference
https://developer.squareup.com/reference/square/disputes-api
📖
Documentation
https://developer.squareup.com/docs/merchants-api
📖
APIReference
https://developer.squareup.com/reference/square/merchants-api
📖
Documentation
https://developer.squareup.com/docs/cards-api/overview
📖
APIReference
https://developer.squareup.com/reference/square/cards-api
📖
Documentation
https://developer.squareup.com/docs/vendors-api/manage-vendors-in-apps
📖
APIReference
https://developer.squareup.com/reference/square/vendors-api
📖
Documentation
https://developer.squareup.com/docs/cashdrawershift-api/reporting
📖
APIReference
https://developer.squareup.com/reference/square/cash-drawers-api
📖
Documentation
https://developer.squareup.com/docs/bank-accounts-api
📖
APIReference
https://developer.squareup.com/reference/square/bank-accounts-api
📖
Documentation
https://developer.squareup.com/docs/payouts-api/overview
📖
APIReference
https://developer.squareup.com/reference/square/payouts-api
📖
Documentation
https://developer.squareup.com/docs/web-payments/apple-pay
📖
APIReference
https://developer.squareup.com/reference/square/apple-pay-api
📖
Documentation
https://developer.squareup.com/docs/sites-api/overview
📖
APIReference
https://developer.squareup.com/reference/square/sites-api
📖
Documentation
https://developer.squareup.com/docs/snippets-api/overview
📖
APIReference
https://developer.squareup.com/reference/square/snippets-api
📖
Documentation
https://developer.squareup.com/docs/oauth-api/overview
📖
APIReference
https://developer.squareup.com/reference/square/oauth-api
📖
Documentation
https://developer.squareup.com/docs/webhooks/overview
📖
APIReference
https://developer.squareup.com/reference/square/webhook-subscriptions-api
📖
Documentation
https://developer.squareup.com/docs/events-api/overview
📖
APIReference
https://developer.squareup.com/reference/square/events-api
📖
Documentation
https://developer.squareup.com/docs/devices-api/overview
📖
APIReference
https://developer.squareup.com/reference/square/devices-api
📖
Documentation
https://developer.squareup.com/docs/customer-groups-api/what-it-does
📖
APIReference
https://developer.squareup.com/reference/square/customer-groups-api
📖
Documentation
https://developer.squareup.com/docs/customer-segments-api/what-it-does
📖
APIReference
https://developer.squareup.com/reference/square/customer-segments-api
📖
Documentation
https://developer.squareup.com/docs/gift-cards/using-gift-card-activities-api
📖
APIReference
https://developer.squareup.com/reference/square/gift-card-activities-api
📖
Documentation
https://developer.squareup.com/docs/customer-custom-attributes-api/overview
📖
APIReference
https://developer.squareup.com/reference/square/customer-custom-attributes-api

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/square/refs/heads/main/openapi/square-customercustomattributes-api-openapi.yml
⚙
AsyncAPI
https://raw.githubusercontent.com/api-evangelist/square/refs/heads/main/asyncapi/square-webhooks-asyncapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/square/refs/heads/main/json-schema/square-bulk-upsert-customer-custom-attributes-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/square/refs/heads/main/json-schema/square-list-customer-custom-attribute-definitions-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/square/refs/heads/main/json-schema/square-list-customer-custom-attributes-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/square/refs/heads/main/json-schema/square-update-customer-custom-attribute-definition-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/square/refs/heads/main/json-schema/square-create-customer-custom-attribute-definition-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/square/refs/heads/main/json-schema/square-bulk-upsert-customer-custom-attributes-request-schema.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/square:square-customercustomattributes-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

square-customercustomattributes-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: '2.0'
  title: Square Customer Custom Attributes API
  description: Supercharge Square for sellers of every size. Our entire connected commerce platform from elegant hardware to a rich suite of Square APIs is yours to build with. Whether youre developing an app or composing a bespoke solution, this is the place to make it happen.
  termsOfService: https://connect.squareup.com/tos
  contact:
    name: Square Developer Platform
    email: developers@squareup.com
    url: https://squareup.com/developers
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
  externalDocs:
    description: 'Read the official documentation here:'
    url: https://docs.connect.squareup.com/
  x-server-configuration:
    default-environment: production
    default-server: default
    environments:
    - name: production
      servers:
      - name: default
        url: https://connect.squareup.com
    - name: sandbox
      servers:
      - name: default
        url: https://connect.squareupsandbox.com
    - name: custom
      servers:
      - name: default
        url: '{custom_url}'
    parameters:
    - name: custom_url
      description: Sets the base URL requests are made to. Defaults to `https://connect.squareup.com`
      type: string
      example: https://connect.squareup.com
  x-square-generic-error-codes:
  - ACCESS_TOKEN_EXPIRED
  - ACCESS_TOKEN_REVOKED
  - API_VERSION_INCOMPATIBLE
  - APPLICATION_DISABLED
  - ARRAY_EMPTY
  - ARRAY_LENGTH_TOO_LONG
  - ARRAY_LENGTH_TOO_SHORT
  - BAD_CERTIFICATE
  - BAD_GATEWAY
  - BAD_REQUEST
  - CONFLICT
  - CONFLICTING_PARAMETERS
  - CURRENCY_MISMATCH
  - EXPECTED_ARRAY
  - EXPECTED_BASE64_ENCODED_BYTE_ARRAY
  - EXPECTED_BOOLEAN
  - EXPECTED_FLOAT
  - EXPECTED_INTEGER
  - EXPECTED_JSON_BODY
  - EXPECTED_MAP
  - EXPECTED_OBJECT
  - EXPECTED_STRING
  - FORBIDDEN
  - GATEWAY_TIMEOUT
  - GONE
  - IDEMPOTENCY_KEY_REUSED
  - INCORRECT_TYPE
  - INSUFFICIENT_SCOPES
  - INTERNAL_SERVER_ERROR
  - INVALID_ARRAY_VALUE
  - INVALID_CONTENT_TYPE
  - INVALID_CURSOR
  - INVALID_ENUM_VALUE
  - INVALID_FORM_VALUE
  - INVALID_SORT_ORDER
  - INVALID_SQUARE_VERSION_FORMAT
  - INVALID_TIME
  - INVALID_TIME_RANGE
  - INVALID_VALUE
  - LOCATION_MISMATCH
  - MAP_KEY_LENGTH_TOO_LONG
  - MAP_KEY_LENGTH_TOO_SHORT
  - MERCHANT_SUBSCRIPTION_NOT_FOUND
  - METHOD_NOT_ALLOWED
  - MISSING_REQUIRED_PARAMETER
  - NOT_ACCEPTABLE
  - NOT_FOUND
  - NOT_IMPLEMENTED
  - NO_FIELDS_SET
  - RATE_LIMITED
  - REQUEST_ENTITY_TOO_LARGE
  - REQUEST_TIMEOUT
  - SANDBOX_NOT_SUPPORTED
  - SERVICE_UNAVAILABLE
  - TOO_MANY_MAP_ENTRIES
  - UNAUTHORIZED
  - UNEXPECTED_VALUE
  - UNKNOWN_BODY_PARAMETER
  - UNKNOWN_QUERY_PARAMETER
  - UNPROCESSABLE_ENTITY
  - UNSUPPORTED_MEDIA_TYPE
  - V1_ACCESS_TOKEN
  - V1_APPLICATION
  - VALUE_EMPTY
  - VALUE_REGEX_MISMATCH
  - VALUE_TOO_HIGH
  - VALUE_TOO_LONG
  - VALUE_TOO_LOW
  - VALUE_TOO_SHORT
servers:
- url: https://connect.squareup.com
  variables: {}
tags:


# --- truncated at 32 KB (98 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/square/refs/heads/main/openapi/square-customercustomattributes-api-openapi.yml