# Vendors

## List

`client.vendors.list(VendorListParamsquery?, RequestOptionsoptions?): VendorListResponse`

**get** `/v1/vendors`

List all vendors, sorted by name alphabetically (case-insensitive)

### Parameters

- `query: VendorListParams`

  - `lifecycle_stage?: "INITIAL_ASSESSMENT" | "ONBOARDED" | null`

    Filter vendors by lifecycle stage

    - `"INITIAL_ASSESSMENT"`

    - `"ONBOARDED"`

### Returns

- `VendorListResponse = Array<VendorListResponseItem>`

  - `created_at: string`

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

  - `description: string | null`

    The vendor's description

  - `name: string`

    The vendor's display name

  - `urn: string`

    A unique identifier for the vendor

### Example

```typescript
import Clarative from 'clarative';

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

const vendors = await client.vendors.list();

console.log(vendors);
```

## Retrieve

`client.vendors.retrieve(stringurn, RequestOptionsoptions?): VendorRetrieveResponse`

**get** `/v1/vendors/{urn}`

Fetch in-depth information about a single vendor

### Parameters

- `urn: string`

### Returns

- `VendorRetrieveResponse`

  - `created_at: string`

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

  - `description: string | null`

    The vendor's description

  - `lifecycle_stage: "INITIAL_ASSESSMENT" | "ONBOARDED"`

    The vendor's current lifecycle stage

    - `"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

      - `"TEXT"`

      - `"SELECT"`

      - `"MULTI_SELECT"`

    - `urn: string`

      A unique identifier for the metadata field

    - `value?: unknown`

      The value of the metadata field

### Example

```typescript
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);
```