API Reference

Use this section to integrate with the public NTRVSTA API for reusable templates, candidate invitations, completed results, and webhook-driven workflows.

The public partner API is versioned under /v1. API-key and webhook administration stay in the main NTRVSTA product, while the routes documented here are intended for external recruiting and interview integrations.

This partner-facing REST surface is hosted separately as ntrvstaExternalApi, so the base URL depends on the environment you are integrating against.

Recommended Integration Flow

Most integrations follow this order:

1. Authenticate with your organization API key
2. Create or reuse a reusable interview template
3. Create or reuse a candidate interview invitation
4. Receive result.completed via webhooks or poll GET /v1/interview-results

If you are building an event-driven integration, prefer webhooks for result delivery and use polling as a recovery or reconciliation path.

Start Here

• Authentication & First Request
• Webhooks

Common Use Cases

• Create a reusable interview template for a job or external posting
• Send candidate invitations from your ATS or recruiting workflow
• Reconcile completed interview outcomes back into your system
• Trigger follow-up automation when a result becomes available

Endpoint Groups

Templates

Create and manage the reusable interview configuration that invitations will use.

• Create template
• List templates
• Get template
• Update template

Interview Invitations

Create or reuse candidate invitations for a selected reusable template.

• Create interview invitation

Interview Results

Fetch the final interview result when you need a pull-based workflow or a webhook fallback.

• Get interview results

Polling returns a minimal summary (resultUrl and overallScore). For the full payload — including candidate identity, template, interview timing, and the aiAnalysis.scoring block — receive result.completed via webhooks instead. See the Webhooks guide for the complete event shape.

Authentication

All /v1/* endpoints authenticate per organization using an external API key. Clients may send the key with either:

• X-Ntrvsta-Api-Key
• Authorization: Bearer <key>

The public prefix is used for lookup, and the full key hash is verified server-side.

Base URL

All API requests use the public base URL shown in the reference UI:

https://partners.ntrvsta.com

Each operation's path is prefixed automatically (e.g., POST /v1/templates). You can override the server base in the reference playground to target a different environment if needed, such as https://partners-staging.ntrvsta.com.