---
title: "List customers"
method: GET
path: "/v1/customers"
tags: ["Customers"]
deprecated: true
---

# List customers

`GET /v1/customers`

> **Deprecated.**

We recommend using the `GET /v2/customers` endpoint instead.

## Query parameters

- `take` number, nullable
- `skip` number, nullable
- `name` string
- `name__not` string
- `name__isNull` string
- `name__isNotNull` string
- `name__equals` string
- `name__contains` string
- `name__startsWith` string
- `name__endWith` string
- `type` union
  - 'corporate' | 'person'
  - string — corporate,person
- `type__in` union
  - 'corporate' | 'person'
  - string — corporate,person
- `status` union
  - 'all' | 'active' | 'inactive' | 'imported' | 'archived'
  - string — all,active
- `status__in` union
  - 'all' | 'active' | 'inactive' | 'imported' | 'archived'
  - string — all,active
- `currency` string
- `currency__not` string
- `currency__isNull` string
- `currency__isNotNull` string
- `currency__equals` string
- `currency__contains` string
- `currency__startsWith` string
- `currency__endWith` string
- `country` string
- `country__not` string
- `country__isNull` string
- `country__isNotNull` string
- `country__equals` string
- `country__contains` string
- `country__startsWith` string
- `country__endWith` string
- `external_id` string
- `external_id__not` string
- `external_id__isNull` string
- `external_id__isNotNull` string
- `external_id__equals` string
- `external_id__contains` string
- `external_id__startsWith` string
- `external_id__endWith` string
- `billing_email` string
- `billing_email__not` string
- `billing_email__isNull` string
- `billing_email__isNotNull` string
- `billing_email__equals` string
- `billing_email__contains` string
- `billing_email__startsWith` string
- `billing_email__endWith` string
- `search` string
- `tax_id` string
- `tax_id__not` string
- `tax_id__isNull` string
- `tax_id__isNotNull` string
- `tax_id__equals` string
- `tax_id__contains` string
- `tax_id__startsWith` string
- `tax_id__endWith` string
- `subscription_status` union
  - 'active' | 'pending' | 'cancelled' | 'paused' | 'trialing' | 'errored' | 'draft' | 'none'
  - string — active,pending
- `subscription_status__in` union
  - 'active' | 'pending' | 'cancelled' | 'paused' | 'trialing' | 'errored' | 'draft' | 'none'
  - string — active,pending
- `invoicing_entity_id` string
- `invoicing_entity_id__not` string
- `invoicing_entity_id__isNull` string
- `invoicing_entity_id__isNotNull` string
- `invoicing_entity_id__equals` string
- `invoicing_entity_id__contains` string
- `invoicing_entity_id__startsWith` string
- `invoicing_entity_id__endWith` string
- `segment_id` string
- `custom_properties` string
- `payment_method_type` union
  - 'card' | 'direct_debit' | 'direct_debit_ach' | 'direct_debit_bacs' | 'transfer' | 'external' | 'missing' | 'errored'
  - string — card,direct_debit
- `payment_method_type__in` union
  - 'card' | 'direct_debit' | 'direct_debit_ach' | 'direct_debit_bacs' | 'transfer' | 'external' | 'missing' | 'errored'
  - string — card,direct_debit
- `integration_entity_id` string
- `created_at` string, date-time
- `created_at__not` string, date-time
- `created_at__isNull` string, date-time
- `created_at__isNotNull` string, date-time
- `created_at__equals` string, date-time
- `created_at__lt` string, date-time
- `created_at__lte` string, date-time
- `created_at__gt` string, date-time
- `created_at__gte` string, date-time
- `updated_at` string, date-time
- `updated_at__not` string, date-time
- `updated_at__isNull` string, date-time
- `updated_at__isNotNull` string, date-time
- `updated_at__equals` string, date-time
- `updated_at__lt` string, date-time
- `updated_at__lte` string, date-time
- `updated_at__gt` string, date-time
- `updated_at__gte` string, date-time

## Response `200`

- PaginatedCustomerV1 — unresolved $ref

---

[API](https://skmtc.dev/hyperline/apis/hyperline-api.md) · [All operations](https://skmtc.dev/hyperline/apis/hyperline-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/hyperline/hyperline-api/revisions/19fa5f22e39b/schema)