Get user information

GET /users

Fetch information about the current user which is holding the API key

Available on: AuditGUARD AlertGUARD PremiumGUARD EliteGUARD

Responses

  • 200

    successful operation

    Hide response attributes Show response attributes object
    • customer_number string

      Unique ClickGUARD account identifier

    • name string

      Users full name

    • email string

      Users registered email address

    • status string

      Status of the ClickGUARD account

      Values are trialing, active, cancelling, cancelled, or paused.
GET /users 
curl \
 -X GET https://api.clickguard.com/users \
 -H "X-API-KEY: $API_KEY"
Response examples (200) 
"{\n  \"customer_number\": \"ABCDE\"\n  \"name\": \"John Doe\"\n  \"email\": \"john@example.com\"\n  \"status\": \"active\"\n}"
Response examples (200) 
{
  "customer_number": "string",
  "name": "string",
  "email": "string",
  "status": "trialing"
}