Skip to content
/
Get segment questionnaire...

papi (2)

Panorays Public API

Download OpenAPI description
swagger.json
swagger.yaml
Overview
Support
support@panorays.com
Languages
Servers
Mock server
https://panorays-papi-v2-documentation.redocly.app/_mock/swagger
https://api.panoraysapp.com

Supplier

Use these routes to access and update your suppliers.

Operations

Segment

Operations

Posture

Operations

Portfolio

Operations

Asset

Operations

Finding

Operations

RemediationTasks

Operations

BusinessInformation

Operations

File

Operations

Questionnaire

Operations

Get supplier questionnaires info

Request

This endpoint will return info about the latest questionnaires for each template sent to a specific supplier.

Security
bearer
Path
supplierIdstringrequired

Id of the supplier

Query
limitnumber[ 1 .. 20 ]

Number of records to return in the response

Default 20
sortBystring

Name of the field to sort by

Enum"questionnaire_id""template_name""completion_rate""status_update_date""created_by""status""score""ttl""weight""questionnaire_submit_date"
sortDirectionstring

The direction of the field sort specified by sort_by

Enum"ASC""asc""1""DESC""desc""-1"
next_tokenstring

Token received from a previous request to obtain the next chunk of data

questionnaire_typestring
Enum"external""internal""both"
fieldsstringrequired
Default ["questionnaire_id","template_name","completion_rate","status_update_date","created_by","status","score","ttl","weight","questionnaire_submit_date","questionnaire_sent_date"]
Enum"questionnaire_id""template_name""completion_rate""status_update_date""created_by""status""score""ttl""weight""questionnaire_submit_date"
template_namesArray of strings
curl -i -X GET \
  'https://panorays-papi-v2-documentation.redocly.app/_mock/swagger/v2/suppliers/{supplierId}/questionnaires?limit=20&sortBy=questionnaire_id&sortDirection=ASC&next_token=string&questionnaire_type=external&fields=questionnaire_id&template_names=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Supplier questionnaires info

Bodyapplication/jsonArray [
questionnaire_idstringrequired

Id of the questionnaire

template_namestringrequired

Name of the template

completion_ratenumber[ 0 .. 1 ]required

Float from 0 to 1

statusstringrequired
Enum"SENT""IN_PROGRESS""DONE""CANCELED""EXPIRED""IN_REVIEW""ARCHIVED"
ttlstring or nullrequired
questionnaire_typestringrequired
Enum"external""internal""both"
status_update_datestringrequired
created_bystringrequired
scorenumber or nullrequired
weightnumberrequired
questionnaire_submit_datestring or nullrequired
questionnaire_sent_datestringrequired
]
Response
application/json
[
  {
    "questionnaire_id": "string",
    "template_name": "string",
    "completion_rate": 1,
    "status": "SENT",
    "ttl": "string",
    "questionnaire_type": "external",
    "status_update_date": "string",
    "created_by": "string",
    "score": 0,
    "weight": 0,
    "questionnaire_submit_date": "string",
    "questionnaire_sent_date": "string"
  }
]

Get segment questionnaires info

Request

This endpoint will return info about the latest questionnaires for each template sent to a specific segment.

Security
bearer
Path
supplierIdstringrequired

Id of the supplier

segmentIdstringrequired

Id of the segment

Query
limitnumber[ 1 .. 20 ]

Number of records to return in the response

Default 20
sortBystring

Name of the field to sort by

Enum"questionnaire_id""template_name""completion_rate""status_update_date""created_by""status""score""ttl""weight""questionnaire_submit_date"
sortDirectionstring

The direction of the field sort specified by sort_by

Enum"ASC""asc""1""DESC""desc""-1"
next_tokenstring

Token received from a previous request to obtain the next chunk of data

questionnaire_typestring
Enum"external""internal""both"
fieldsstringrequired
Default ["questionnaire_id","template_name","completion_rate","status_update_date","created_by","status","score","ttl","weight","questionnaire_submit_date","questionnaire_sent_date"]
Enum"questionnaire_id""template_name""completion_rate""status_update_date""created_by""status""score""ttl""weight""questionnaire_submit_date"
template_namesArray of strings
curl -i -X GET \
  'https://panorays-papi-v2-documentation.redocly.app/_mock/swagger/v2/suppliers/{supplierId}/segment/{segmentId}/questionnaires?limit=20&sortBy=questionnaire_id&sortDirection=ASC&next_token=string&questionnaire_type=external&fields=questionnaire_id&template_names=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Segment questionnaires info

