Me
The API key making the request: its scopes, its user's role and its agency.
Endpoints
The Me object
object
stringread-only
Always me.
id
stringread-only
The key's public identifier: the part of the key between ak_ and the second underscore.
name
string | nullread-only
The name given to the key when it was created.
scopes
array of stringsread-only
What the key may do. A key without write can only read.
One of
readwriterole
stringread-only
Role of the person the key belongs to: RootUser (agency administrator), User (office staff), Caregiver or Patient. It decides which resources the key can reach.
One of
RootUserUserCaregiverPatientemail
string · emailread-only
Email address of the person the key belongs to.
expiresAt
string · date-timeread-only
When the key stops working.
organization
objectread-only
The agency the key belongs to.
Show child attributesHide child attributes(2)
id
stringrequired
ID of the agency.
name
string | nullrequired
Agency name.