1. API
  2. v1
  3. CORE
  4. USERS

Me

Resource Fields

Name Type Read-only Description
full_name string
designation string
is_enabled boolean
role Role
avatar string
agent_case_access string SELF, TEAMS, INHERIT-FROM-ROLE, ALL

Only applicable for the role type ADMIN, AGENT, colLABORATOR

Default: ALL
organization_case_access string REQUESTED, ORGANIZATION

Only applicable for the role type CUSTOMER

Default: REQUESTED
organization Organization
teams Teams
emails Emails
phones Phones
twitter Twitter
facebook Facebook
external_identifiers External Identifiers
addresses Addresses
websites Websites
custom_fields Custom Fields
pinned_notes_count integer
locale Locale
time_zone string
time_zone_offset string The time zone offset of the person. Useful for calculating the timezone differences.
greeting string
signature string
status_message string
last_seen_user_agent string
last_seen_ip string
last_seen_at timestamp ISO-8601 Format
last_active_at timestamp ISO-8601 Format.

The timestamp when user's direct or indirect property updated like note added or tag created for user.
realtime_channel string Subscribe to this channel for realtime updates
presence_channel string Subscribe to see "who's online"
password_updated_at timestamp ISO-8601 Format
avatar_updated_at timestamp ISO-8601 Format
last_logged_in_at timestamp ISO-8601 Format
last_activity_at timestamp ISO-8601 Format
created_at timestamp ISO-8601 Format
updated_at timestamp ISO-8601 Format
permissions Permissions
settings Settings
notification_channel string Subscribe to this channel for updates on notifications



Metadata




 
 



Version 1.0
Last Updated July 04, 2016

Actions

Retrieve current user

GET /api/v1/me.json

Information

Allowed for Customers, Collaborators, Agents, Admins & Owners

Response

    {
        "status": 200,
        "data": 



{
    "id": 1,

    "uuid": "11b60c25-c44c-47b8-9f48-56631cd7fa01",
    "full_name": "Simon Blackhouse",
    "legacy_id": null,
    "designation": "Community Manager",
    "is_enabled": true,
    "is_mfa_enabled": true,
    "role":







{
    "id": 2,

    "resource_type": "role"

},

    "avatar": "https://brewfictus.kayako.com/avatar/get/24ee2d81-ad95-5ae1-a07e-7ccedcdb70b8",
    "agent_case_access": "ALL",
    "organization_case_access": null,
    "organization": {
    "id": 1,

    "resource_type": "organization"

}
,
    "teams": [

    ],
    "emails": [
        {
    "id": 1,

    "resource_type": "identity_email"

}
    ],
    "phones": [




{
    "id": 1,

    "resource_type": "identity_phone"

}

    ],
    "twitter": [],
    "facebook": [],
    "external_identifiers": [],
    "addresses": [
        {
    "id": 1,

    "resource_type": "contact_address"

}

    ],
    "websites": [
        {
    "id": 1,

    "resource_type": "contact_website"

}
    ],
   "custom_fields": [
       {
           "field": {
    "id": 1,

    "resource_type": "user_field"

}
,
           "value": "Customer Success",
           "resource_type": "user_field_value"
       }
    ],
    "pinned_notes_count": 0,
    "locale": "en-us",
    "time_zone": null,
    "time_zone_offset": null,
    "greeting": null,
    "signature": null,
    "status_message": null,
    "last_seen_user_agent": null,
    "last_seen_ip": null,
    "last_seen_at": null,
    "last_active_at": null,
    "realtime_channel": "presence-0c1c9535b26b749f815a22cb459a4a8084be77b6ac9515751ef5a743b190bef3@v1_users_6",
    "presence_channel": "user_presence-281f395f6f51d031a6d3db3489906c98285191ebac41bb744f9323f61af63433@5c98cdaa58dd91ff1119a476e8b3e305d2906d3b",
    "password_updated_at": "2016-03-15T10:38:01+05:00",
    "avatar_updated_at": null,
    "last_logged_in_at": null,
    "last_activity_at": null,
    "created_at": "2016-03-15T10:38:01+05:00",
    "updated_at": "2016-03-15T10:38:01+05:00",

    "permissions": [
        {
    "id": 177,

    "resource_type": "permission"

}
    ],


    "notification_channel": "user_presence-282f395f6f51d031a6d3d3489906z9v8285191ebacb1bb744f9323f61af63433@4c98ydaa58dd9zff1119a476e8b3e305d2905d3b",


    "settings":
    [
  {
    "id": 1,

    "resource_type": "setting"
  },
  {
    "id": 2,

    "resource_type": "setting"
  },
  {
    "id": 3,

    "resource_type": "setting"
  }
]
    ,


    "resource_type": "user"

    ,"resource_url": "https://brewfictus.kayako.com/api/v1/users/1"

}
,
        "resource": "user"
    }