Contents
Get users in shared topics
Get a list of users in shared topics.
Method
GET
URL
https://typetalk.com/api/v4/search/friends
Scope
my
Query parameters
Name | Type | Description |
---|---|---|
q | String | query |
spaceKey | String | Space key |
offset (Optional) | Number | default value: 0 |
count (Optional) | Number | default value: 30, maximum: 100 |
Response Example
{
"count": 4,
"accounts": [
{
"account": {
"id": 2500,
"name": "Jessica",
"fullName": "Jessica Lee",
"suggestion": "Jessica Lee",
"imageUrl": "https://typetalk.com/accounts/2500/profile_image.png?t=1454061730873",
"isBot": false,
"createdAt": "2016-01-27T09:55:35Z",
"updatedAt": "2019-09-09T02:23:32Z"
},
"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"
}
},
{
"account": {
"id": 2499,
"name": "Moss",
"fullName": "Moss",
"suggestion": "Moss",
"imageUrl": "https://typetalk.com/accounts/2499/profile_image.png?t=1453891379196",
"isBot": false,
"createdAt": "2016-01-27T09:55:23Z",
"updatedAt": "2019-09-04T06:57:51Z"
},
"status": {
"presence": "away",
"web": null,
"mobile": null
},
"userStatus": null
}
]
}
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).