HackNotice icon

HackNotice

Call the HackNotice extensions API (alerts, assessments, and more)

Actions85

Assessment Invite → Get Invite by Code

AI-generated

Summary

Retrieve an assessment invite using its unique invite code from the HackNotice API.

Inputs

  • Document ID — Mongo-style document ID used in URL path for this call, not required for this operation.
  • Page Number — Zero-based page index for paginated endpoints, not used in this specific operation.
  • Invite Code (required) — The invite code uniquely identifying the assessment invite to retrieve.
  • Request Body — JSON body for POST and PUT endpoints; not applicable here, defaults to an empty object.

Output shape

a single record in JSON format representing the assessment invite associated with the given invite code.

The operation performs an HTTP GET request to the path /assessmentinvites/code/:inviteCode where :inviteCode is the provided invite code. No pagination or request body is needed or used. If the invite code parameter is missing, the node raises an error. The response is normalized into a JSON array with a single item and returned.

Examples

Example 1: Retrieve invite using a specific invite code

Set 'Resource' to 'Assessment Invite', 'Operation' to 'Get Invite by Code', and provide the required 'Invite Code' parameter with the invite code string.

Links

Discussion