GET
/
v2
/
clients
cURL
curl --request GET \
  --url https://eu-vg-edge.moeaymandev.workers.dev/v2/clients \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "message": "Clients retrieved successfully",
  "data": [
    {
      "ID": "<string>",
      "ownerID": "<string>",
      "orgUsers": [
        "<any>"
      ],
      "orgId": "<string>",
      "name": "<string>",
      "squarePhotoURL": "<string>",
      "email": "<string>",
      "dashboardPassword": "<string>",
      "canAccess": [
        "/overview"
      ],
      "isOrgAdmin": true,
      "notificationsSettings": {
        "notifyThrough": "email",
        "notifyIf": "all"
      }
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Workspace secret API key, found in the workspace settings page (top left).

Response

200
application/json

Clients retrieved

The response is of type object.