Fetch in-depth information about a single vendor

vendors.retrieve() -> VendorRetrieveResponse

GET/v1/vendors/{urn}

ParametersExpand Collapse

urn: str

ReturnsExpand Collapse

class VendorRetrieveResponse: …

created_at: datetime

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

formatdate-time

description: Optional[str]

The vendor's description

lifecycle_stage: Literal["INITIAL_ASSESSMENT", "ONBOARDED"]

The vendor's current lifecycle stage

Accepts one of the following:

"INITIAL_ASSESSMENT"

"ONBOARDED"

name: str

The vendor's display name

urn: str

A unique identifier for the vendor

metadata: Optional[List[Metadata]]

A list of custom metadata fields associated with the vendor

name: str

The name of the metadata field

type: Literal["TEXT", "SELECT", "MULTI_SELECT"]

The type of the metadata field

Accepts one of the following:

"TEXT"

"SELECT"

"MULTI_SELECT"

urn: str

A unique identifier for the metadata field

value: Optional[object]

The value of the metadata field

Fetch in-depth information about a single vendor

import os
from clarative import Clarative

client = Clarative(
    api_key=os.environ.get("CLARATIVE_API_KEY"),  # This is the default and can be omitted
)
vendor = client.vendors.retrieve(
    "urn",
)
print(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": {}
    }
  ]
}