;

Retrieve Test Link

Get a particular test link associated with particular test in your account
GET https://apiv3.interviewmocha.com/v3/tests/{testId}/testlinks/{testLinkId}
  • Docs
  • Try it
Request URL Parameters
Field Type Required Default
testId Integer64 Yes -
testLinkId Integer64 Yes -
Response
Field Type Description
testLinkId Integer64 Unique Identifier for each test link
testId Integer64 Unique identifier given to each test
testLinkName String Name of test link
testLinkStatus String Gives status of given test link as active or inactive
testLink String Unique identifier that is used to access assessment of test platform.
proctoringSettings.proctoringMode String Supported mode - disabled, image, video
stakeholderEmails String Comma separated list of emails used to send stakeholders email after candidate test completion
invitationType String Type of invitation link - email or open
invitationSchedule object properties
scheduleType String Represent scheduleType set for current link. Possible value are validityindays, timebound, slotwise
scheduleDetails Contains invitation access time settings for validityindays, timebound, slotwise scheduletypes
invitationSchedule.scheduleDetails object properties
startDateTime String Start datetime in UTC ISO 8601 Format Example: "2020-06-11T16:00:00Z" Format: YYYY-MM-ddTHH:mm:ssZ
endDateTime String End datetime in UTC ISO 8601 Format Example: "2020-06-20T16:00:00Z" Format: YYYY-MM-ddTHH:mm:ssZg
timeZoneId Integer Timezone id in which invitation will be accessed.
invitationValidityInDays Integer Used when scheduleType set to validityindays value.
Example API endpoint

URL 1: /v3/tests/303076/testlinks/201044

Successful response

Status 200 OK

Response
{ "testLinkId": 201044, "testId": 303076, "testLinkName": "Email Invite", "testLink": "db682a", "testLinkStatus": "active", "invitationType": "open", "isApiLink": false, "proctoringSettings": { "proctoringMode": "disabled" }, "stakeholderEmails": "example@example.com", "invitationSchedule": { "scheduleType": "timebound", "scheduleDetails": { "startDateTime": "2019-10-23T06:28:00Z", "endDateTime": "2019-10-31T06:28:00Z", "timeZoneId": 1720 } } }
Failed response

Status 403 Forbidden

If required test id does not belong to your account.

Response
{ "statusCode": 403, "message": "You do not have permission to access resource" }
Parameter Value Description Parameter Type Data Type
testId test Id associated with particular test Query Integer64
testLinkId Unique Test Link Id associated with particular test Query Integer64
  • Response Body