Skip to main content
受講生一覧取得
GET

Authorizations

Authorization
string
header
required

APIキーをBearerトークンとして指定

Path Parameters

site_id
string
required

会員サイトID

Query Parameters

date_from
string

追加日の開始日(YYYY-MM-DD)。形式が不正な場合は 422(validation_error)

date_to
string

追加日の終了日(YYYY-MM-DD。当日を含む)。形式が不正な場合は 422(validation_error)

name
string

名前で部分一致検索

nickname
string

ニックネームで部分一致検索

mail
string

メールアドレスで部分一致検索

page
integer

ページ番号

Required range: x >= 1
per_page
integer
default:20

1ページあたりの件数(既定20・最大100。超過時は100に丸められます)

Required range: 1 <= x <= 100

Response

受講生一覧

data
object[]
meta
object