GET api/Prospect

Authorization

Access to this endpoint is public.

Request Information

URI Parameters

None.

Body Parameters

PearsonEnglish.LearningServices.Data.Models.Prospects.ProspectFilterParameters
NameDescriptionTypeAdditional information
CenterId

globally unique identifier

None.

SortInfo

SortInfoOfPearsonEnglish.LearningServices.Data.Models.Prospects.Prospect

None.

PaginationInfo

PearsonEnglish.LearningServices.Core.Models.PaginationInfo

None.

SearchPhrase

string

None.

CompanyId

globally unique identifier

None.

IsPlacementTestCompleted

boolean

None.

RegisteredFrom

date

None.

RegisteredUntil

date

None.

Request Formats

application/json, text/json

Sample:
{
  "CenterId": "7e30478a-52b2-4754-a2a9-12ffc326e637",
  "SortInfo": {
    "SortBy": "sample string 1",
    "Direction": 0
  },
  "PaginationInfo": {
    "Count": 1,
    "Offset": 2
  },
  "SearchPhrase": "sample string 2",
  "CompanyId": "d8111627-9b02-4aba-8599-807dc03e4c58",
  "IsPlacementTestCompleted": true,
  "RegisteredFrom": "2026-02-09T12:24:06.5988459+00:00",
  "RegisteredUntil": "2026-02-09T12:24:06.5988459+00:00"
}

Response Information

Resource Description

PagedCollectionOfPearsonEnglish.LearningServices.Wse.Models.Prospects.ProspectListItem
NameDescriptionTypeAdditional information
TotalItemCount

integer

None.

Elements

Collection of PearsonEnglish.LearningServices.Wse.Models.Prospects.ProspectListItem

None.

Response Formats

application/json, text/json

Sample:

Sample not available.