---
title: "Search users by a phone number."
method: GET
path: "/user/by_phone"
tags: ["user"]
---

# Search users by a phone number.

`GET /user/by_phone`

Perform a user search using the phone number.

## Query parameters

- `q` string, required

## Response `200`

List of users matching the applied criteria

- CustomerServiceUser[]
  - `id` string
  - `pid` integer
  - `email` string
  - `username` string
  - `first_name` string
  - `last_name` string
  - `home_phone` string
  - `shipping_phone` string
  - `billing_phone` string

## Other responses

- `304` — If the If-None-Match header is sent and matches with the Etag it will return the 304 (Not Modified) response without the data on the body.
- `400` — An error occurred while performing the search

---

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