logo

Vendor

This document describes the API for reading and archiving Vendors.

List Vendors

Returns a list of Vendors.

Search parameters

Filter Description
archived Flag to indicate if this Vendor is archived
id The ID of the Vendor
name The name of the Vendor
owner_name The name of the User that is the owner for this Vendor
risk_level The risk level for this Vendor
updated_at The date this Vendor was last updated
Securityheader_authorization
Request
query Parameters
include
boolean

Set to true along with relationships to return the entire relationship data in the included key within the response.

page
integer

Used for pagination of response data (default: page 1). Specifies the offset of the next block of data to receive.

per_page
integer

Used for pagination of response data (default: 1000 items per response). Specifies the number of results for a given page.

q
string

Search and filter the Vendor data using Lucene syntax.

relationships
boolean

Set to true to return the associated relationships data within the response. (default: false)

Responses
400

Bad Request

401

Unauthorized

403

Forbidden

default
get/vendors
Request samples 
Response samples 
application/json
[
  • {
    }
]
Get a Vendor
Returns a single Vendor by ID


Securityheader_authorization 
Request 
path Parameters
id
required
string
Scope response to id


 
Responses 
400
Bad Request


401
Unauthorized


403
Forbidden


404
Resource not found


default
get/vendors/{id}
Request samples 
Response samples 
application/json
{
  • "data": {
    },
  • "includes": { }
}
Archive a Vendor
Archives a Vendor by ID.


Securityheader_authorization 
Request 
path Parameters
id
required
string
Scope response to id


 
query Parameters
terminated_at
string <date-time> 
The date this vendor was terminated.


 
Responses 
400
Bad Request


401
Unauthorized


403
Forbidden


404
Resource not found


default
put/vendors/{id}/archive
Request samples 
Response samples 
application/json
{
  • "data": {
    },
  • "includes": { }
}