Bodyapplication/jsonArray [
questionnaire_idstringrequired

Id of the questionnaire

template_namestringrequired

Name of the template

completion_ratenumber[ 0 .. 1 ]required

Float from 0 to 1

statusstringrequired
Enum"SENT""IN_PROGRESS""DONE""CANCELED""EXPIRED""IN_REVIEW""ARCHIVED"
ttlstring or nullrequired
questionnaire_typestringrequired
Enum"external""internal""both"
status_update_datestringrequired
created_bystringrequired
scorenumber or nullrequired
weightnumberrequired
questionnaire_submit_datestring or nullrequired
questionnaire_sent_datestringrequired
]
Response
application/json
[
  {
    "questionnaire_id": "string",
    "template_name": "string",
    "completion_rate": 1,
    "status": "SENT",
    "ttl": "string",
    "questionnaire_type": "external",
    "status_update_date": "string",
    "created_by": "string",
    "score": 0,
    "weight": 0,
    "questionnaire_submit_date": "string",
    "questionnaire_sent_date": "string"
  }
]

Get supplier questionnaire

Request

This endpoint will return info about the latest questionnaires for each template sent to a specific supplier including the answers.

Security
bearer
Path
supplierIdstringrequired
questionnaireIdstringrequired
Query
questionnaire_typestring
Enum"external""internal""both"
fieldsstring
Enum"score""template_name""template_id""status""ttl""questions""id""display_name""internal_notes""comments"
languagestring
Enum"en""ja""zh""he"
out_of_policy_onlyboolean
curl -i -X GET \
  'https://panorays-papi-v2-documentation.redocly.app/_mock/swagger/v2/suppliers/{supplierId}/questionnaires/{questionnaireId}?questionnaire_type=external&fields=score&language=en&out_of_policy_only=true' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Supplier questionnaire answers info

Bodyapplication/json
statusstringrequired
Enum"SENT""IN_PROGRESS""DONE""CANCELED""EXPIRED""IN_REVIEW""ARCHIVED"
scorenumber or nullrequired
ttlstring or nullrequired
questionsArray of objects(Question)required
questions[].​typestringrequired
Enum"FreeText""MultiChoice""SingleChoice""File""DateSelection"
questions[].​textstringrequired
questions[].​categorystringrequired
questions[].​possible_answersArray of stringsrequired
questions[].​answerstringrequired
questions[].​out_of_policybooleanrequired
questions[].​additional_informationstringrequired
questionnaire_typestringrequired
Enum"external""internal""both"
idstringrequired
template_namestringrequired
Response
application/json
{
  "status": "SENT",
  "score": 0,
  "ttl": "string",
  "questions": [
    { … }
  ],
  "questionnaire_type": "external",
  "id": "string",
  "template_name": "string"
}

RiskInsights

Operations

BusinessSnapshot

Operations

Relationship

Operations

Licenses

Operations

Templates

Operations

Activity Center

Operations

Tags

Tag actions (Create, Delete, Get, Update) apply to company tags only. Tags can’t be updated via the supplier endpoint, as they may link to multiple suppliers. When a company tag is updated/deleted, all associated suppliers are automatically updated — no separate supplier update is needed.

Operations

Factors

Operations

CyberNewsArticles

Operations

DarkWebMentions

Operations

ReEvaluation

Operations

Webhooks Intro

The hook api provides a simple way of registering to events that happen with your suppliers

Getting Started

The following steps will walk you through the process of registering and reacting to webhooks.

  1. Register an API token

If you don’t already have an API token, you can generate one through Panorays platform or contact Panorays Support at support@panorays.com.

  1. Register your app

Before you can start receiving events, register your application with Panorays using the Handshake API call.

  1. Subscribe to relevant events

You will only receive event calls for events you subscribe to using the Subscribe API call.
Note: You can unsubscribe at any time using the Unsubscribe API call.

  1. Start receiving events

You're done! From now on, you will receive notifications for every event you subscribed to.

To learn how to secure your app and ensure you handle events only from Panorays, read about Verifying requests.

Verify Requests

Panorays signs every request with a secret that's unique to your service account, using this secret you can verify that the incoming request arrived from Panorays servers.

Handshake

Operations

Subscription

Operations