Skip to content
/
Get supplier

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

Get suppliers

Request

Get all of your suppliers

Security
bearer
Query
fieldsArray of strings

Suppliers will only contain specified fields (all if none)

Items Enum"approval""assets""business_impact""business_information""combined_score""contacts""created_by""evaluation_type""id""insert_ts"
namesArray of strings

Search by supplier names

idsArray of strings

Search by supplier ids

assetsArray of strings

Search by supplier assets

tagsArray of strings

Search by supplier tags

sortByArray of strings

Name of the field to sort by

Items Enum"name""business_impact""insert_ts"
sortDirectionstring

The direction of the field sort specified by sort_by

Enum"ASC""asc""1""DESC""desc""-1"
limitnumber[ 1 .. 100 ]

Number of records to return in the response

Default 100
next_tokenstring

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

segment_idsArray of strings

Search by supplier segment ids

curl -i -X GET \
  'https://panorays-papi-v2-documentation.redocly.app/_mock/swagger/v2/suppliers?fields=approval&names=string&ids=string&assets=string&tags=string&sortBy=name&sortDirection=ASC&limit=100&next_token=string&segment_ids=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

All found suppliers are returned.

Bodyapplication/jsonArray [
business_informationArray of objects(BusinessInformation)required
business_information[].​typestringrequired
Enum"text""date""dropDown""multiSelection""file"
contactsArray of objects(Contact)required
questionnairesArray of objects(InquiryInfo)required
questionnaires[].​questionnaire_idstringrequired
questionnaires[].​questionnaire_scorenumber or nullrequired
questionnaires[].​questionnaire_sent_datestringrequired
questionnaires[].​questionnaire_submit_datestring or nullrequired
questionnaires[].​questionnaire_typestring or nullrequired
evaluation_typestring
Enum"Continuous 360 Evaluation""Continuous Posture Evaluation""Bi-Annual 360 Evaluation""Bi-Annual Posture Evaluation""Smart Questionnaires""Inventory""Inventory Plus"
latest_assessment_datestring

This field indicates the date of the most recent assessment conducted or updated. format is ISO 8601 GMT

idstringrequired
namestringrequired
relationshipsArray of stringsrequired
business_impactnumberrequired
insert_tsstringrequired
created_bystringrequired
approvalobject(Approval)required
approval.​statusstringrequired
Enum"PENDING""APPROVED""REJECTED""CONTINGENT""RE_EVALUATION""ARCHIVED"
approval.​bystringrequired
approval.​update_tsstringrequired
approval.​reasonstring
risknumberrequired
combined_scorenumberrequired
posture_scorenumberrequired
tagsArray of stringsrequired
questionnaire_overall_scorenumberrequired
portfoliosArray of strings
segmentIdstring
primary_domainstringrequired
]
Response
application/json
[
  {
    "business_information": [ … ],
    "contacts": [ … ],
    "questionnaires": [ … ],
    "evaluation_type": "Continuous 360 Evaluation",
    "latest_assessment_date": "string",
    "id": "string",
    "name": "string",
    "relationships": [ … ],
    "business_impact": 0,
    "insert_ts": "string",
    "created_by": "string",
    "approval": { … },
    "risk": 0,
    "combined_score": 0,
    "posture_score": 0,
    "tags": [ … ],
    "questionnaire_overall_score": 0,
    "portfolios": [ … ],
    "segmentId": "string",
    "primary_domain": "string"
  }
]

Get supplier

Request

Get a single supplier by id

Security
bearer
Path
idstringrequired
Query
fieldsArray of strings

Suppliers will only contain specified fields (all if none)

Items Enum"approval""assets""business_impact""business_information""combined_score""contacts""created_by""evaluation_type""id""insert_ts"
curl -i -X GET \
  'https://panorays-papi-v2-documentation.redocly.app/_mock/swagger/v2/suppliers/{id}?fields=approval' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Supplier found.

