Skip to main content
GET
/
api
/
Submissions
/
{submissionId}
Retrieve a single Submission.
curl --request GET \
  --url https://api.example.com/api/Submissions/{submissionId}
{
  "id": 123,
  "publicSubmissionID": "<string>",
  "submissionGroupID": "<string>",
  "agencyID": 123,
  "userID": 123,
  "userName": "<string>",
  "clientID": 123,
  "clientName": "<string>",
  "jobID": 123,
  "jobName": "<string>",
  "jobClientReference": "<string>",
  "candidateID": 123,
  "candidateName": "<string>",
  "jobTitle": "<string>",
  "createdDate": "2023-11-07T05:31:56Z",
  "documentID": 123,
  "typeId": 1,
  "typeName": "<string>",
  "videoLink": "<string>",
  "clientRate": "<string>",
  "candidateRate": "<string>",
  "availability": "<string>",
  "comments": "<string>",
  "candidateComments": "<string>",
  "candidateEmail": "<string>",
  "submissionEmail": "<string>",
  "submissionEmailSubject": "<string>",
  "candidateEmailAddress": "<string>",
  "viewed": true,
  "views": 123,
  "feedback": 123,
  "ratingID": 123,
  "rating": "<string>",
  "statusID": 123,
  "statusName": "<string>",
  "clientDistributionModeID": 0,
  "clientDistributionModeName": "<string>",
  "candidateNotificationSent": true,
  "recipientsData": [
    {
      "id": 123,
      "name": "<string>"
    }
  ],
  "statisticsCounts": [
    {
      "type": "<string>",
      "value": 123
    }
  ],
  "statisticsDates": [
    {
      "type": "<string>",
      "value": "2023-11-07T05:31:56Z"
    }
  ]
}

Path Parameters

submissionId
integer<int32>
required

Response

200 - application/json

OK

id
integer<int32>
publicSubmissionID
string | null
submissionGroupID
string | null
agencyID
integer<int32>
userID
integer<int32>
userName
string | null
clientID
integer<int32>
clientName
string | null
jobID
integer<int32>
jobName
string | null
jobClientReference
string | null
candidateID
integer<int32>
candidateName
string | null
jobTitle
string | null
createdDate
string<date-time>
documentID
integer<int32>
typeId
enum<integer>
Available options:
1,
2
typeName
string | null
clientRate
string | null
candidateRate
string | null
availability
string | null
comments
string | null
candidateComments
string | null
candidateEmail
string | null
submissionEmail
string | null
submissionEmailSubject
string | null
candidateEmailAddress
string | null
viewed
boolean

true = at least one Recipient has viewed the submission ( See System Notes for details on which Recipient has viewed + when )

views
integer<int32>
feedback
integer<int32>
ratingID
integer<int32>

Green = 1, Orange = 2, Red = 3

rating
string | null
statusID
integer<int32>

1 = Open, 2 = Closed

statusName
string | null
clientDistributionModeID
enum<integer>
Available options:
0,
1,
2,
3
clientDistributionModeName
string | null
candidateNotificationSent
boolean
recipientsData
object[] | null
statisticsCounts
object[] | null
statisticsDates
object[] | null