HRMS · Recruiting & Onboarding
Interviews
Who is being seen, by whom, when, and what came of it. A round with no feedback is a meeting nobody can act on, which is why the outcome sits on the row.
/api/hrms/interviewsPublished as /api/v1/interviewsOverview
| Package | HRMS |
|---|---|
| Authentication | Bearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key |
| Authorization | The caller's roles must hold HRMS › Interviews on the Roles screen: display for GET, add for POST, change for PUT, delete for DELETE; an action needs the grant of the button that runs it on the screen. |
| Table | hr.interviews · kept per company (and organisational unit where it has one) |
| Record | Created, changed and (where the screen allows) deleted; key id |
| Rules | The same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail. |
API reference
22 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/hrms/interviewsList interviews
Query parameters
| Name | Description | Example |
|---|---|---|
limit | Rows per page (50 by default, at most 200) | limit=100 |
offset | Rows to skip | offset=200 |
q | Free-text search over the search columns | q=acme |
sort | column:asc or column:desc, several separated by commas | sort=created_at:desc |
filter | A JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sorted | filter={"col":"status","op":"eq","value":"open"} |
<field>=<value> | Shorthand for "field is value" |
Response 200
{
"rows": [
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"application_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"round_no": 10,
"interview_type": "screening",
"scheduled_at": "2026-10-30T09:00:00Z",
"duration_minutes": 10,
"location": "text",
"meeting_url": "https://example.com",
"status": "scheduled",
"outcome": "strong_yes",
"average_score": "1250.00",
"created_at": "2026-10-30T09:00:00Z",
"created_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/hrms/interviews?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/hrms/interviews/{id}Read one interviews
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"application_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"round_no": 10,
"interview_type": "screening",
"scheduled_at": "2026-10-30T09:00:00Z",
"duration_minutes": 10,
"location": "text",
"meeting_url": "https://example.com",
"status": "scheduled",
"outcome": "strong_yes",
"average_score": "1250.00",
"created_at": "2026-10-30T09:00:00Z",
"created_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/hrms/interviews/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/hrms/interviewsCreate a interviews
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
application_id | uuid | Yes | Application |
round_no | integer | No | Round |
interview_type | text | No | Kind Allowed: screening phone technical panel behavioral case_study final informal assessment |
scheduled_at | timestamp with time zone | No | When |
duration_minutes | integer | No | Minutes |
location | text | No | Where |
meeting_url | text | No | Meeting link |
status | text | No | Status Allowed: scheduled completed cancelled no_show |
outcome | text | No | Outcome — An interview marked by a panel takes the panel’s outcome; to record a different one, use Override outcome and say why. Allowed: strong_yes yes no strong_no no_decision |
Sample body
{
"application_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"round_no": 10,
"interview_type": "screening",
"scheduled_at": "2026-10-30T09:00:00Z",
"duration_minutes": 10
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"application_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"round_no": 10,
"interview_type": "screening",
"scheduled_at": "2026-10-30T09:00:00Z",
"duration_minutes": 10,
"location": "text",
"meeting_url": "https://example.com",
"status": "scheduled",
"outcome": "strong_yes",
"average_score": "1250.00",
"created_at": "2026-10-30T09:00:00Z",
"created_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}Sample request
curl -X POST "https://demo.tranxact.ai/api/hrms/interviews" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"application_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","round_no":10,"interview_type":"screening","scheduled_at":"2026-10-30T09:00:00Z","duration_minutes":10}'PUT/api/hrms/interviews/{id}Change a interviews
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
Only the fields to change; fields left out keep their value.
| Field | Type | Required | Description |
|---|---|---|---|
application_id | uuid | Yes | Application |
round_no | integer | No | Round |
interview_type | text | No | Kind Allowed: screening phone technical panel behavioral case_study final informal assessment |
scheduled_at | timestamp with time zone | No | When |
duration_minutes | integer | No | Minutes |
location | text | No | Where |
meeting_url | text | No | Meeting link |
status | text | No | Status Allowed: scheduled completed cancelled no_show |
outcome | text | No | Outcome — An interview marked by a panel takes the panel’s outcome; to record a different one, use Override outcome and say why. Allowed: strong_yes yes no strong_no no_decision |
Sample body
{
"application_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"round_no": 10
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"application_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"round_no": 10,
"interview_type": "screening",
"scheduled_at": "2026-10-30T09:00:00Z",
"duration_minutes": 10,
"location": "text",
"meeting_url": "https://example.com",
"status": "scheduled",
"outcome": "strong_yes",
"average_score": "1250.00",
"created_at": "2026-10-30T09:00:00Z",
"created_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/hrms/interviews/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"application_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","round_no":10}'DELETE/api/hrms/interviews/{id}Delete a interviews
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response 200
{ "deleted": true }Many documents are cancelled or reversed instead; the API refuses a delete the screen would refuse.
Sample request
curl -X DELETE "https://demo.tranxact.ai/api/hrms/interviews/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/hrms/interviews/{id}/calendar-inviteCalendar invite
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/hrms/interviews/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/calendar-invite" \
-H "Authorization: Bearer $TOKEN"POST/api/hrms/interviews/{id}/calendar-invite/cancelCalendar invite cancel
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/hrms/interviews/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/calendar-invite/cancel" \
-H "Authorization: Bearer $TOKEN"POST/api/hrms/interviews/{id}/set-panelSet panel
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
The keys this action reads (* = required; "one of" lists the only values):
aggregationRule, aggregation_rule, tieRule, tie_rule, passScore, pass_score, scorecardId, scorecard_id, replace; aggregationRule one of weighted_average|majority_recommendation|unanimous|min_score; tieRule one of chair_casting_vote|weighted_average|no_decision|reject; members: [{ employeeId, employee_id, userId, user_id, name, panelist_name, role, panel_role, weight, voting, isVoting, is_voting }]Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/hrms/interviews/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/set-panel" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"aggregationRule":"value","aggregation_rule":"value","tieRule":"value","tie_rule":"value","passScore":"value","pass_score":"value"}'GET/api/hrms/interviews/{id}/scorecardScorecard
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/hrms/interviews/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/scorecard" \
-H "Authorization: Bearer $TOKEN"POST/api/hrms/interviews/{id}/scoreScore
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
The keys this action reads (* = required; "one of" lists the only values):
panelistId, panelist_id, scores, recommendation, strengths, concerns, comments; recommendation one of strong_yes|yes|no|strong_no|no_decision; marks: [{ mark, criterionId, criterion_id, comment }]Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/hrms/interviews/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/score" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"panelistId":"value","panelist_id":"value","scores":"value","recommendation":"value","strengths":"value","concerns":"value"}'POST/api/hrms/interviews/{id}/outcomeOutcome
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
The keys this action reads (* = required; "one of" lists the only values):
reason, outcome; outcome one of strong_yes|yes|no|strong_no|no_decisionResponse
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/hrms/interviews/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/outcome" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"reason":"value","outcome;":"value"}'GET/api/hrms/interviews/{id}/feedbackFeedback
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/hrms/interviews/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/feedback" \
-H "Authorization: Bearer $TOKEN"POST/api/hrms/interviews/{id}/feedbackFeedback
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
The keys this action reads (* = required; "one of" lists the only values):
interviewerId, interviewerName, competency, score, recommendation*, strengths, concerns, comments; recommendation one of strong_yes|yes|no|strong_no|no_decisionResponse
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/hrms/interviews/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/feedback" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"interviewerId":"value","interviewerName":"value","competency":"value","score":"value","recommendation":"value","strengths":"value"}'POST/api/hrms/interviews/{id}/copyCopy
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
The keys this action reads (* = required; "one of" lists the only values):
overrides, preview, withLinesResponse
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/hrms/interviews/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"overrides":"value","preview":"value","withLines":"value"}'GET/api/hrms/interviews/{parentId}/panelPanel
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/hrms/interviews/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/panel" \
-H "Authorization: Bearer $TOKEN"POST/api/hrms/interviews/{parentId}/panelPanel
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/hrms/interviews/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/panel" \
-H "Authorization: Bearer $TOKEN"PUT/api/hrms/interviews/{parentId}/panel/{lineId}Panel
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
lineId | string (uuid) | The record's lineId, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X PUT "https://demo.tranxact.ai/api/hrms/interviews/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/panel/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"DELETE/api/hrms/interviews/{parentId}/panel/{lineId}Panel
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
lineId | string (uuid) | The record's lineId, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X DELETE "https://demo.tranxact.ai/api/hrms/interviews/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/panel/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"GET/api/hrms/interviews/{parentId}/criteriaCriteria
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/hrms/interviews/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/criteria" \
-H "Authorization: Bearer $TOKEN"POST/api/hrms/interviews/{parentId}/criteriaCriteria
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/hrms/interviews/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/criteria" \
-H "Authorization: Bearer $TOKEN"PUT/api/hrms/interviews/{parentId}/criteria/{lineId}Criteria
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
lineId | string (uuid) | The record's lineId, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X PUT "https://demo.tranxact.ai/api/hrms/interviews/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/criteria/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"DELETE/api/hrms/interviews/{parentId}/criteria/{lineId}Criteria
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
lineId | string (uuid) | The record's lineId, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X DELETE "https://demo.tranxact.ai/api/hrms/interviews/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/criteria/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"Data model
Every field of a interviews, as the API returns it. Field names are the JSON keys; any of them can be filtered and sorted on a list.
| Field | Type | Access | Description |
|---|---|---|---|
id | uuid | read only | Id |
org_id | uuid | read only | Org id |
application_id | uuid | read, write | Application |
round_no | integer | read, write | Round |
interview_type | text | read, write | Kind Allowed: screening phone technical panel behavioral case_study final informal assessment |
scheduled_at | timestamp with time zone | read, write | When |
duration_minutes | integer | read, write | Minutes |
location | text | read, write | Where |
meeting_url | text | read, write | Meeting link |
status | text | read, write | Status Allowed: scheduled completed cancelled no_show |
outcome | text | read, write | Outcome — An interview marked by a panel takes the panel’s outcome; to record a different one, use Override outcome and say why. Allowed: strong_yes yes no strong_no no_decision |
average_score | numeric | read only | Average score |
created_at | timestamp with time zone | read only | Created at |
created_by | uuid | read only | Created by |
org_unit_id | uuid | read only | Org unit id |
xf_text_1 | text | read only | Xf text 1 |
xf_text_2 | text | read only | Xf text 2 |
xf_text_3 | text | read only | Xf text 3 |
xf_text_4 | text | read only | Xf text 4 |
xf_text_5 | text | read only | Xf text 5 |
xf_num_1 | numeric | read only | Xf num 1 |
xf_num_2 | numeric | read only | Xf num 2 |
xf_num_3 | numeric | read only | Xf num 3 |
xf_date_1 | date | read only | Xf date 1 |
xf_date_2 | date | read only | Xf date 2 |
updated_at | timestamp with time zone | read only | Updated at |
updated_by | uuid | read only | Updated by |
scorecard_id | uuid | read only | Scorecard id |
aggregation_rule | text | read only | Aggregation rule |
pass_score | numeric | read only | Pass score |
tie_rule | text | read only | Tie rule |
panel_score | numeric | read only | Panel score |
panel_size | integer | read only | Panel size |
panel_submitted | integer | read only | Panel submitted |
votes_for | integer | read only | Votes for |
votes_against | integer | read only | Votes against |
derived_outcome | text | read only | Derived outcome |
outcome_basis | text | read only | Outcome basis |
outcome_overridden | boolean | read only | Outcome overridden |
outcome_override_reason | text | read only | Outcome override reason |
outcome_overridden_by | uuid | read only | Outcome overridden by |
outcome_overridden_at | timestamp with time zone | read only | Outcome overridden at |
Errors
| Status | Meaning |
|---|---|
| 400 | The request could not be read: a filter that is not JSON, a bad parameter |
| 401 | No credential, or it is wrong, revoked or expired |
| 403 | The caller's roles do not hold HRMS › Interviews for this verb, or the address or origin is not allowed |
| 404 | No record with that id is visible to the caller |
| 409 | A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else |
| 422 | Refused by the same validation as the screen; the error names the field and why |
Every error is JSON: {"error": "a sentence saying what was wrong"}, with field where it applies.