API Reference

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Profile

Authenticate User

client.profile.authenticate(ProfileAuthenticateParams { emailaddress, password } body?, RequestOptionsoptions?): ProfileAuthenticateResponse { Data, Metadata }

POST/profile/authenticate

ModelsExpand Collapse

ProfileAuthenticateResponse { Data, Metadata }

Data: Data { access_token, UserProfile }

access_token: string

JWT Bearer Token to use in subsequent authenticated requests

minLength1

UserProfile: UserProfile { DateCreated, ID, IsProfilePublic, 11 more }

Full user profile, including non-public fields such as Email Address

DateCreated: string

minLength1

ID: number

IsProfilePublic: boolean

Username: string

minLength1

DateLastLogin?: string

minLength1

EmailAddress?: string

minLength1

Latitude?: number

Location?: string

minLength1

Longitude?: number

Permissions?: string

minLength1

Profile?: string

minLength1

ProfileImageURL?: string

minLength1

ReputationPoints?: number

WebsiteURL?: string

minLength1

Metadata: Metadata { StatusCode }

StatusCode: number