• Example searches: “transaction”, “CreateOrder”, “/v2/locations”, “inventory”, “delete customer”

You are viewing an old version of the API
List merchants

GET /v2/merchants

Provides details about the merchant associated with a given access token.

The access token used to connect your application to a Square seller is associated with a single merchant. That means that ListMerchants returns a list with a single Merchant object. You can specify your personal access token to get your own merchant information or specify an OAuth token to get the information for the merchant that granted your application access.

If you know the merchant ID, you can also use the RetrieveMerchant endpoint to retrieve the merchant information.

Permissions
MERCHANT_PROFILE_READ
Guide
Merchants API Overview Try in API Explorer

Query Parameters

Example code
Name Description
cursor
integer (32-bit)

The cursor generated by the previous response.

Response Fields
Name Description
errors
Error [ ]

Information on errors encountered during the request.
merchant
Merchant [ ]

The requested Merchant entities.
cursor
integer (32-bit)

If the response is truncated, the cursor to use in next request to fetch next set of objects.

Examples

You are viewing an old version of the API
GET /v2/merchants
cURL
  • cURL
  • Ruby
  • Python
  • C#
  • Java
  • PHP
  • Node.js 
curl https://connect.squareup.com/v2/merchants \
  -H 'Square-Version: 2023-01-19' \
  -H 'Authorization: Bearer ACCESS_TOKEN' \
  -H 'Content-Type: application/json'
Response JSON 
{
  "merchant": [
    {
      "id": "DM7VKY8Q63GNP",
      "business_name": "Apple A Day",
      "country": "US",
      "language_code": "en-US",
      "currency": "USD",
      "status": "ACTIVE",
      "main_location_id": "9A65CGC72ZQG1",
      "created_at": "2021-12-10T19:25:52.484Z"
    }
  ]
}