GET
/
v2
/
clients
/
{client_id}
cURL
curl --request GET \
  --url https://eu-vg-edge.moeaymandev.workers.dev/v2/clients/{client_id} \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "message": "Client 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).

Path Parameters

​
client_id
string
required

The ID of the client to retrieve

Response

200
application/json

Client retrieved

The response is of type object.