メンバー一覧取得 (REST APIリファレンス)/ref_api/record/members_list
登録済みメンバー一覧を取得します。
リクエスト
メソッド
GET
URL
https:////list/rest_api=1.0/
ヘッダー
パラメータ名 | 値 |
---|---|
Content-Type | application/json |
すべてのリソースで共通するリクエストヘッダーの仕様は、こちらをご参照ください。
コンテント
一覧データの出力を制御するには、リスト制御パラメータを指定してください。
フィルタリングパラメータで使用可能なフィールド
フィールド名 | 説明 |
---|---|
login_id | メンバーログインID |
contents |
メンバーコンテンツ |
last_logined | 最終ログイン日時 |
created | 作成日時 |
group | グループID |
リクエスト例
curl -v -X GET
-H "CONTENT-TYPE: application/json"
-H "X-ECHO-APP-ID: fd15eacfaf2388fac2980fef163c6116"
-H "X-ECHO-APP-KEY: 0cdf8bc765d7d9604e83becf93137d42"
"https://hogehoge.echopf.com/members/list/rest_api=1.0/"
レスポンス
HTTPステータス
ステータスコード | 内容 |
---|---|
200 | 取得成功 |
ヘッダー
パラメータ名 | 値 |
---|---|
Content-Type | application/json |
コンテント
メンバーデータが一覧形式で出力されます。
フィールド名 | 型 | 説明 |
---|---|---|
members | 配列 | メンバー一覧(各要素はメンバーオブジェクト) |
paginate | ページ送りオブジェクト | リスト位置情報 |
レスポンス例
{
"members":[
{
"refid":"127",
"login_id":"user01",
"contents":{
"name":"User Name",
"email":"hogehoge@echopf.com"
},
"created":"2014-01-01 00:00:00",
"last_logined":"2014-01-02 00:00:00",
"groups":[],
"acl":{
"*" {
"get":true,
"list":true,
"edit":true,
"delete":true
}
}
}
],
"paginate":{
"page":1,
"prevPage":false,
"nextPage":false,
"pageCount":1,
"count":1,
"limit":10,
"order":"created",
"asc":false
}
}