API Reference

Vendors

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Fetch in-depth information about a single vendor

vendors.retrieve(strurn) -> VendorRetrieveResponse

GET/v1/vendors/{urn}

Fetch in-depth information about a single vendor

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

name: str

The vendor's display name

urn: str

A unique identifier for the vendor

Fetch in-depth information about a single vendor

Python

HTTP

Python

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)

200 example

{
  "created_at": "2019-12-27T18:11:19.117Z",
  "description": "description",
  "name": "name",
  "urn": "urn"
}

Returns Examples

200 example

{
  "created_at": "2019-12-27T18:11:19.117Z",
  "description": "description",
  "name": "name",
  "urn": "urn"
}