ユーザーの一覧

GET /users

ユーザーの一覧を取得するには、/api/usersエンドポイントにGETリクエストを送信します。

リクエスト:ヘッダー

Name
Value

Content-Type

application/json

Authorization

Basic <認証情報>

認証情報について

認証情報は、ユーザーのEメールアドレスとAPIキーをコロンで連結したものをBase64エンコードしたものです。

クエリ パラメータ

Name
Type
説明
デフォルト値
必須

page

integer

ページ番号

1

items_per_page

integer

1ページあたりの表示数

10

user_type

string

ユーザータイプ (A:管理者, C:お客様)

C

レスポンス

{
  "users": [
    {
      "user_id": "3",
      "user_login": "customer",
      "is_root": "N",
      "timestamp": "1576988370",
      "user_type": "C",
      "status": "A",
      "firstname": "鈴木",
      "lastname": "一郎",
      "email": "[email protected]",
      "company": "Simtech",
      "company_id": "1",
      "phone": "77 77 777 7777",
      "company_name": "CS-Cart.jp"
    }
  ],
  "params": {
    "page": 2,
    "items_per_page": 1,
    "extended_search": true,
    "sort_order": "asc",
    "sort_by": "name",
    "sort_order_rev": "desc",
    "total_items": "2"
  }
}

最終更新