> ## Documentation Index
> Fetch the complete documentation index at: https://docs.clubfix.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

# Obtém o cliente pelo documento

> Este endpoint obtém o cliente pelo seu CPF mencionado na URL

<ParamField header="Authorization" type="string" required>
  Token de autenticação do tipo Bearer obtido através do endpoint de login.
</ParamField>


## OpenAPI

````yaml GET /customers/{document}
openapi: 3.0.3
info:
  title: Clubfix Webservice de Parceiros
  description: >-
    Bem vido(a) à documentação do **Webservice de Parceiros** da **Clubfix.** Os
    recursos aqui dispostos são suplementados com exemplos de respostas
    esperadas, para nortear a implementação. Caso haja algum empecilho ou erro
    não esperado, fique à vontade para chamar o suporte em TI pelos canais que
    você já conhece.


    Observação: Utilize sempre os cabeçalhos `Content-Type` e `Accept` como
    `application/json`


    #### **URL Base**


    | **Ambiente** | **URL** |

    | --- | --- |

    | Homologação | [https://homolog.clubfix.com.br/webservice]() |

    | Produção | [https://clubfix.com.br/webservice]() |


    > NOTA: Para conseguir utilizar ambos ambientes, faz-se necessário solicitar
    pelo nosso time de suporte a geração das chaves de autenticação mencionadas
    na seção de **Autenticação**. 
      

    #### Paginação


    Para navegar nos recursos de listagem através de suas páginas, utilize as
    `parâmeros` dispostas na tabela abaixo


    | **Parâmetro** | **Descrição** |

    | --- | --- |

    | page | Corresponde à pagina que você deseja exibir os dados. |

    | per_page | Altera a quantidade de itens devolvidos em uma requisição. |

    | current_page | Identifica a pagina correspondente àquela requisição. |


    ### **Conhecendo os erros comuns**


    | **Status Code** | **Descrição** |

    | --- | --- |

    | 422 | Erro em algum parâmetro fornecido. O resultado deste erro será um
    objeto, onde a sua chave indicará o campo que não está em conformidade. |

    | 401 | Não autorizado. Significa que há ausência de um token válido na
    requisição, seja por expiração, não fornecimento, ou, no caso do login, as
    suas credenciais não estão corretas. |

    | 5** | Erro de servidor no endpoint requisitado. Quando isso ocorrer,
    contate o nosso suporte. |
  version: 1.0.0
servers: []
security: []
paths:
  /customers/{document}:
    get:
      summary: Obter o cliente
      description: Este endpoint obtém o cliente pelo seu CPF mencionado na URL
      parameters:
        - name: Authorization
          in: header
          required: true
          schema:
            type: string
          example: application/json
        - name: document
          in: path
          required: true
          schema:
            type: string
          example: application/json
        - name: include
          in: query
          required: false
          schema:
            type: string
          example: annual-sales
      responses:
        '200':
          description: Buscar cliente pelo CPF
          content:
            application/json:
              example:
                id: 12
                name: Emanuelly Carolina Carolina Teixeira
                document: '80615114105'
                phone: '32863751018'
                email: emanuelly@email.com
                address:
                  street: Rua Natal Bertoldo da Silva
                  number: 976
                  complement: null
                  zipcode: '74988670'
                  neighborhood: Nova Olinda
                  city: Aparecida de Goiânia
                  state: GO
              schema:
                type: object
                properties:
                  id:
                    type: integer
                  name:
                    type: string
                  document:
                    type: string
                  phone:
                    type: string
                  email:
                    type: string
                  address:
                    type: object
                    properties:
                      street:
                        type: string
                      number:
                        type: integer
                      complement:
                        type: string
                      zipcode:
                        type: string
                      neighborhood:
                        type: string
                      city:
                        type: string
                      state:
                        type: string

````