Me

object

userrequired: object
user.idrequired: Id
Opaque record id.
user.namerequired: string
user.emailrequired: string or null
user.phonerequired: PhoneE164 or null
Phone number in E.164 format.
user.image_urlrequired: string or null
user.two_factor_enabledrequired: boolean
memberrequired: object
member.idrequired: Id
Opaque record id.
member.statusrequired: MemberStatus
member.designationrequired: string or null
member.employee_coderequired: string or null
member.branch_idrequired: Id or null
Opaque record id.
member.reports_to_idrequired: Id or null
Opaque record id.
member.languagesrequired: array of string
member.rolerequired: object
member.role.idrequired: Id
Opaque record id.
member.role.keyrequired: string
member.role.namerequired: string
member.role.is_ownerrequired: boolean
companyrequired: CompanySummary
workspacesrequired: array of object
workspaces[].company_idrequired: Id
Opaque record id.
workspaces[].namerequired: string
workspaces[].slugrequired: string
workspaces[].logo_urlrequired: string or null
workspaces[].role_namerequired: string
workspaces[].currentrequired: boolean
sessionrequired: object
session.viarequired: "web" | "mobile"
permissionsrequired: EffectivePermissions
Flattened permissions after owner, grant and API-key rules.
featuresrequired: Features
Plan features after per-tenant overrides.

Example

{
  "user": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "name": "string",
    "email": "string",
    "phone": "+919812345678",
    "image_url": "string",
    "two_factor_enabled": true
  },
  "member": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "status": "invited",
    "designation": "string",
    "employee_code": "string",
    "branch_id": "cmusrceel0000q7kaafxqi1om",
    "reports_to_id": "cmusrceel0000q7kaafxqi1om",
    "languages": [
      "string"
    ],
    "role": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "key": "string",
      "name": "string",
      "is_owner": true
    }
  },
  "company": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "name": "string",
    "slug": "string",
    "type": "broker",
    "status": "trial",
    "timezone": "Asia/Kolkata",
    "locale": "string",
    "currency": "string",
    "brand_color": "string",
    "logo_url": "string"
  },
  "workspaces": [
    {
      "company_id": "cmusrceel0000q7kaafxqi1om",
      "name": "string",
      "slug": "string",
      "logo_url": "string",
      "role_name": "string",
      "current": true
    }
  ],
  "session": {
    "via": "web"
  },
  "permissions": {},
  "features": {}
}

{ "user": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string", "email": "string", "phone": "+919812345678", "image_url": "string", "two_factor_enabled": true }, "member": { "id": "cmusrceel0000q7kaafxqi1om", "status": "invited", "designation": "string", "employee_code": "string", "branch_id": "cmusrceel0000q7kaafxqi1om", "reports_to_id": "cmusrceel0000q7kaafxqi1om", "languages": [ "string" ], "role": { "id": "cmusrceel0000q7kaafxqi1om", "key": "string", "name": "string", "is_owner": true } }, "company": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string", "slug": "string", "type": "broker", "status": "trial", "timezone": "Asia/Kolkata", "locale": "string", "currency": "string", "brand_color": "string", "logo_url": "string" }, "workspaces": [ { "company_id": "cmusrceel0000q7kaafxqi1om", "name": "string", "slug": "string", "logo_url": "string", "role_name": "string", "current": true } ], "session": { "via": "web" }, "permissions": {}, "features": {} }