Skip to main content

ParticipantsListResponse

data object[]required
  • Array [
  • oneOf
    idintegerrequired
    typestringrequired

    Possible values: [survey_respondent]

    participant_numberintegernullablerequired
    identifierstringnullable
    tagstringnullable
    statusstringrequired

    Possible values: [active, abandoned, completed, rejected, marked_for_replacement, replacement_approved]

    recruitment_sourcestringnullable
    time_taken_secondsintegernullable
    question_response_countintegerrequired
    started_atstring<date-time>nullable
    completed_atstring<date-time>nullable
  • ]
  • pagination objectrequired
    next_cursorstringnullablerequired
    has_morebooleanrequired
    request_idstringrequired
    ParticipantsListResponse
    {
    "data": [
    {
    "id": 0,
    "type": "survey_respondent",
    "participant_number": 0,
    "identifier": "string",
    "tag": "string",
    "status": "active",
    "recruitment_source": "string",
    "time_taken_seconds": 0,
    "question_response_count": 0,
    "started_at": "2024-07-29T15:51:28.071Z",
    "completed_at": "2024-07-29T15:51:28.071Z"
    },
    {
    "id": 0,
    "type": "interview_session",
    "title": "string",
    "status": "scheduled",
    "session_origin": "scheduled",
    "session_at": "2024-07-29T15:51:28.071Z",
    "first_name": "string",
    "last_name": "string",
    "email": "string"
    },
    {
    "id": 0,
    "type": "qualitative_session",
    "title": "string",
    "session_type": "note_taking",
    "observation_count": 0,
    "session_at": "2024-07-29T15:51:28.071Z",
    "created_at": "2024-07-29T15:51:28.071Z"
    }
    ],
    "pagination": {
    "next_cursor": "string",
    "has_more": true
    },
    "request_id": "string"
    }