---
title: "List vendors"
method: GET
path: "/v1/platform/businesses/{business_id}/vendors/"
tags: ["Vendors"]
---

# List vendors

`GET /v1/platform/businesses/{business_id}/vendors/`

## Request

- Base URL: `https://docs.thredfi.com` (the document declares no server; this is the origin it was published from)
- URL: `https://docs.thredfi.com/v1/platform/businesses/{business_id}/vendors/`
- Auth: one of:
  - HTTP bearer
  - HTTP bearer
  - HTTP basic
  - HTTP bearer
  - HTTP bearer

List all vendors within a business. Active vendors are returned by default; include archived ones with include_archived=true.

## Path parameters

- `business_id` string, required

## Query parameters

- `external_id` string
- `external_id_contains` string
- `include_archived` boolean
- `name` string
- `name_contains` string
- `page` integer
- `page_size` integer

## Response `200`

- PaginatedVendorList
  - `count` integer, required: Total number of items
  - `page_info` object, required
    - `total_count` integer, required: Total number of items (same as count)
    - `current_page` integer, required: Current page number (1-indexed)
    - `total_pages` integer, required: Total number of pages
    - `page_size` integer, required: Number of items per page
  - `results` Vendor[], required
    - `type` string, required: Resource type (always 'VendorData')
    - `id` string, uuid, required: Unique vendor identifier
    - `external_id` string: Your unique identifier for this vendor (used for idempotency)
    - `individual_name` string: Vendor individual name (for sole traders/freelancers)
    - `company_name` string: Registered company name (for limited companies)
    - `email` string, email: Primary email address for vendor communications
    - `mobile_phone` string, required: Mobile phone number (E.164 format, e.g., +44 7700 900123)
    - `office_phone` string, required: Office phone number (E.164 format, e.g., +44 20 7946 0958)
    - `address_string` string, required: Full formatted address (read-only, auto-generated)
    - `memo` string, required: Internal notes or description for this vendor
    - `status` string, required: Vendor status (ACTIVE, INACTIVE, ARCHIVED, BLOCKED)
    - `transaction_tags` unknown[], required: List of tags for categorization
      - unknown
    - `documents` DocumentFileUrl[], required: All documents linked to this vendor with presigned URLs
      - `url` string, uri, required: Presigned URL for document download
      - `expires_in` integer, required: Seconds until URL expires
      - `document_id` string, uuid, required: Document UUID
      - `file_name` string, required: Original document filename
      - `file_size` integer, required: File size in bytes
      - `mime_type` string, required: MIME type of the document

## Other responses

- `400`: Validation errors in request data
- `401`: Authentication required - missing or invalid API key
- `403`: Permission denied - insufficient privileges
- `404`: Resource not found
- `409`: Conflict - resource already exists or invalid state transition
- `422`: Unprocessable entity - business logic validation failed
- `500`: Internal server error

---

[API](https://skmtc.dev/thredfi/apis/thredfi-accounting-platform-api.md) - [All operations](https://skmtc.dev/thredfi/apis/thredfi-accounting-platform-api/llms.txt) - [OpenAPI document](https://skmtc.dev/thredfi/apis/thredfi-accounting-platform-api/revisions/0c1918254db3?raw)