---
updatedAt: 2026-04-27T20:42:40.000Z
agentTools:
  projectIndex: https://docs.clover.com/dev/llms.txt
---

# Get a single merchant

# OpenAPI definition

```json
{
  "x-samples-languages": [
    "curl",
    "node",
    "javascript",
    "java",
    "swift",
    "csharp"
  ],
  "openapi": "3.0.1",
  "info": {
    "title": "Platform API",
    "version": "3.0"
  },
  "externalDocs": {
    "url": "https://docs.clover.com"
  },
  "servers": [
    {
      "url": "https://apisandbox.dev.clover.com"
    }
  ],
  "security": [
    {
      "bearerAuth": []
    }
  ],
  "paths": {
    "/v3/merchants/{mId}": {
      "get": {
        "tags": [
          "MERCHANTS"
        ],
        "summary": "Get a single merchant",
        "description": "",
        "operationId": "merchant.GetMerchant",
        "parameters": [
          {
            "$ref": "#/components/parameters/UserAgentHeader"
          },
          {
            "name": "mId",
            "in": "path",
            "description": "Merchant identifier (mId).",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "expand",
            "in": "query",
            "description": "Expandable fields to display additional nested information: [employees, bankProcessing, externalMerchant, merchantBoarding, merchantL3Prerequisite, deviceBoarding, programExpress, hierarchy, shifts, orders, address, logos, owner, items, tags, tenders, payments, gateway, printers, modifierGroups, properties, tipSuggestions, openingHours, partnerApp, selfBoardingApplication, enterprises, equipment, equipmentSummary]",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response. Merchant details are displayed.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "name",
                    "owner"
                  ],
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "string",
                      "description": "Merchant unique identifier."
                    },
                    "name": {
                      "type": "string",
                      "description": "Merchant name."
                    },
                    "reseller_id": {
                      "type": "string",
                      "description": "Reseller identifier for the merchant."
                    },
                    "owner": {
                      "description": "Merchant's account owner.",
                      "required": [
                        "name"
                      ],
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "string",
                          "description": "Employee unique identifier."
                        },
                        "name": {
                          "type": "string",
                          "description": "Employee's full name."
                        },
                        "nickname": {
                          "type": "string",
                          "description": "Employee's nickname (displayed on receipts)."
                        },
                        "customId": {
                          "type": "string",
                          "description": "Employee's custom identifier."
                        },
                        "email": {
                          "type": "string",
                          "description": "Employee's email address. This field is optional."
                        },
                        "inviteSent": {
                          "type": "boolean",
                          "description": "Indicates whether an invite was sent to the employee to activate their account.\n Values:\n True - Account activation invite sent to the employee.\n False - Account activation invite not sent to the employee."
                        },
                        "claimedTime": {
                          "type": "integer",
                          "description": "Time when the employee claimed their account."
                        },
                        "deletedTime": {
                          "type": "integer",
                          "description": "Time when the employee account was deleted."
                        },
                        "pin": {
                          "type": "string",
                          "description": "Employee’s personal identification number (hashed PIN)."
                        },
                        "unhashedPin": {
                          "type": "string",
                          "description": "Employee’s personal identification number (unhashed PIN)."
                        },
                        "role": {
                          "type": "string",
                          "description": "Employee role.\n Values:\n Owner\n Admin\n Manager\n Employee",
                          "enum": [
                            "OWNER",
                            "ADMIN",
                            "MANAGER",
                            "EMPLOYEE"
                          ]
                        },
                        "roles": {
                          "type": "array",
                          "items": {
                            "type": "object",
                            "properties": {
                              "id": {
                                "type": "string",
                                "description": "Role unique identifier."
                              }
                            }
                          }
                        },
                        "isOwner": {
                          "type": "boolean",
                          "description": "Indicates whether the employee has an Owner role for the merchant account.\n Values:\n True - Employee has an Owner role.\n False - Employee does not have an Owner role."
                        },
                        "shifts": {
                          "type": "array",
                          "description": "Employee  shift details.",
                          "items": {
                            "type": "object",
                            "properties": {
                              "id": {
                                "type": "string",
                                "description": "Unique identifier."
                              }
                            }
                          }
                        },
                        "payments": {
                          "type": "array",
                          "description": "Payment transactions for the employee.",
                          "items": {
                            "type": "object",
                            "properties": {
                              "id": {
                                "type": "string",
                                "description": "Unique identifier."
                              }
                            }
                          }
                        },
                        "orders": {
                          "type": "array",
                          "description": "Order details for the employee.",
                          "items": {
                            "type": "object",
                            "properties": {
                              "id": {
                                "type": "string",
                                "description": "Order unique identifier."
                              }
                            }
                          }
                        },
                        "employeeCards": {
                          "type": "array",
                          "description": "Employee card details.",
                          "items": {
                            "type": "object",
                            "properties": {
                              "id": {
                                "type": "string",
                                "description": "Employee card unique identifier."
                              }
                            }
                          }
                        },
                        "merchant": {
                          "type": "object",
                          "properties": {
                            "id": {
                              "type": "string",
                              "description": "Merchant unique identifier."
                            }
                          },
                          "description": "Merchant who employs the employee"
                        }
                      }
                    },
                    "address": {
                      "description": "Address of the merchant.",
                      "type": "object",
                      "properties": {
                        "address1": {
                          "type": "string",
                          "description": "First line of the address. Can include the street address, PO box, or company name."
                        },
                        "address2": {
                          "type": "string",
                          "description": "Second line of the address. Can include the apartment, suite, unit, or building number."
                        },
                        "address3": {
                          "type": "string",
                          "description": "Third line of the address."
                        },
                        "city": {
                          "type": "string",
                          "description": "City of the address."
                        },
                        "country": {
                          "type": "string",
                          "description": "Country of the address."
                        },
                        "state": {
                          "type": "string",
                          "description": "State of the address."
                        },
                        "zip": {
                          "type": "string",
                          "description": "Postal code or ZIP of the address."
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "deprecated": false
      }
    }
  },
  "components": {
    "securitySchemes": {
      "bearerAuth": {
        "type": "http",
        "scheme": "bearer"
      }
    },
    "parameters": {
      "UserAgentHeader": {
        "name": "User-Agent",
        "in": "header",
        "description": "Identifies the application, operating system, vendor, and/or version of the requesting user agent. Format: `<product> / <product-version> <comment>`",
        "required": true,
        "schema": {
          "type": "string"
        },
        "example": "PostmanRuntime/7.44.1"
      }
    }
  },
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": false,
    "samples-enabled": true
  }
}
```