User

Users are a core part of Halluminate. On this page, we'll dive into the different user endpoints you can use to manage your organizations and projects.

The user model

The user model contains all the information about your user, such as their username and email.

Properties

Name
uuid
Type
UUIDField
Description
Unique identifier for the user.
Name
token
Type
TokenField
Description
API key for the user.
Name
created
Type
DateTimeField
Description
Timestamp of when the user was created.
Name
last_updated
Type
DateTimeField
Description
Timestamp of when the user's information was last updated.
Name
data
Type
JSONField
Description
The customizable data for the user.
Name
username
Type
string
Description
The username for the user.
Name
email
Type
string
Description
The email for the user.
Name
email_is_verified
Type
boolean
Description
The verificatino status of the user's email.

GET/me

Retrieve a user

This endpoint allows you to retrieve a user. Refer to the list at the top of this page to see which properties are included with user objects.

Optional attributes

Name
email
Type
string
Description
The user's email.
Name
usernmae
Type
string
Description
The user's username.

Request

GET

/me

import requests

ENDPOINT_URL = "https://api.halluminate.ai/me/"
headers = {"Authorization": "Token <your_token_here>"}

def me():
    return requests.get(ENDPOINT_URL, headers=headers).json()

response = me()

Response

{
  "uuid": "ca4c56b5-3e30-4b7a-a6ae-19583954fb75",
  "username": "testcase",
  "email": "testcase@example.com",
  "token": "token",
  "created": "2024-07-17T17:27:16.980246-04:00",
  "last_updated": "2024-07-17T17:27:16.980250-04:00",
  "data": {},
  "email_is_verified": true
}