友人を取得

メソッド

GET

URL

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

スコープ

my

クエリパラメーター

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

レスポンスの例

{
    "count": 5,
    "accounts": [
        {
            "account": {
                "id": 2489,
                "name": "agata",
                "fullName": "Toshitaka Agata",
                "suggestion": "Toshitaka Agata",
                "imageUrl": "https://typetalk.com/accounts/2489/profile_image.png?t=1453867573519",
                "isBot": false,
                "createdAt": "2016-01-26T08:18:12Z",
                "updatedAt": "2018-05-08T06:18:19Z"
            },
            "status": {
                "presence": "away",
                "web": null,
                "mobile": null
            }
        },
        {
            "account": {
                "id": 2492,
                "name": "hayashi",
                "fullName": "hayashi",
                "suggestion": "hayashi",
                "imageUrl": "https://typetalk.com/accounts/2492/profile_image.png?t=1453871047310",
                "isBot": false,
                "createdAt": "2016-01-26T08:19:01Z",
                "updatedAt": "2018-05-08T06:18:19Z"
            },
            "status": {
                "presence": "away",
                "web": null,
                "mobile": null
            }
        },
        {
            "account": {
                "id": 2488,
                "name": "masanori",
                "fullName": "masa",
                "suggestion": "masa",
                "imageUrl": "https://typetalk.com/accounts/2488/profile_image.png?t=1453868694472",
                "isBot": false,
                "createdAt": "2016-01-26T08:17:39Z",
                "updatedAt": "2018-05-10T04:53:41Z"
            },
            "status": {
                "presence": "active",
                "web": {},
                "mobile": null
            }
        },
        {
            "account": {
                "id": 2491,
                "name": "nakamura",
                "fullName": "ikikko",
                "suggestion": "ikikko",
                "imageUrl": "https://typetalk.com/accounts/2491/profile_image.png?t=1453873118352",
                "isBot": false,
                "createdAt": "2016-01-26T08:18:46Z",
                "updatedAt": "2018-05-08T06:18:19Z"
            },
            "status": {
                "presence": "away",
                "web": null,
                "mobile": null
            }
        },
        {
            "account": {
                "id": 2490,
                "name": "tabata",
                "fullName": "Shinsuke Tabata",
                "suggestion": "Shinsuke Tabata",
                "imageUrl": "https://typetalk.com/accounts/2490/profile_image.png?t=1453863100614",
                "isBot": false,
                "createdAt": "2016-01-26T08:18:29Z",
                "updatedAt": "2018-05-08T06:18:19Z"
            },
            "status": {
                "presence": "away",
                "web": null,
                "mobile": null
            }
        }
    ]
}

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