---
title: "Buscar usuários"
method: GET
path: "/api/users"
tags: ["Usuários"]
---

# Buscar usuários

`GET /api/users`

## Query parameters

- `id` integer — The ID of the user to filter users by.
- `cep` string — O CEP para filtrar usuários por.
- `cpf` string — O CPF para filtrar usuários por.
- `gender` string — O gênero do usuário.
- `registerDate` string[] — Data de registro do usuário.
- `attached_at` string[] — Data de vinculação do usuário.
- `birthdate` string[] — Data de nascimento do usuário.
- `updated_at` string — Data mínima da última atualização do cadastro no formato ISO 8601.
- `blacklist` boolean — O status do usuário.

## Response `200`

- object
  - `data` object[]
    - `name` string
    - `cpf` string
    - `birthdate` string
    - `gender` string
    - `registerDate` string
    - `email` string
    - `phone` string
    - `zipcode` string
    - `balance` string
    - `updated_at` string
    - `id` string
    - `blacklist` string
    - `pdvs` object
      - `data` string[]
    - `address` object
      - `neighborhood` string
      - `state` string
      - `address` string
      - `number` string
      - `complement` string
      - `city` string
  - `links` object
    - `self` string
    - `first` string
    - `last` string
    - `prev` string
    - `next` string
  - `meta` object
    - `current_page` string
    - `from` string
    - `last_page` string
    - `links` object[]
      - `url` string
      - `label` string
      - `active` string
    - `path` string
    - `per_page` string
    - `to` string
    - `total` string

## Other responses

- `401` — Unauthorized
- `404` — Not Found
- `422` — Unprocessable Entity

---

[API](https://skmtc.dev/beepayapp/apis/beepay.md) · [All operations](https://skmtc.dev/beepayapp/apis/beepay/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/beepayapp/beepay/revisions/787a925e98a0/schema)