Exit Interview

Get Exit Interviews

Lists the organisation's exit interviews, newest first.

GET

https://api.employmenthero.com/api/v1/organisations/:organisation_id/exit_interviews

Path Parameters

organisation_iduuidrequired

The ID of the organisation.

Query Parameters

statusesenum<string>[]

Only return exit interviews with any of these statuses. Omit to return exit interviews of every status.

page_indexnumber

Current page index

Default1

Min1

item_per_pagenumber

Number of items per page

Default20

Max100

Response Body

A paginated list of the organisation exit interviews, newest first. Items do not include questions. Use the get exit interview endpoint to retrieve them.

dataobject

itemsobject[]

iduuid

Unique identifier of the exit interview.

namestring

The name of the exit interview.

statusenum<string>

The status of the exit interview.

total_responsesinteger

The number of responses received.

start_atdatetime

The date and time the exit interview starts, in ISO 8601 format. Publishing sets it to the time of publishing.

authorobject

The member who created the exit interview.

membersobject[]

The members the exit interview is sent to.

created_atdatetime

The date and time the exit interview was created, in ISO 8601 format.

updated_atdatetime

The date and time the exit interview was last updated, in ISO 8601 format.

page_indexnumber

Current page index

Default1

Min1

item_per_pagenumber

Number of items per page

Default20

Max100

total_itemsnumber

Total items

total_pagesnumber

Total pages

Example

curl -X GET \  "https://api.employmenthero.com/api/v1/organisations/:organisation_id/exit_interviews" \  -H "Authorization: Bearer AUXJ3123xyrj123fdsjkl124aAJKQ"

Response

{  "data": {    "items": [      {        "id": "d6a0c7e2-3f41-4b8a-9c2e-5a1b7f8e9d01",        "name": "Q3 2027 leavers",        "status": "draft",        "total_responses": 0,        "start_at": "2027-06-01T00:00:00Z",        "author": {          "id": "6ddbfb24-8153-42a9-9248-c41c9b6c755e",          "full_name": "Jane Smith"        },        "members": [          {            "member_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",            "member_name": "Alex Chen"          }        ],        "created_at": "2027-05-20T01:00:00Z",        "updated_at": "2027-05-20T01:00:00Z"      }    ],    "page_index": 1,    "item_per_page": 20,    "total_items": 1,    "total_pages": 1  }}

Get Exit Interview

Retrieves a single exit interview by ID, including its questions.

GET

https://api.employmenthero.com/api/v1/organisations/:organisation_id/exit_interviews/:exit_interview_id

Path Parameters

organisation_iduuidrequired

The ID of the organisation.

exit_interview_iduuidrequired

The ID of the exit interview.

Response Body

The requested exit interview, including its questions in order.

dataobject

iduuid

Unique identifier of the exit interview.

namestring

The name of the exit interview.

statusenum<string>

The status of the exit interview.

total_responsesinteger

The number of responses received.

start_atdatetime

The date and time the exit interview starts, in ISO 8601 format. Publishing sets it to the time of publishing.

authorobject

The member who created the exit interview.

membersobject[]

The members the exit interview is sent to.

created_atdatetime

The date and time the exit interview was created, in ISO 8601 format.

updated_atdatetime

The date and time the exit interview was last updated, in ISO 8601 format.

questionsobject[]

The questions of the exit interview, in order.

Example

curl -X GET \  "https://api.employmenthero.com/api/v1/organisations/:organisation_id/exit_interviews/:exit_interview_id" \  -H "Authorization: Bearer AUXJ3123xyrj123fdsjkl124aAJKQ"

Response

{  "data": {    "id": "d6a0c7e2-3f41-4b8a-9c2e-5a1b7f8e9d01",    "name": "Q3 2027 leavers",    "status": "draft",    "total_responses": 0,    "start_at": "2027-06-01T00:00:00Z",    "author": {      "id": "6ddbfb24-8153-42a9-9248-c41c9b6c755e",      "full_name": "Jane Smith"    },    "members": [      {        "member_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",        "member_name": "Alex Chen"      }    ],    "created_at": "2027-05-20T01:00:00Z",    "updated_at": "2027-05-20T01:00:00Z",    "questions": [      {        "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",        "text": "What is the main reason you are leaving?",        "type": "text",        "order": 1      },      {        "id": "c3d4e5f6-a7b8-9012-cdef-123456789012",        "text": "How would you rate your manager?",        "type": "single_choice",        "order": 2,        "options": [          {            "id": "d4e5f6a7-b8c9-0123-def0-234567890123",            "value": "Excellent"          },          {            "id": "e5f6a7b8-c9d0-1234-ef01-345678901234",            "value": "Good"          }        ]      }    ]  }}

Create Exit Interview

Creates an exit interview in draft status. The status is always draft, even if another value is sent.

POST

