api.account.get_profile

GET /account/profile — ACPortal

Python

api.account.get_profile() -> AccountProfile

CLI

ab account get_profile

GET /account/profile — the authenticated user’s account profile.

Returns the profile of whoever the client’s token belongs to (user name, email, company, contact id, roles).

Response model: AccountProfile

Response

Returns AccountProfile.

Field

Type

Required

Description

userName

Optional[str]

no

Login user name

email

Optional[str]

no

Account email address

companyId

Optional[str]

no

Company UUID

contactId

Optional[int]

no

Contact ID

roles

Optional[list[str]]

no

Role names assigned to the user


← Back to api.account