Skip to main content
GET
/
partner
/
{partner_id}
/
classes
/
{class_id}
/
invite-codes
강의별 초대코드 조회
curl --request GET \
  --url https://api.example.com/partner/{partner_id}/classes/{class_id}/invite-codes \
  --header 'Authorization: Bearer <token>'
{
  "items": [
    {
      "id": 123,
      "partner_id": 123,
      "class_id": 123,
      "code": "<string>",
      "target_role": "<string>",
      "used_count": 123,
      "status": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "expires_at": "2023-11-07T05:31:56Z",
      "max_uses": 123,
      "created_by": 123
    }
  ],
  "total": 123,
  "page": 123,
  "size": 123
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

partner_id
integer
required

강사 ID

class_id
integer
required
Required range: x >= 1

Query Parameters

active_only
boolean | null

True일 경우 활성(미만료) 코드만 필터링

limit
integer
default:50
Required range: 1 <= x <= 100
offset
integer
default:0
Required range: x >= 0

Response

Successful Response

items
InviteCodeResponse · object[]
required
total
integer
required
page
integer
required
size
integer
required