https://api.employmenthero.com/api/v1/organisations/:organisation_id/exit_interviews

Path Parameters

organisation_iduuidrequired

The ID of the organisation.

Request Body

namestringrequired

The name of the exit interview. Cannot be blank.

member_idsuuid[]required

The IDs of the members to send the exit interview to. At least one ID is required. Each ID must belong to a member of the organisation. Duplicate IDs are removed. Unknown IDs return 422 and are listed in the error message.

start_atdatetimerequired

The date and time the exit interview starts, in ISO 8601 format, for example 2027-06-01T00:00:00Z.

questionsobject[]

The questions of the exit interview, in the order given. Optional. At least one question is required before the exit interview can be published.

Response Body

The newly created exit interview, with status draft. Returns HTTP 201 Created.

dataobject

iduuid

Unique identifier of the exit interview.

namestring

The name of the exit interview.

statusenum<string>

The status of the exit interview.

total_responsesinteger

The number of responses received.

start_atdatetime

The date and time the exit interview starts, in ISO 8601 format. Publishing sets it to the time of publishing.

authorobject

The member who created the exit interview.

membersobject[]

The members the exit interview is sent to.

created_atdatetime

The date and time the exit interview was created, in ISO 8601 format.

updated_atdatetime

The date and time the exit interview was last updated, in ISO 8601 format.

questionsobject[]

The questions of the exit interview, in order.

Example

curl -X POST \  "https://api.employmenthero.com/api/v1/organisations/:organisation_id/exit_interviews" \  -H "Authorization: Bearer AUXJ3123xyrj123fdsjkl124aAJKQ" \  -H "Content-Type: application/json" \  -d '{    "name": "Q3 2027 leavers",    "member_ids": [      "a1b2c3d4-e5f6-7890-abcd-ef1234567890"    ],    "start_at": "2027-06-01T00:00:00Z",    "questions": [      {        "text": "What is the main reason you are leaving?",        "type": "text"      },      {        "text": "How would you rate your manager?",        "type": "single_choice",        "options": [          "Excellent",          "Good"        ]      }    ]  }'

Response

{  "data": {    "id": "d6a0c7e2-3f41-4b8a-9c2e-5a1b7f8e9d01",    "name": "Q3 2027 leavers",    "status": "draft",    "total_responses": 0,    "start_at": "2027-06-01T00:00:00Z",    "author": {      "id": "6ddbfb24-8153-42a9-9248-c41c9b6c755e",      "full_name": "Jane Smith"    },    "members": [      {        "member_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",        "member_name": "Alex Chen"      }    ],    "created_at": "2027-05-20T01:00:00Z",    "updated_at": "2027-05-20T01:00:00Z",    "questions": [      {        "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",        "text": "What is the main reason you are leaving?",        "type": "text",        "order": 1      },      {        "id": "c3d4e5f6-a7b8-9012-cdef-123456789012",        "text": "How would you rate your manager?",        "type": "single_choice",        "order": 2,        "options": [          {            "id": "d4e5f6a7-b8c9-0123-def0-234567890123",            "value": "Excellent"          },          {            "id": "e5f6a7b8-c9d0-1234-ef01-345678901234",            "value": "Good"          }        ]      }    ]  }}

Update Exit Interview

Updates an exit interview. Only the fields you send are changed.

Published and archived exit interviews

A published or archived exit interview cannot be updated.

PATCH

https://api.employmenthero.com/api/v1/organisations/:organisation_id/exit_interviews/:exit_interview_id

Path Parameters

organisation_iduuidrequired

The ID of the organisation.

exit_interview_iduuidrequired

The ID of the exit interview to update.

Request Body

namestring

The revised name of the exit interview. Cannot be blank. If omitted, the existing name is kept.

member_idsuuid[]

The full list of members to send the exit interview to. Replaces the existing list and cannot be empty. Each ID must belong to a member of the organisation. Unknown IDs return 422. If omitted, the existing members are kept.

start_atdatetime

The revised date and time the exit interview starts, in ISO 8601 format. If omitted, the existing start date is kept.

questionsobject[]

The full list of questions, in the order given. Replaces all existing questions. If omitted, the existing questions are kept.

Response Body

The updated exit interview, including its questions.

dataobject

iduuid

Unique identifier of the exit interview.

namestring

The name of the exit interview.

statusenum<string>

The status of the exit interview.

total_responsesinteger

The number of responses received.

start_atdatetime

The date and time the exit interview starts, in ISO 8601 format. Publishing sets it to the time of publishing.

authorobject

The member who created the exit interview.

membersobject[]

The members the exit interview is sent to.

created_atdatetime

The date and time the exit interview was created, in ISO 8601 format.

updated_atdatetime

The date and time the exit interview was last updated, in ISO 8601 format.

questionsobject[]

The questions of the exit interview, in order.

