---
title: "People"
method: GET
path: "/v1/customers"
---

# People

`GET /v1/customers`

## Request

- Base URL: `https://api.octapi.app`
- URL: `https://api.octapi.app/v1/customers`
- Auth: HTTP bearer

## Query parameters

- `q` string
- `source` string

## Response `200`

Default Response

- object
  - `customers` object[], required
    - `id` string, required
    - `name` string, required
    - `phone` string, nullable, required
    - `email` string, nullable, required
    - `date_of_birth` union, required
      - string
      - string, date-time
    - `notes` string, nullable, required
    - `tags` string[], nullable, required
    - `dietary` string, nullable
    - `student_name` string, nullable
    - `sources` string[], nullable

---

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