Skip to main content
GET
/
api
/
ReferenceCheck
/
GetByActivityId
/
{activityId}
Retrieve a single Reference Check.
curl --request GET \
  --url https://api.example.com/api/ReferenceCheck/GetByActivityId/{activityId}
{
  "id": 123,
  "candidateId": 123,
  "customerId": 123,
  "createdDate": "2023-11-07T05:31:56Z",
  "completedDate": "2023-11-07T05:31:56Z",
  "templateId": 123,
  "json": "<string>",
  "token": "<string>",
  "refereeIpAddress": "<string>",
  "refereeUserAgent": "<string>",
  "isDigital": true,
  "activityId": 123,
  "isCompleted": true,
  "referenceCheckRequestId": 123,
  "refereeContactId": 123,
  "userId": 123,
  "followUpActivityId": 123,
  "reviewed": true,
  "candidatePosition": "<string>",
  "organization": "<string>",
  "positionStartDate": "<string>",
  "positionEndDate": "<string>",
  "jobId": 123,
  "isCancelled": true
}

Path Parameters

activityId
integer<int32>
required

Response

200 - application/json

OK

id
integer<int32>
candidateId
integer<int32>
customerId
integer<int32>
createdDate
string<date-time>
completedDate
string<date-time> | null
templateId
integer<int32>
json
string | null
token
string | null
refereeIpAddress
string | null
refereeUserAgent
string | null
isDigital
boolean
activityId
integer<int32>
isCompleted
boolean
referenceCheckRequestId
integer<int32> | null
refereeContactId
integer<int32> | null
userId
integer<int32> | null
followUpActivityId
integer<int32> | null
reviewed
boolean
candidatePosition
string | null
organization
string | null
positionStartDate
string | null
positionEndDate
string | null
jobId
integer<int32> | null
isCancelled
boolean