---
title: "[Internal] List partners"
method: GET
path: "/api/partners"
tags: ["Partners"]
---

# \[Internal\] List partners

`GET /api/partners`

## Request

- Base URL: `https://api.typless.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.typless.com/api/partners`
- Auth: none declared

## Query parameters

- `limit` integer
- `start_key` string, nullable
- `active` boolean, nullable
- `search` string, nullable

## Response `200`

Successful Response

- ListPartnersResponse
  - `results` PartnerDTO[], required
    - `aggregate_id` string, uuid, required
    - `tenant_id` string, uuid, required
    - `company_id` string, uuid, nullable, required
    - `created_at` string, date-time, required
    - `updated_at` string, date-time, required
    - `vat_id` string, nullable, required
    - `registration_number` string, nullable, required
    - `name` string, nullable, required
    - `address_line_1` string, nullable, required
    - `address_line_2` string, nullable, required
    - `city` string, nullable, required
    - `postal_code` string, nullable, required
    - `country_code` string, nullable, required
    - `email` string, nullable, required
    - `phone` string, nullable, required
    - `website` string, nullable, required
    - `default_currency` string, nullable, required
    - `is_vat_registered` boolean, required
    - `notes` string, nullable, required
    - `bank_accounts` BankAccount[], nullable, required
      - `iban` string, nullable
      - `swift_bic` string, nullable
      - `bank_name` string, nullable
    - `registry_bank_accounts` BankAccount[], nullable, required
      - `iban` string, nullable
      - `swift_bic` string, nullable
      - `bank_name` string, nullable
    - `source` 'MANUAL' | 'CONFIRMATION' | 'EXTRACTION', required
    - `is_verified` boolean, required
    - `is_active` boolean, required
  - `last_id` string, nullable

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/typless/apis/typless-api.md) · [All operations](https://skmtc.dev/typless/apis/typless-api/llms.txt) · [OpenAPI document](https://skmtc.dev/typless/apis/typless-api/revisions/d614787a47ef?raw)