Skip to main content

Get User​

Get user's profile

Path Parameters
    companyID companyID required

    The id of the company

    userID userID required

    The id of the user

Responses

A user object

Schema
    id string

    Unique ID of the the user

    email string

    Email of the user

    createdAt date-time

    Date the user was created

    updatedAt date-time

    Date the user was last updated

    deletedAt date nullable

    Date the user was deleted

    teams string[]

    List of teams the user is part of

    about object

    Profile details (* only available in premium plans)

    firstname string nullable

    First name of the user

    lastname string nullable

    Last name of the user

    position string nullable

    Job title

    birthday date nullable

    Birthday of the user in MM/DD format*

    startDate date nullable

    Date the user joined the company in YYYY-MM-DD format*

    homeCity object nullable

    City where the user lives*

    main string

    Main text

    secondary string

    Secondary text

    ingredients string[] nullable

    List of ingredients that defines the user*

    languages string[] nullable

    List of languages the user speaks*

    favoriteFoods string[] nullable

    List of favorite foods*

    activities string[] nullable

    List of activities the user likes*

    music string[] nullable

    List of music the user likes*

    sports string[] nullable

    List of sports the user likes*

    movies string[] nullable

    List of movies & TV shows the user likes*

    skills string[] nullable

    List of skills the user has*

    books string[] nullable

    List of books the user likes*

    mentor string[] nullable

    List of topics the user can mentor*

    mentee string[] nullable

    List of topics the user wants to learn*

    preferences object

    User preferences (only available in premium plans)

    slack object
    linked boolean

    Whether the user has linked their Slack account

    userID string nullable

    Slack ID of the user

    teamID string nullable

    Slack ID of the team

    name string nullable

    Slack name of the user

    googleCalendar object
    linked boolean

    Whether the user has linked their Google Calendar

    microsoftOutlook object
    linked boolean

    Whether the user has linked their Microsoft Outlook

    customAttributes object

    Custom attributes (only available in premium plans)

Loading...