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

Link to section

Query parameters

Example code

Link to section

cursor

integer(32-bit)

The cursor generated by the previous response.

Link to section

Response fields

Link to section

errors

Information on errors encountered during the request.

Link to section

merchant

The requested Merchant entities.

Link to section

cursor

integer(32-bit)

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