Get For Project

GET

/api/v1/learners/project/{project_id}

curl --request GET \
  --url 'https://example.com/api/v1/learners/project/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0?order_by=created_at&order_by_direction=ASC&limit=100&offset=0' \
  --header 'Authorization: Bearer <token>'

Authorizations

• HTTPBearer

Parameters

Path Parameters

project_id

required

Project Id

string format: uuid

Query Parameters

order_by

Order By

string

default: created_at

order_by_direction

SortDirection

string

default: DESC

Allowed values: ASC DESC

limit

Limit

integer

default: 100 > 0 < 101

offset

Offset

integer

0

Responses

200

Successful Response

Media typeapplication/json

HeaderPaginatedResponse[PublicLearnerSchema]

object

status

JSendStatus

string

default: success

Allowed values: success fail error

message

Message

string

default: OK.

code

Code

string

default: 200

data

required

Data

Array<object>

PublicLearnerSchema

Public schema to represent the learner

object

id

required

Id

string format: uuid

created_at

required

Created At

string format: date-time

updated_at

required

Updated At

string format: date-time

user_id

required

User Id

string

package

required

ProjectPackage

string

Allowed values: QUANTUM_DISCOVERY QUANTUM_DISCOVERY_CHEMISTRY QUANTUM_DISCOVERY_LIGHT QUANTUM_DISCOVERY_PLAY QUANTUM_DISCOVERY_ESSENTIAL LEARN_BY_CODING VQPU

progress

Any of:

object

object

key

additional properties

StageType

object

stage

required

ProgressStage

Enumeration of progress types

string

Allowed values: DONE SKIP IN_PROGRESS

timecode

required

Any of:

integer

integer

null

null

null

null

pagination

required

JSendPagination

Pagination information

object

total

required

Total

integer

start

required

Start

integer

end

required

End

integer

Example

{
  "status": "success",
  "message": "OK.",
  "code": "200",
  "data": [
    {
      "package": "QUANTUM_DISCOVERY",
      "progress": {
        "additionalProperty": {
          "stage": "DONE"
        }
      }
    }
  ]
}

422

Validation Error

Media typeapplication/json

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

Example^generated

{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}