Contents

Get user profile

Get a user’s profile, including status and online information, within a specific topic.

Method

GET

URL

https://typetalk.com/api/v2/spaces/:spaceKey/profile

Scope

my

URL parameters

NameTypeDescription
spaceKeyStringSpace key

Query parameters

NameTypeDescription
accountName (Optional)StringAccount name
nulabId (Optional)StringNulab ID

Response Example

{
    "account": {
        "id": 2500,
        "name": "Jessica",
        "fullName": "Jessica Lee",
        "suggestion": "Jessica Lee",
        "mailAddress": "jessica@nulab.com",
        "imageUrl": "https://typetalk.com/accounts/2500/profile_image.png?t=1454061730873",
        "createdAt": "2016-01-27T09:55:35Z",
        "updatedAt": "2019-09-09T02:23:32Z",
        "imageUpdatedAt": "2016-01-29T10:02:10Z"
    },
    "status": {
        "presence": "away",
        "web": null,
        "mobile": null
    },
    "userStatus": {
        "id": 123,
        "accountId": 2500,
        "spaceId": 34,
        "emoji": ":spiral_note_pad:",
        "message": "Meeting",
        "clearAt": "2019-09-06T10:49:00Z",
        "isNotificationDisabled": true,
        "createdAt": "2019-09-02T06:28:02Z",
        "updatedAt": "2019-09-06T10:19:43Z"
    }
}

All responses are formatted in JSON and include an ETag. If you call an API with an If-None-Match header, the server will return a 304 status code if the data is unchanged. The date and time format is ISO 8601, and the timezone is UTC (eg. 2014-01-09T06:20:08Z).