List subjects

GET 
/v3/survey/subjects

List subjects

Request

Query Parameters

survey_id numberrequired

Id of the survey

limit number

Possible values: >= 1 and <= 100

Default value: 50

page number

Possible values: >= 1

email string

Responses

200

Successful

*/*

Schema

Schema

data

object

list

object[]

Array [

id numberrequired

Id of the approver

name stringrequired

Name of the approver

email stringrequired

Email of the approver

joined_portal boolean

properties

object

self_evaluation boolean

self_nomination boolean

require_approval boolean

approver

object

id numberrequired

Id of the approver

name stringrequired

Name of the approver

email stringrequired

Email of the approver

joined_portal boolean

]

count numberrequired

limit numberrequired

Possible values: >= 1 and <= 100

Default value: 50

page numberrequired

Possible values: >= 1

Example (from schema)

{
  "data": {
    "list": [
      {
        "id": 0,
        "name": "string",
        "email": "string",
        "joined_portal": false,
        "properties": {
          "self_evaluation": true,
          "self_nomination": true,
          "require_approval": true
        },
        "approver": {
          "id": 0,
          "name": "string",
          "email": "string",
          "joined_portal": false
        }
      }
    ],
    "count": 0,
    "limit": 50,
    "page": 0
  }
}

Loading...