---
title: "Get onboarding request details"
method: GET
path: "/onboarding_request"
tags: ["vendors"]
---

# Get onboarding request details

`GET /onboarding_request`

## Request

- Base URL: `https://cyber-risk.upguard.com/api/public`
- URL: `https://cyber-risk.upguard.com/api/public/onboarding_request`
- Auth: API key in header `Authorization`
- TypeScript: <https://skmtc.dev/upguard/apis/upguard-cyberrisk-api/docs/onboarding_request/get.ts> (a function with typed inputs; its response is checked against the schema)

Returns detailed information about a specific vendor onboarding request, including vendor data and assessment links.

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

## Query parameters

- `id` integer, required

## Response `200`

Onboarding request details response

- OnboardingRequestDetail: OnboardingRequestDetail represents the full detail of a single onboarding request
  - `archived` boolean: Whether the request is archived
  - `assignee` UserMini: UserMini represents a minimal user reference in external API responses
    - `email` string: The user's email address
    - `name` string: The user's display name
  - `completed_by` UserMini: UserMini represents a minimal user reference in external API responses
    - `email` string: The user's email address
    - `name` string: The user's display name
  - `date_completed` string, date-time: When the request was completed, if applicable
  - `date_created` string, date-time: When the request was created
  - `due_date` string, date-time: The due date for the request, if set
  - `id` integer: The unique ID of the onboarding request (survey ID)
  - `is_inbound` boolean: Whether this is an inbound request (submitted via portal)
  - `linked_risk_assessment` LinkedRiskAssessment: LinkedRiskAssessment represents a linked risk assessment in the external API
    - `id` integer: The assessment ID
    - `name` string: The assessment name
    - `published_at` string, date-time: When the assessment was published
  - `num_answers` integer: The total number of answered questions
  - `num_messages` integer: The number of messages/comments on the request
  - `num_questions` integer: The total number of questions in the questionnaire
  - `outcome` OutcomeSnapshot: OutcomeSnapshot represents the outcome of a completed onboarding request
    - `category` 'positive' | 'neutral' | 'negative': The outcome category
    - `comment` string: An optional comment about the outcome
    - `description` string: A description of the outcome
    - `name` string: The outcome name
  - `priority` 'low' | 'medium' | 'high' | 'critical': The priority level of the request
  - `status` 'Complete' | 'Sent' | 'In Progress' | 'In Review' | 'Assessment Underway' | 'Awaiting Review': The current status of the request
  - `submitted_by` UserMini: UserMini represents a minimal user reference in external API responses
    - `email` string: The user's email address
    - `name` string: The user's display name
  - `vendor` OnboardingVendorInfo: OnboardingVendorInfo represents vendor information in the external API
    - `hostname` string: The vendor's primary hostname
    - `id` integer: The vendor's datastore ID
    - `is_monitored` boolean: Whether the vendor is currently monitored
    - `is_stored` boolean: True if your account keeps the vendor without monitoring it.
    - `labels` string[]: Labels assigned to the vendor
    - `lifecycle_stage` string: The lifecycle stage of the vendor in your account: procurement, onboarding, in_use, offboarding or archived. Omitted if the vendor has no stage.
    - `name` string: The vendor's display name
    - `portfolios` string[]: Portfolio names the vendor belongs to
    - `score` integer: The vendor's current scanning score (0-950), if available
    - `tier` string: The vendor's tier name, if assigned

## Other responses

- `403`: Account does not have access to requested entities
- `404`: The vendor was not found.
- `422`: An invalid parameter was supplied or a mandatory parameter was missing
- `429`: Too many requests have been made to this endpoint.
- `500`: An internal system error occurred

## Changes

- **2026-11-07** `d044bf6dc61e`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/upguard/apis/upguard-cyberrisk-api/changes/onboarding_request/get.md)

---

[API](https://skmtc.dev/upguard/apis/upguard-cyberrisk-api.md) - [All operations](https://skmtc.dev/upguard/apis/upguard-cyberrisk-api/llms.txt) - [OpenAPI document](https://skmtc.dev/upguard/apis/upguard-cyberrisk-api/revisions/d044bf6dc61e?raw)