---
title: "Queries customers with filtering and pagination."
method: GET
path: "/customers"
tags: ["Customer"]
---

# Queries customers with filtering and pagination.

`GET /customers`

Results are scoped to customers that belong to the caller's organization.

## Query parameters

- `page` integer
- `page_size` integer
- `sort` string[]
- `id` object
  - `eq` string
  - `neq` string
  - `gt` string
  - `gte` string
  - `lt` string
  - `lte` string
  - `contains` string
  - `starts_with` string
  - `ends_with` string
  - `in` string[]
  - `not_contains` string
- `email` object
  - `eq` string
  - `neq` string
  - `gt` string
  - `gte` string
  - `lt` string
  - `lte` string
  - `contains` string
  - `starts_with` string
  - `ends_with` string
  - `in` string[]
  - `not_contains` string
- `organization_name` object
  - `eq` string
  - `neq` string
  - `gt` string
  - `gte` string
  - `lt` string
  - `lte` string
  - `contains` string
  - `starts_with` string
  - `ends_with` string
  - `in` string[]
  - `not_contains` string
- `organization_id` object
  - `eq` string
  - `neq` string
  - `gt` string
  - `gte` string
  - `lt` string
  - `lte` string
  - `contains` string
  - `starts_with` string
  - `ends_with` string
  - `in` string[]
  - `not_contains` string
- `logic` 'and' | 'or'

## Response `200`

OK

- QueryCustomersEndpointPagedResultOfOutput
  - `total` integer, required
  - `page` integer, required
  - `pageSize` integer, required
  - `items` QueryCustomersEndpointOutput[], required
    - `id` string, uuid, required — The unique identifier of the customer.
    - `email` string, nullable, required — The email address of the customer.
    - `organizationName` string, nullable, required — The name of the organization this customer belongs to, if any.
    - `organizationId` string, nullable, required — The identifier of the organization this customer belongs to, if any.
  - `totalPages` integer

## Other responses

- `400` — Bad Request
- `401` — Unauthenticated
- `403` — Forbidden

---

[API](https://skmtc.net/rapidata/apis/rapidata-api.md) · [All operations](https://skmtc.net/rapidata/apis/rapidata-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/rapidata/rapidata-api/revisions/d779de93a5ee/schema)