Get Invite

Get invite details

curl --request GET \
  --url https://alfaone.app/api/v1/invites/{inviteId} \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://alfaone.app/api/v1/invites/{inviteId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://alfaone.app/api/v1/invites/{inviteId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://alfaone.app/api/v1/invites/{inviteId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://alfaone.app/api/v1/invites/{inviteId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "assessmentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "assessmentName": "<string>",
  "recipientEmail": "jsmith@example.com",
  "recipientName": "<string>",
  "status": "pending",
  "questionReplayLimit": 123,
  "answerRecordLimit": 123,
  "sentAt": "2023-11-07T05:31:56Z",
  "expiresAt": "2023-11-07T05:31:56Z",
  "acceptedAt": "2023-11-07T05:31:56Z",
  "startedAt": "2023-11-07T05:31:56Z",
  "completedAt": "2023-11-07T05:31:56Z",
  "assignedGrader": {
    "id": "<string>",
    "firstName": "<string>",
    "lastName": "<string>",
    "email": "jsmith@example.com"
  },
  "proctoringSettings": {
    "screenRecording": true,
    "webcamMonitoring": true,
    "requireIdCapture": true
  },
  "customMessage": "<string>",
  "revokedAt": "2023-11-07T05:31:56Z"
}

GET

invites

{inviteId}

Get invite details

curl --request GET \
  --url https://alfaone.app/api/v1/invites/{inviteId} \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://alfaone.app/api/v1/invites/{inviteId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://alfaone.app/api/v1/invites/{inviteId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://alfaone.app/api/v1/invites/{inviteId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://alfaone.app/api/v1/invites/{inviteId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "assessmentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "assessmentName": "<string>",
  "recipientEmail": "jsmith@example.com",
  "recipientName": "<string>",
  "status": "pending",
  "questionReplayLimit": 123,
  "answerRecordLimit": 123,
  "sentAt": "2023-11-07T05:31:56Z",
  "expiresAt": "2023-11-07T05:31:56Z",
  "acceptedAt": "2023-11-07T05:31:56Z",
  "startedAt": "2023-11-07T05:31:56Z",
  "completedAt": "2023-11-07T05:31:56Z",
  "assignedGrader": {
    "id": "<string>",
    "firstName": "<string>",
    "lastName": "<string>",
    "email": "jsmith@example.com"
  },
  "proctoringSettings": {
    "screenRecording": true,
    "webcamMonitoring": true,
    "requireIdCapture": true
  },
  "customMessage": "<string>",
  "revokedAt": "2023-11-07T05:31:56Z"
}

Authorizations

x-api-key

string

header

required

API key for authentication. Format: ak_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Path Parameters

inviteId

string<uuid>

required

Unique identifier of the invite

Response

Successful response

string<uuid>

Unique identifier of the invite

assessmentId

string<uuid>

ID of the assessment

assessmentName

string

Name of the assessment

recipientEmail

string<email>

Email address of the invited candidate

recipientName

string | null

Name of the invited candidate

status

enum<string>

Current status of the invite

Available options:

pending,

accepted,

started,

completed,

expired,

revoked

questionReplayLimit

integer

Maximum number of times a candidate can replay each question

answerRecordLimit

integer

Maximum number of recording attempts per answer

sentAt

string<date-time>

When the invite was sent

expiresAt

string<date-time>

When the invite expires

acceptedAt

string<date-time> | null

When the invite was accepted

startedAt

string<date-time> | null

When the candidate started the assessment

completedAt

string<date-time> | null

When the candidate completed the assessment

assignedGrader

object | null

Grader assigned to review this candidate's submission

Show child attributes

proctoringSettings

object

Proctoring configuration for this invite

Show child attributes

customMessage

string | null

Custom message included with the invite

revokedAt

string<date-time> | null

When the invite was revoked (if applicable)

API Reference

Assessments

Members

Invites

Tags

Authorizations

Path Parameters

Response