iQ Suite - Docs
SDK Reference

Get User

Retrieve information about the authenticated user.

Description

The Get User endpoint allows you to retrieve information about the authenticated user associated with your API key.

HTTP Request

GET /user

Authentication

All requests must include an Authorization header with a valid API key.

Headers

KeyValue
AuthorizationBearer YOUR_API_KEY
Content-Typeapplication/json

Request Example

from iqsuite import IQSuiteClient, AuthenticationError, APIError
 
client = IQSuiteClient(api_key="YOUR_API_KEY")
 
try:
    user = client.get_user()
    print(f"User Email: {user.email}")
except AuthenticationError:
    print("Invalid API key")
except APIError as e:
    print(f"API Error: {e}")

Response

Success

Status Code: 200 OK

Body:

{
    "id": 2,
    "name": "admin",
    "email": "admin@acme.com",
    "email_verified_at": "2025-01-18T06:21:43.000000Z",
    "created_at": "2025-01-06T18:36:42.000000Z",
    "updated_at": "2025-01-18T06:21:43.000000Z",
    "notification_channels": ["webhook"]
}

On this page