UPupguard
vendors

List onboarding requests

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)

get/onboarding_request/list

Request

Query parameters

page_sizeinteger

Number of results per page (1-2000)

page_tokenstring

Token for the next page of results

sort_by'vendor_name' | 'status' | 'created_at' | 'completed_at' | 'progress' | 'submitted_by'

Field to sort by

Sort order for status is: Complete, Sent, In Progress, In Review, Assessment Underway, Awaiting Review

Sort by submitted_by sorts by the name of the submitter

sort_descboolean

Sort in descending order, sorts in ascending order if unset

statusstring

Comma-separated list of statuses to filter by

Valid values: Complete,Sent,In Progress,In Review,Assessment Underway,Awaiting Review

archivedboolean

Filter by archived status

filter_textstring

Text to search for in vendor name or submitter name

Response

List of onboarding requests

next_page_tokenstring

Token for the next page of results

total_resultsinteger

The total number of matching results

Example response

{
  "onboarding_requests": [
    {
      "completed_at": "2024-02-01T15:30:00Z",
      "created_at": "2024-01-15T10:00:00Z",
      "due_date": "2024-03-01T00:00:00Z",
      "id": 12345,
      "num_messages": 3,
      "outcome": {
        "category": "positive",
        "comment": "Approved with conditions",
        "description": "Vendor approved for use",
        "name": "Approved"
      },
      "priority": "high",
      "progress": 75.5,
      "reassessment_date": "2024-03-01T00:00:00Z",
      "status": "Complete",
      "submitted_by": {
        "email": "john@example.com",
        "name": "John Doe"
      },
      "vendor_hostname": "acme.com",
      "vendor_name": "Acme Corp"
    }
  ],
  "total_results": 100
}

Changes

No recorded changes to this operation across all 1 revision of this API.