Search Applications
Details#
This endpoint is used to search company Applications. It supports pagination and different search filters.
URL : /applications/company/search
Method :
Authentication
Auth is required an Admin to search applications.
Parameters#
limit#
Limits the number of applications returned.
offset#
Number of applications to skip.
companyName#
Filters the applications by the name of the respective companies.
state#
Array of strings which filters the application by their state.
caution
Must be a valid state (currently ["PENDING", "APPROVED", "REJECTED"]).
submissionDateFrom#
Filters the applications by their submission date, by removing the ones before the specified date.
submissionDateTo#
Filters the applications by their submission date, by removing the ones after the specified date.
sortBy#
String describing how the applications should be sorted.
The default is to sort by submittedAt descending.
caution
It must follow the following format: field:(desc|asc)?[,field:(desc|asc)?]*
Each field must be one of ["email", "password", "companyName", "motivation", "submittedAt", "approvedAt"
, "rejectedAt", "rejectReason"]
Response#
applications#
Array of objects containing the applications found by the search.
docCount#
Number of results found by the search.
Request examples#
Example 1 - No filters (Logged-in as Admin)#
Code :
- Request
- Response
Example 2 - With Filters (Logged-in as Admin)#
Code :
- Request
- Response
Example 3 - Logged-in as Company#
Code :
- Request
- Response
Example 4 - Invalid State#
Code :
- Request
- Response
Example 5 - Invalid SortBy field#
Code :
- Request
- Response
Example 6 - Invalid SortBy Format#
Code :
- Request
- Response