コンテンツにスキップ
スマレジ・プラットフォームAPI リファレンス

ユーザー一覧取得

GET
/linked_users
curl --request GET \
  --url 'https://api.smaregi.dev/TARGET-CONTRACT-ID/ec-b2b/linked_users?limit=10&page=1&sort=updatedAt%3Adesc&customer_id=12345678-1234-1234-1234-1234567890ab' \
  --header 'Authorization: Bearer <token>'

ユーザー情報の一覧を取得します。

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
limit
integer
default: 10 >= 1 <= 100

取得件数

page
integer
default: 1 >= 1

ページ

sort
string
default: updatedAt:desc
Allowed values: updatedAt updatedAt:desc

ソート

  • updatedAt: 更新日時
Example
updatedAt:desc
customer_id
string format: uuid

取引先IDで絞り込み

Example
12345678-1234-1234-1234-1234567890ab

Responses

Section titled “Responses”

200

Section titled “200”

取得成功

Media typeapplication/json
Array
LinkedUserResponse
object
id

ユーザーID

string format: uuid
customerId

取引先ID

string format: uuid
statusCode

ステータス

  • 1: 無効
  • 2: 仮登録
  • 3: 有効
integer
Allowed values: 1 2 3
department

部署名

null または空文字 "" を指定した場合は、値がクリア（null）されます。

string
nullable <= 255 characters
lastName

名前(姓)

string
>= 1 characters <= 50 characters
firstName

名前(名)

string
>= 1 characters <= 50 characters
lastNameFurigana

名前フリガナ(姓)

null または空文字 "" を指定した場合は、値がクリア（null）されます。

string
nullable <= 50 characters
firstNameFurigana

名前フリガナ(名)

null または空文字 "" を指定した場合は、値がクリア（null）されます。

string
nullable <= 50 characters
email

メールアドレス

null または空文字 "" を指定した場合は、値がクリア（null）されます。

string format: email
nullable <= 255 characters
loginIdentification

ログインID

使用可能文字: 半角英数字および @ # . _ + -

null または空文字 "" を指定した場合は、値がクリア（null）されます。

string
nullable <= 255 characters
invitationAt

招待日時[YYYY-MM-DDThh:mm:ssTZD]

string format: date-time
nullable
registrationAt

会員登録日時[YYYY-MM-DDThh:mm:ssTZD]

string format: date-time
nullable
canEmailMagazineReceipt

メルマガ受信

  • 0: 受け取らない
  • 1: 受け取る
integer
Allowed values: 0 1
canDmReceipt

DM受信

  • 0: 受け取らない
  • 1: 受け取る
integer
Allowed values: 0 1
isLineLink

LINE ID連携

  • 0: 未連携
  • 1: 連携済
integer
Allowed values: 0 1
permissionCode

権限

  • 1: 一般ユーザー
  • 2: 管理者
integer
Allowed values: 1 2
lastLoginAt

最終ログイン日時[YYYY-MM-DDThh:mm:ssTZD]

string format: date-time
nullable
updatedAt

更新日時：登録時・更新時の日時。[YYYY-MM-DDThh:mm:ssTZD]

string format: date-time
Examples
Exampledefault
[
  {
    "id": "aaaaaaaa-1234-1234-1234-1234567890ab",
    "customerId": "12345678-1234-1234-1234-1234567890ab",
    "statusCode": 3,
    "department": "営業部",
    "lastName": "すまれじ",
    "firstName": "太郎",
    "lastNameFurigana": "スマレジ",
    "firstNameFurigana": "タロウ",
    "email": "taro@example.com",
    "loginIdentification": "taro_smaregi",
    "invitationAt": "2025-06-02T03:03:33+09:00",
    "registrationAt": "2025-06-02T03:03:33+09:00",
    "canEmailMagazineReceipt": 1,
    "canDmReceipt": 1,
    "isLineLink": 0,
    "permissionCode": 1,
    "lastLoginAt": "2025-06-09T14:15:40+09:00",
    "updatedAt": "2025-06-09T14:15:40+09:00"
  },
  {
    "id": "bbbbbbbb-1234-1234-1234-1234567890ab",
    "customerId": "12345678-1234-1234-1234-1234567890ab",
    "statusCode": 3,
    "department": null,
    "lastName": "すまれじ",
    "firstName": "花子",
    "lastNameFurigana": "スマレジ",
    "firstNameFurigana": "ハナコ",
    "email": "hanako@example.com",
    "loginIdentification": null,
    "invitationAt": null,
    "registrationAt": null,
    "canEmailMagazineReceipt": 0,
    "canDmReceipt": 0,
    "isLineLink": 0,
    "permissionCode": 1,
    "lastLoginAt": null,
    "updatedAt": "2025-06-09T14:15:40+09:00"
  }
]

Headers

Section titled “Headers”
Link

<前ページURI>; rel="prev", <次ページURI>; rel="next"

string

400

Section titled “400”
  • 入力チェックエラーの場合
Media typeapplication/json
object
type
required
string
title
required
string
detail
string
status
integer
Examples
{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "request_json:[limit]は100以下の数字を指定してください。",
  "status": 400
}