アカウントリストを取得

条件に基づいてアカウント情報の一覧を取得します。 フィルタリング条件やページネーションを利用して、複数のアカウント情報を取得することができます。

Query Parameters

• baseDate date-time

  フィルタリングする履歴の基準日

• roleTypeId any

  アカウントのロールタイプID

• accountCode string

  フィルタリングするアカウントのコード

• limit integer

  Default value: 100

  取得するレコード数の上限

• offset integer

  ページネーションのオフセット

Responses

• 200

---

アカウントリストのレスポンス

application/json

• Schema
• Example (from schema)

---

Schema

• results object[]

  アカウントのリスト

  Array [

  accountId string

  アカウントの一意のID(UUID)

  accountCode string

  アカウントのコード

  departmentId string

  アカウントの所属部門ID

  roleTypeId RoleTypeId

  Possible values: [OPERATOR, CUSTOMER, SUPPLIER]

  アカウントのロールタイプID

  roleId string

  アカウントのロールID

  accountName string

  アカウントの名前

  accountKana string

  アカウントのカナ表記

  supplierId string

  アカウントの業者ID

  responsibleOperatorAccountId string

  担当する自社従業員アカウントのアカウントID

  email string

  アカウントのメールアドレス

  phoneNumber string

  アカウントの電話番号

  isDeleted boolean

  アカウントが無効かどうかのフラグ

  startDate date

  アカウントの履歴開始日

  endDate date

  アカウントの履歴終了日

  ]

{
  "results": [
    {
      "accountId": "string",
      "accountCode": "string",
      "departmentId": "string",
      "roleId": "string",
      "accountName": "string",
      "accountKana": "string",
      "supplierId": "string",
      "responsibleOperatorAccountId": "string",
      "email": "string",
      "phoneNumber": "string",
      "isDeleted": true,
      "startDate": "2025-03-27",
      "endDate": "2025-03-27"
    }
  ]
}

Loading...