Skip to content
Get started

List all vendors

vendors.list() -> VendorListResponse
GET/v1/vendors

List all vendors

ReturnsExpand Collapse
List[VendorListResponseItem]
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

List all vendors

import os
from clarative import Clarative

client = Clarative(
    api_key=os.environ.get("CLARATIVE_API_KEY"),  # This is the default and can be omitted
)
vendors = client.vendors.list()
print(vendors)
[
  {
    "created_at": "2019-12-27T18:11:19.117Z",
    "description": "description",
    "name": "name",
    "urn": "urn"
  }
]
Returns Examples
[
  {
    "created_at": "2019-12-27T18:11:19.117Z",
    "description": "description",
    "name": "name",
    "urn": "urn"
  }
]