Theme switcher

Submissions

Header Parameters

Content-Typestring
Authorizationstring

Query Parameters

jobIdstring Required

Filters submissions by job ID. These IDs can be retrieved from the getJobPostingsList endpoint.

jobSeekerIdstring

Filters submissions by applicant ID. These IDs can be retrieved from the getApplicantsList endpoint.

fromDatedate (mm-dd-yyyy)

Start date for date range filtering. Must be used with filter parameter

toDatedate (mm-dd-yyyy)

End date for date range filtering. Must be used with filter parameter

modifiedBeforestring

Filters submissions based on the date they were last modified. Only submissions that were modified before the specified date and time will be returnedExample: modifiedBefore=2025-06-10 00:00:00

When both modifiedAfter and modifiedBefore are used, the API will return submissions that were modified within the specified date range.

Example: modifiedBefore=2025-06-10 00:00:00&modifiedAfter=2025-05-08 00:00:00

modifiedAfterstring

Filters submissions based on the date they were last modified. Only submissions that were modified after the specified date and time will be returnedExample: modifiedAfter=2025-06-10 00:00:00

When both modifiedAfter and modifiedBefore are used, the API will return submissions that were modified within the specified date range.

Example: modifiedBefore=2025-06-10 00:00:00&modifiedAfter=2025-05-08 00:00:00

limitinteger

Number of submissions to return per page. Must be between 5 and 50

sortBystring

Determines the sorting direction, where desc applies descending order and asc applies ascending order; defaults to descending if not specified (e.g., sortBy=id&sortOrder=asc).

sortOrderstring

Specifies the field used to sort results; accepts only supported fields per endpoint and defaults to a predefined field if not provided (e.g., sortBy=id&sortOrder=asc). Supports sorting by id, modified, applied_at; defaults to descending order on id.

businessUnitIdstring

Filters submissions by business unit IDs. These IDs can be retrieved from the getBusinessUnitsList endpoint.

createdBystring

Filters submissions by user ID. These IDs can be retrieved from the getUsersList endpoint.

filterstring

Specifies whether to filter by creation date (applied_at) or modification date when using fromDate/toDate

submissionIdinteger

Filters submissions by submission ID. These IDs can be retrieved from the getSubmissionsList endpoint.

submittedBystring

Filters submissions by user ID. These IDs can be retrieved from the getUsersList endpoint.

submittedAgoDaysinteger

Filters submissions submitted within the last N days. Common values: 1 (today), 2 (yesterday), 3 (last 3 days), 7 (last week), 14 (last 2 weeks), 30 (last month)

Response

200
Object

Response Attributes

idstring
job_seeker_idstring
submission_idnumber
tax_termstring
modifiedstring
pipeline_statusstring
sourcestring
resumestring
submitted_bystring
business_unit_idnumber
currency_codestring
tagged_bystring
tagged_onstring
selected_submission_documentsstring
merged_pdf_documentstring
merge_document_pathstring
applicant_idnumber
pay_ratestring
Documentsarray

Show child attributes

job_idstring
employment_typestring
submitted_onstring
submission_statusstring
401
Object
Please provide the access token.
403
Object
Your company access is temporarily disabled.
404
Object
Data not found.
429
Object
Request limit exceeded. Please try again later.
400
Object
Invalid parameters or filters.
Was this section helpful?

What made this section helpful for you?

What made this section unhelpful for you?

GET

/

Select
1

Response

Was this section helpful?

What made this section helpful for you?

What made this section unhelpful for you?