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

The Devices API from Square — 4 operation(s) for devices.

Square Devices 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 Devices. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and an AsyncAPI specification.

This API exposes 5 operations across 4 paths, and defines 28 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.

5 operations 4 paths 28 schemas 4 GET1 POST

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 Devices 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 5

Across 4 paths, the API surfaces 5 operations — 4 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Devices 5
GET
/v2/devices
Square List Devices
ListDevices 4 params → 200
GET
/v2/devices/codes
Square List Device Codes
ListDeviceCodes 4 params → 200
POST
/v2/devices/codes
Square Create Device Code
CreateDeviceCode body → 200
GET
/v2/devices/codes/{id}
Square Get Device Code
GetDeviceCode 1 param → 200
GET
/v2/devices/{device_id}
Square Get Device
GetDevice 1 param → 200

Schemas 28

The contract defines 28 schemas that model the data the API accepts and returns. The most detailed are DeviceCode (11 properties), DeviceAttributes (8 properties), Component (6 properties), DeviceComponentDetailsWiFiDetails (5 properties). Each schema is shown below with its type and property counts.

DeviceComponentDetailsBatteryDetails
object
2 properties
DeviceCode
object
11 properties 1 required
ComponentComponentType
string
An enum for ComponentType.
DeviceAttributes
object
8 properties 2 required
GetDeviceResponse
object
2 properties
CreateDeviceCodeResponse
object
2 properties
DeviceStatusCategory
string
Component
object
The wrapper object for the component entries of a given component type.
6 properties 1 required
ListDevicesResponse
object
3 properties
DeviceComponentDetailsExternalPower
string
An enum for ExternalPower.
DeviceStatus
object
1 property
DeviceCodeStatus
string
DeviceCode.Status enum.
ProductType
string
ErrorCategory
string
Indicates which high-level category of error has occurred during a request to the Connect API.
DeviceComponentDetailsApplicationDetails
object
4 properties
SortOrder
string
The order (e.g., chronological or alphabetical) in which results from a request are returned.
DeviceComponentDetailsWiFiDetails
object
5 properties
GetDeviceCodeResponse
object
2 properties
CreateDeviceCodeRequest
object
2 properties 2 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.
DeviceComponentDetailsMeasurement
object
A value qualified by unit of measure.
1 property
DeviceAttributesDeviceType
string
An enum identifier of the device type.
ApplicationType
string
Device
object
4 properties 1 required
DeviceComponentDetailsCardReaderDetails
object
1 property
ListDeviceCodesResponse
object
3 properties
DeviceComponentDetailsEthernetDetails
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

square-devices-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 Devices 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.