---
title: "Retorna os clientes com base nos filtros passados."
method: GET
path: "/api/v1/Client"
tags: ["Client"]
---

# Retorna os clientes com base nos filtros passados.

`GET /api/v1/Client`

## Request

- Base URL: `https://api.meucartaosim.com.br` (the document declares no server; this is the origin it was published from)
- URL: `https://api.meucartaosim.com.br/api/v1/Client`
- Auth: API key in header `Authorization`

## Query parameters

- `Name` string
- `Cpf` string
- `State` string
- `Profile` 'holder' | 'dependent'
- `Modality` 'b2c' | 'b2b'
- `Status` 'active' | 'overdue' | 'blocked' | 'canceled'
- `Page` integer
- `Limit` integer

## Response `200`

OK

- GetClientDTOCustomReturn
  - `data` GetClientDTO[], nullable
    - `id` integer
    - `cpf` string, nullable
    - `name` string, nullable
    - `socialName` string, nullable
    - `phone` string, nullable
    - `email` string, nullable
    - `hasEmail` boolean
    - `maritalStatus` string, nullable
    - `gender` string, nullable
    - `birthdate` string, date-time, nullable
    - `address` Address
      - `state` string, nullable
      - `city` string, nullable
      - `neighborhood` string, nullable
      - `zipCode` string, nullable
      - `street` string, nullable
      - `number` string, nullable
      - `complement` string, nullable
      - `latitude` string, nullable
      - `longitude` string, nullable
    - `hasEmailVerified` boolean
    - `hasEmailOrWhatsappVerified` boolean
    - `pendingBills` integer
    - `profile` 'holder' | 'dependent'
    - `status` 'active' | 'overdue' | 'blocked' | 'canceled'
    - `modality` 'b2c' | 'b2b'
    - `b2BDetails` B2BDetails
      - `company` Establishment
        - `cnpj` string, nullable
        - `fantasyName` string, nullable
        - `name` string, nullable
        - `citySubscription` string, nullable
        - `stateSubscription` string, nullable
        - `simplesNacional` string, nullable
        - `phone` string, nullable
        - `url` string, nullable
        - `cnpjCard` string, nullable
        - `logo` string, nullable
        - `contract` string, nullable
        - `storeFront` string, nullable
        - `cnae` Cnae
          - `code` string, nullable
          - `description` string, nullable
        - `address` Address
          - `state` string, nullable
          - `city` string, nullable
          - `neighborhood` string, nullable
          - `zipCode` string, nullable
          - `street` string, nullable
          - `number` string, nullable
          - `complement` string, nullable
          - `latitude` string, nullable
          - `longitude` string, nullable
        - `id` integer
        - `plan` string, nullable
      - `holder` GetClientDTO (recursive)
    - `b2CDetails` B2CDetails
      - `holder` GetClientDTO (recursive)
      - `plan` string, nullable
  - `total` integer
  - `responseTime` integer
  - `feedback` string, nullable
  - `status` 'Continue' | 'SwitchingProtocols' | 'Processing' | 'EarlyHints' | 'OK' | 'Created' | 'Accepted' | 'NonAuthoritativeInformation' | 'NoContent' | 'ResetContent' | 'PartialContent' | 'MultiStatus' | 'AlreadyReported' | 'IMUsed' | 'MultipleChoices' | 'MovedPermanently' | 'Found' | 'SeeOther' | 'NotModified' | 'UseProxy' | 'Unused' | 'TemporaryRedirect' | 'PermanentRedirect' | 'BadRequest' | 'Unauthorized' | 'PaymentRequired' | 'Forbidden' | 'NotFound' | 'MethodNotAllowed' | 'NotAcceptable' | 'ProxyAuthenticationRequired' | 'RequestTimeout' | 'Conflict' | 'Gone' | 'LengthRequired' | 'PreconditionFailed' | 'RequestEntityTooLarge' | 'RequestUriTooLong' | 'UnsupportedMediaType' | 'RequestedRangeNotSatisfiable' | 'ExpectationFailed' | 'MisdirectedRequest' | 'UnprocessableEntity' | 'Locked' | 'FailedDependency' | 'UpgradeRequired' | 'PreconditionRequired' | 'TooManyRequests' | 'RequestHeaderFieldsTooLarge' | 'UnavailableForLegalReasons' | 'InternalServerError' | 'NotImplemented' | 'BadGateway' | 'ServiceUnavailable' | 'GatewayTimeout' | 'HttpVersionNotSupported' | 'VariantAlsoNegotiates' | 'InsufficientStorage' | 'LoopDetected' | 'NotExtended' | 'NetworkAuthenticationRequired'
  - `notifications` ReturnError[], nullable
    - `type` string, nullable
    - `message` string, nullable
    - `code` string, nullable
  - `warnings` ReturnError[], nullable
    - `type` string, nullable
    - `message` string, nullable
    - `code` string, nullable

## Other responses

- `404`: Not Found

---

[API](https://skmtc.dev/meucartaosim/apis/cartaosim-api.md) - [All operations](https://skmtc.dev/meucartaosim/apis/cartaosim-api/llms.txt) - [OpenAPI document](https://skmtc.dev/meucartaosim/apis/cartaosim-api/revisions/d17228159154?raw)
