---
title: "List onboarding requests"
method: GET
path: "/onboarding_request/list"
tags: ["vendors"]
---

# List onboarding requests

`GET /onboarding_request/list`

## Request

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

Returns a paginated list of vendor onboarding requests for the organization.

Note: The id of the onboarding request is also the survey_id of the corresponding onboarding request questionnaire.
You can download the question and answers of the onboarding request questionnaire using Get questionnaire questions and answers

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

## Query parameters

- `page_size` integer
- `page_token` string
- `sort_by` 'vendor_name' | 'status' | 'created_at' | 'completed_at' | 'progress' | 'submitted_by'
- `sort_desc` boolean
- `status` string
- `archived` boolean
- `filter_text` string

## Response `200`

List of onboarding requests

- OnboardingRequestsListRespBody: OnboardingRequestsListRespBody is the response body for the onboarding requests list endpoint
  - `next_page_token` string: Token for the next page of results
  - `onboarding_requests` OnboardingRequestListItem[]: The list of onboarding requests
    - `archived` boolean: Whether the request is archived
    - `completed_at` string, date-time: When the request was completed, if applicable
    - `created_at` 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)
    - `num_messages` integer: The number of messages/comments on the request
    - `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
    - `progress` number, double: The completion progress as a percentage (0-100), calculated as num_answers / num_questions * 100. Returns 0 when there are no questions. Values are capped at 100.
    - `reassessment_date` string, date-time: The reassessment date if present
    - `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_hostname` string: The vendor's primary hostname
    - `vendor_name` string: The vendor's display name
  - `total_results` integer: The total number of matching results

## Other responses

- `403`: Account does not have access to requested entities
- `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

---

[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)