API Reference

Use this section to explore the public NTRVSTA API for creating reusable interview templates, sending invitations, polling results, and integrating event-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.

What you can do

• Create and manage reusable interview templates
• Send or reuse candidate interview invitations
• Poll completed interview results
• Authenticate with API keys or bearer-style credentials
• Connect webhook-based follow-up flows

Start here

• Authentication & First Request
• Webhooks

Endpoint Groups

Templates

Reusable interview configurations for your organization.

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

Interview Invitations

Create or reuse candidate interview invitations for a selected template.

• Create interview invitation

Results

Poll completed interview results for downstream workflows.

• Get interview result

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

The OpenAPI document uses an environment-specific ntrvstaExternalApi server. In the reference UI, the default value is shown as an example API Gateway host and stage:

https://example.execute-api.us-east-1.amazonaws.com/dev

Replace that with the real external API base URL for your target environment when testing requests from the docs portal.