友人を取得

メソッド

GET

URL

https://typetalk.com/api/v4/search/friends

スコープ

my

クエリパラメーター

名前 説明
q 文字列 クエリー
spaceKey 文字列 組織キー
offset (任意) 数値 デフォルト値: 0
count (任意) 数値 デフォルト値: 30、最大値: 100

レスポンスの例

{
    "count": 5,
    "accounts": [
        {
            "account": {
                "id": 2492,
                "name": "hayashi-sample",
                "fullName": "hayashi",
                "suggestion": "hayashi",
                "imageUrl": "https://stage.typetalk.com/accounts/2492/profile_image.png?t=1453871047310",
                "isBot": false,
                "createdAt": "2016-01-26T08:19:01Z",
                "updatedAt": "2019-09-04T07:25:45Z"
            },
            "status": {
                "presence": "away",
                "web": null,
                "mobile": null
            },
            "userStatus": null
        },
        {
            "account": {
                "id": 2488,
                "name": "masa",
                "fullName": "masa",
                "suggestion": "masa",
                "imageUrl": "https://stage.typetalk.com/accounts/2488/profile_image.png?t=1453868694472",
                "isBot": false,
                "createdAt": "2016-01-26T08:17:39Z",
                "updatedAt": "2019-09-09T02:27:31Z"
            },
            "status": {
                "presence": "active",
                "web": {},
                "mobile": null
            },
            "userStatus": {
                "id": 129,
                "accountId": 2488,
                "spaceId": 29,
                "emoji": ":spiral_note_pad:",
                "message": "ミーティング中",
                "clearAt": "2019-09-09T02:58:00Z",
                "isNotificationDisabled": true,
                "createdAt": "2019-09-03T01:37:34Z",
                "updatedAt": "2019-09-09T02:28:00Z"
            }
        }
    ]
}

レスポンスのフォーマットは全てJSONです。GETメソッドはETagに対応しているので、If-None-Match ヘッダを付けて送ると、変更がない場合は304を返します。日付のフォーマットは ISO 8601 で、UTC です。 (例 : 2014-01-09T06:20:08Z )