List merchants
GET
/v2/merchants
Returns Merchant information for a given access token.
If you don't know a Merchant ID, you can use this endpoint to retrieve the merchant ID for an access token.
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 you access.
If you know the merchant ID, you can also use the RetrieveMerchant endpoint to get the merchant information.
Permissions
MERCHANT_PROFILE_READ
Try in API Explorer
| Name | Description |
|---|---|
cursor
|
The cursor generated by the previous response. |
Response Fields
| Name | Description |
|---|---|
errors
|
Information on errors encountered during the request. |
merchant
|
The requested |
cursor
|
If the response is truncated, the cursor to use in next request to fetch next set of objects. |
Examples
GET
/v2/merchants
cURL
- cURL
- Ruby
- Python
- C#
- Java
- PHP
curl https://connect.squareup.com/v2/merchants \
-H 'Square-Version: 2020-09-23' \
-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"
}
]
}