Example

curl -X PATCH \  "https://api.employmenthero.com/api/v1/organisations/:organisation_id/exit_interviews/:exit_interview_id" \  -H "Authorization: Bearer AUXJ3123xyrj123fdsjkl124aAJKQ" \  -H "Content-Type: application/json" \  -d '{    "name": "Q3 2027 leavers (revised)",    "start_at": "2027-06-15T00:00:00Z"  }'

Response

{  "data": {    "id": "d6a0c7e2-3f41-4b8a-9c2e-5a1b7f8e9d01",    "name": "Q3 2027 leavers (revised)",    "status": "draft",    "total_responses": 0,    "start_at": "2027-06-15T00:00:00Z",    "author": {      "id": "6ddbfb24-8153-42a9-9248-c41c9b6c755e",      "full_name": "Jane Smith"    },    "members": [      {        "member_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",        "member_name": "Alex Chen"      }    ],    "created_at": "2027-05-20T01:00:00Z",    "updated_at": "2027-05-21T09:30:00Z",    "questions": [      {        "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",        "text": "What is the main reason you are leaving?",        "type": "text",        "order": 1      },      {        "id": "c3d4e5f6-a7b8-9012-cdef-123456789012",        "text": "How would you rate your manager?",        "type": "single_choice",        "order": 2,        "options": [          {            "id": "d4e5f6a7-b8c9-0123-def0-234567890123",            "value": "Excellent"          },          {            "id": "e5f6a7b8-c9d0-1234-ef01-345678901234",            "value": "Good"          }        ]      }    ]  }}

Publish Exit Interview

Publishes a draft or pending exit interview, sets start_at to the time of publishing, and notifies the members.

POST

https://api.employmenthero.com/api/v1/organisations/:organisation_id/exit_interviews/:exit_interview_id/publish

Path Parameters

organisation_iduuidrequired

The ID of the organisation.

exit_interview_iduuidrequired

The ID of the exit interview to publish.

Response Body

The published exit interview, with status published and start_at set to the time of publishing.

dataobject

iduuid

Unique identifier of the exit interview.

namestring

The name of the exit interview.

statusenum<string>

The status of the exit interview.

total_responsesinteger

The number of responses received.

start_atdatetime

The date and time the exit interview starts, in ISO 8601 format. Publishing sets it to the time of publishing.

authorobject

The member who created the exit interview.

membersobject[]

The members the exit interview is sent to.

created_atdatetime

The date and time the exit interview was created, in ISO 8601 format.

updated_atdatetime

The date and time the exit interview was last updated, in ISO 8601 format.

questionsobject[]

The questions of the exit interview, in order.

Example

curl -X POST \  "https://api.employmenthero.com/api/v1/organisations/:organisation_id/exit_interviews/:exit_interview_id/publish" \  -H "Authorization: Bearer AUXJ3123xyrj123fdsjkl124aAJKQ"

Response

{  "data": {    "id": "d6a0c7e2-3f41-4b8a-9c2e-5a1b7f8e9d01",    "name": "Q3 2027 leavers",    "status": "published",    "total_responses": 0,    "start_at": "2027-05-22T02:00:00Z",    "author": {      "id": "6ddbfb24-8153-42a9-9248-c41c9b6c755e",      "full_name": "Jane Smith"    },    "members": [      {        "member_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",        "member_name": "Alex Chen"      }    ],    "created_at": "2027-05-20T01:00:00Z",    "updated_at": "2027-05-22T02:00:00Z",    "questions": [      {        "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",        "text": "What is the main reason you are leaving?",        "type": "text",        "order": 1      },      {        "id": "c3d4e5f6-a7b8-9012-cdef-123456789012",        "text": "How would you rate your manager?",        "type": "single_choice",        "order": 2,        "options": [          {            "id": "d4e5f6a7-b8c9-0123-def0-234567890123",            "value": "Excellent"          },          {            "id": "e5f6a7b8-c9d0-1234-ef01-345678901234",            "value": "Good"          }        ]      }    ]  }}

Delete Exit Interview

Deletes an exit interview.

Published exit interviews with responses

A published exit interview that has responses cannot be deleted.

DELETE

https://api.employmenthero.com/api/v1/organisations/:organisation_id/exit_interviews/:exit_interview_id

Path Parameters

organisation_iduuidrequired

The ID of the organisation.

exit_interview_iduuidrequired

The ID of the exit interview to delete.

Response Body

Returns HTTP 204 No Content with no body on success. Requesting the same ID again returns 404 because the exit interview no longer exists.

Example

curl -X DELETE \  "https://api.employmenthero.com/api/v1/organisations/:organisation_id/exit_interviews/:exit_interview_id" \  -H "Authorization: Bearer AUXJ3123xyrj123fdsjkl124aAJKQ"

Response

This endpoint does not return a response body.