登録されているユーザのデータ一覧を取得します。
ファイルのデータは POST form data として送信します。
エンドポイント(URL) | https://flex-crm.com/<site_id>/api/v1/user |
---|---|
HTTPメソッド | GET |
リクエストヘッダ(APIキー) | 認証用のAPIキー |
<site_id> は ワークスペース申込み時に登録されている “ワークスペースID” です。
statusステータス |
---|
limit取得時のデータ制限数 |
offset取得時のデータ取得位置 |
count取得データ数 |
maxCount総データ数 |
data
データ情報 id:<レコード番号> |
https://flex-crm.com/flex/api/v1/user
X-FlexCRM-API-KEY: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
GET https://flex-crm.com/flex/api/v1/user
{
status: “success”,
limit: 100,
offset: 0,
count: 100,
maxCount: 1000,
data: [
{
id: “1”,
userid: “flex”,
name: “Flex 太郎”,
kana: “フレックス タロウ”,
employee_no: “12345”,
mail: “support@flex-crm.com”,
status: “1”,
del_flg: “0”,
login_date: “2019-04-02 12:00:00”,
last_login_date: “2019-04-01 16:00:00”,
access_time: “2019-04-02 12:30:40”,
create_user_id: “1”,
update_user_id: “1”,
update_date_for_user: “2019-03-20 13:30:30”,
update_date: “2019-01-10 09:15:15”,
create_date: “2019-01-05 09:00:00”,
}
…
GET https://flex-crm.com/flex/api/v1/user?limit=5&offset=10
{
status: “success”,
limit: 5,
offset: 10,
count: 5,
maxCount: 1000,
data: [
{
id: “5”,
userid: “flex5”,
name: “Flex 五郎”,
kana: “フレックス ゴロウ”,
employee_no: “55555”,
mail: “support@flex-crm.com”,
status: “1”,
del_flg: “0”,
login_date: “2019-04-02 12:00:00”,
last_login_date: “2019-04-01 16:00:00”,
access_time: “2019-04-02 12:30:40”,
create_user_id: “1”,
update_user_id: “1”,
update_date_for_user: “2019-03-20 13:30:30”,
update_date: “2019-01-10 09:15:15”,
create_date: “2019-01-05 09:00:00”,
}
…
GET https://flex-crm.com/flex/api/v1/user?userid=flex
検索値にはURLエンコードが必要となります。
{
status: “success”,
limit: 100,
offset: 0,
count: 1,
maxCount: 1,
data: [
{
id: “1”,
userid: “flex”,
name: “Flex 太郎”,
kana: “フレックス タロウ”,
employee_no: “12345”,
mail: “support@flex-crm.com”,
status: “1”,
del_flg: “0”,
login_date: “2019-04-02 12:00:00”,
last_login_date: “2019-04-01 16:00:00”,
access_time: “2019-04-02 12:30:40”,
create_user_id: “1”,
update_user_id: “1”,
update_date_for_user: “2019-03-20 13:30:30”,
update_date: “2019-01-10 09:15:15”,
create_date: “2019-01-05 09:00:00”,
}
}