UPupguard
vendors

Get questionnaire metadata

Returns metadata about a specific questionnaire including recipients, completion status, and score. Note: This endpoint only supports private questionnaires, not public questionnaires.

Required API key permissions: VendorRisk (select when creating API key in Account Settings)

get/vendor/questionnaire

Request

Query parameters

idinteger required

The ID of the questionnaire

Response

Questionnaire metadata response

answered_atstring date-time

When the questionnaire was answered/returned

due_datestring date-time

The datetime that the questionnaire is due to be completed.

idinteger

The ID of the questionnaire

in_remediationboolean

Flag indicating whether there are risks under remediation in this questionnaire

percent_completednumber double

Percentage of questions answered (0-100)

questionnaire_namestring

The name of the questionnaire

questionnaire_type_idinteger

The ID of the questionnaire type/template

scoreinteger

Risk score for the questionnaire out of 950 (if enabled and available)

sent_atstring date-time

Datetime when the questionnaire was sent

status'sent' | 'opened' | 'returned' | 'inreview' | 'complete' | 'cancelled' | 'published'

The current status of the questionnaire

type_namestring

The name of the questionnaire type

Example response

{
  "answered_at": "2024-03-20T15:30:00Z",
  "answered_by": {
    "email": "auditor@yourcompany.com",
    "name": "Jane Doe"
  },
  "due_date": "2024-04-20T00:00:00Z",
  "id": 12345,
  "percent_completed": 85.5,
  "questionnaire_name": "Security Assessment for Acme Corp",
  "questionnaire_type_id": 42,
  "recipients": [
    {
      "email": "vendor@example.com",
      "is_pending_invite": true,
      "job_title": "Security Manager",
      "name": "John Smith"
    }
  ],
  "score": 750,
  "sent_at": "2024-03-15T10:00:00Z",
  "sent_by": {
    "email": "auditor@yourcompany.com",
    "name": "Jane Doe"
  },
  "status": "complete",
  "type_name": "ISO 27001"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.