Bodyapplication/json
business_informationArray of objects(BusinessInformation)required
business_information[].​typestringrequired
Enum"text""date""dropDown""multiSelection""file"
contactsArray of objects(Contact)required
questionnairesArray of objects(InquiryInfo)required
questionnaires[].​questionnaire_idstringrequired
questionnaires[].​questionnaire_scorenumber or nullrequired
questionnaires[].​questionnaire_sent_datestringrequired
questionnaires[].​questionnaire_submit_datestring or nullrequired
questionnaires[].​questionnaire_typestring or nullrequired
evaluation_typestring
Enum"Continuous 360 Evaluation""Continuous Posture Evaluation""Bi-Annual 360 Evaluation""Bi-Annual Posture Evaluation""Smart Questionnaires""Inventory""Inventory Plus"
latest_assessment_datestring

This field indicates the date of the most recent assessment conducted or updated. format is ISO 8601 GMT

idstringrequired
namestringrequired
relationshipsArray of stringsrequired
business_impactnumberrequired
insert_tsstringrequired
created_bystringrequired
approvalobject(Approval)required
approval.​statusstringrequired
Enum"PENDING""APPROVED""REJECTED""CONTINGENT""RE_EVALUATION""ARCHIVED"
approval.​bystringrequired
approval.​update_tsstringrequired
approval.​reasonstring
risknumberrequired
combined_scorenumberrequired
posture_scorenumberrequired
tagsArray of stringsrequired
questionnaire_overall_scorenumberrequired
portfoliosArray of strings
segmentIdstring
primary_domainstringrequired
Response
application/json
{
  "business_information": [
    { … }
  ],
  "contacts": [
    {}
  ],
  "questionnaires": [
    { … }
  ],
  "evaluation_type": "Continuous 360 Evaluation",
  "latest_assessment_date": "string",
  "id": "string",
  "name": "string",
  "relationships": [
    "string"
  ],
  "business_impact": 0,
  "insert_ts": "string",
  "created_by": "string",
  "approval": {
    "status": "PENDING",
    "by": "string",
    "update_ts": "string",
    "reason": "string"
  },
  "risk": 0,
  "combined_score": 0,
  "posture_score": 0,
  "tags": [
    "string"
  ],
  "questionnaire_overall_score": 0,
  "portfolios": [
    "string"
  ],
  "segmentId": "string",
  "primary_domain": "string"
}

Update supplier

Request

Update a single supplier by id.

Security
bearer
Path
supplierIdstringrequired

Id of the supplier

Bodyapplication/jsonrequired
namestring

The supplier's name

Example: "Panorays"
assetsArray of stringsunique

Supplier assets as entered by the user

pocsArray of objects(PocDto)
approvalobject
relationshipsArray of stringsunique
tagsArray of stringsunique
business_impactnumber[ 1 .. 5 ]
business_informationArray of objects(BusinessInformationInput)
evaluation_typestring
Enum"Continuous 360 Evaluation""Continuous Posture Evaluation""Bi-Annual 360 Evaluation""Bi-Annual Posture Evaluation""Smart Questionnaires""Inventory Plus"
portfoliosArray of stringsunique
curl -i -X PUT \
  'https://panorays-papi-v2-documentation.redocly.app/_mock/swagger/v2/suppliers/{supplierId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Panorays",
    "assets": [
      "string"
    ],
    "pocs": [
      {
        "email": "user@example.com",
        "name": "string",
        "language": "aa",
        "position": "string",
        "phone": "string"
      }
    ],
    "approval": {
      "status": "PENDING",
      "by": "string",
      "update_ts": "string",
      "reason": "string"
    },
    "relationships": [
      "string"
    ],
    "tags": [
      "string"
    ],
    "business_impact": 1,
    "business_information": [
      {
        "answer": "string",
        "question_id": "string"
      }
    ],
    "evaluation_type": "Continuous 360 Evaluation",
    "portfolios": [
      "string"
    ]
  }'

Responses

Bodyapplication/json
object
Response
application/json
{}

Segment

Operations

Posture

Operations

Portfolio

Operations

Asset

Operations

Finding

Operations

RemediationTasks

Operations

BusinessInformation

Operations

File

Operations

Questionnaire

Operations

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