Interviews

Gets list of interviews existing in the system

get/api/v1/interviews

Request

  • Base URL: https://demo.mysurvey.solutions (the document declares no server; this is the origin it was published from)
  • URL: https://demo.mysurvey.solutions/api/v1/interviews
  • Auth: HTTP basic and HTTP bearer

Query parameters

questionnaireIdstring uuid

Questionnaire id if filtering by this field is required

questionnaireVersioninteger

Questionnaire id if filtering by this field is required

status'Restored' | 'Created' | 'SupervisorAssigned' | 'InterviewerAssigned' | 'RejectedBySupervisor' | 'ReadyForInterview' | 'SentToCapi' | 'Restarted' | 'Completed' | 'ApprovedBySupervisor' | 'RejectedByHeadquarters' | 'ApprovedByHeadquarters' | 'Deleted'

Filtering by interview status

interviewIdstring uuid

Interview Id. This corresponds to the interview__id variable in data export files or the interview Id obtained through other API requests

pageSizeinteger

Page size

pageinteger

Page number (starting from 1)

Response

OK

Orderstring nullable
Limitinteger required
TotalCountinteger required
Offsetinteger required

Changes

No recorded changes to this operation across all 1 revision of this API.