Fetch in-depth information about a single vendor

client.vendors.retrieve(, ?): VendorRetrieveResponse { created_at, description, lifecycle_stage, 3 more }

GET/v1/vendors/{urn}

ParametersExpand Collapse

urn: string

ReturnsExpand Collapse

VendorRetrieveResponse { created_at, description, lifecycle_stage, 3 more }

created_at: string

An ISO-8601-formatted timestamp representing when the vendor was created (UTC)

formatdate-time

description: string | null

The vendor's description

lifecycle_stage: "INITIAL_ASSESSMENT" | "ONBOARDED"

The vendor's current lifecycle stage

Accepts one of the following:

"INITIAL_ASSESSMENT"

"ONBOARDED"

name: string

The vendor's display name

urn: string

A unique identifier for the vendor

metadata?: Array<Metadata>

A list of custom metadata fields associated with the vendor

name: string

The name of the metadata field

type: "TEXT" | "SELECT" | "MULTI_SELECT"

The type of the metadata field

Accepts one of the following:

"TEXT"

"SELECT"

"MULTI_SELECT"

urn: string

A unique identifier for the metadata field

value?: unknown

The value of the metadata field

Fetch in-depth information about a single vendor

import Clarative from 'clarative';

const client = new Clarative({
  apiKey: process.env['CLARATIVE_API_KEY'], // This is the default and can be omitted
});

const vendor = await client.vendors.retrieve('urn');

console.log(vendor.created_at);

{
  "created_at": "2019-12-27T18:11:19.117Z",
  "description": "description",
  "lifecycle_stage": "INITIAL_ASSESSMENT",
  "name": "name",
  "urn": "urn",
  "metadata": [
    {
      "name": "name",
      "type": "TEXT",
      "urn": "urn",
      "value": {}
    }
  ]
}

Returns Examples

{
  "created_at": "2019-12-27T18:11:19.117Z",
  "description": "description",
  "lifecycle_stage": "INITIAL_ASSESSMENT",
  "name": "name",
  "urn": "urn",
  "metadata": [
    {
      "name": "name",
      "type": "TEXT",
      "urn": "urn",
      "value": {}
    }
  ]
}