Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Willo Participants API

Candidates invited to an interview - no download, login, or authentication required.

Willo Participants API is one of 9 APIs that Willo publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Participants. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 8 operations across 4 paths, and defines 6 schemas. It is described by OpenAPI 3.0.3, at version 2.0.

Requests are made against 2 base URLs: https://api.willotalent.com/api/integrations/v2, https://api.stage.willotalent.com/api/integrations/v2.

8 operations 4 paths 6 schemas 1 DELETE4 GET1 PATCH1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
2.0
Base URL
https://api.willotalent.com/api/integrations/v2
Authentication
API Key
Contact
Terms of Service
Resource Areas
1

Authentication & Security 1

Willo Participants API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (apiKeyAuth). By default, every request must be authenticated.

  • apiKeyAuth — The integration key ("API key") available on the Willo Integrations page at https://app.willotalent.com/integrations, sent in the Authorization header. Each us…

Paths & Operations 8

Across 4 paths, the API surfaces 8 operations — 1 DELETE, 4 GET, 1 PATCH, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Participants 8

Candidates invited to an interview - no download, login, or authentication required.

GET
/participants/
List Participants
listParticipants → 200401
POST
/participants/
Invite Participant
inviteParticipant body → 201400401
GET
/participants/{key}/
Participant Details
getParticipant 1 param → 200401404
PUT
/participants/{key}/
Update Participant (PUT)
replaceParticipant 1 param body → 200401404
PATCH
/participants/{key}/
Update Participant (PATCH)
updateParticipant 1 param body → 200401404
DELETE
/participants/{key}/
Delete Participant
deleteParticipant 1 param → 204401404
GET
/participants/{key}/idv-info/
Participant Identity Verification Details
getParticipantIdvInfo 1 param → 200401404
GET
/participants/{key}/idv-media/
Participant Identity Verification Media
getParticipantIdvMedia 1 param → 200401404

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are Participant (9 properties), ParticipantInput (6 properties), Response (4 properties), IdvInfo (3 properties). Each schema is shown below with its type and property counts.

ParticipantInput
object
6 properties 1 required
IdvInfo
object
Identity-verification result and metadata for a participant.
3 properties
IdvMedia
object
References to identity-verification media captured for a participant.
1 property
Error
object
1 property
Response
object
A participant's answer to a single interview question.
4 properties
Participant
object
A candidate invited to an interview.
9 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

willo-participants-api-openapi.yml Raw ↑

Other APIs Willo publishes across the network.

Willo Child Organisations API
Willo Departments API
Willo Interview Templates API
Willo Interviews API
Willo Message Templates API
Willo Reference API
Willo Users API
Willo Webhooks API