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

# Listar entregadores

> Retorna os entregadores ativos e inativos do estabelecimento, em ordem alfabética. Entregadores removidos não são retornados.

Use `filters[name_cont]` para buscar por parte do nome, sem diferenciação entre maiúsculas e minúsculas. Use `filters[status_eq]` para filtrar pelo status público.

Você pode combinar os dois filtros. Sem filtros, a consulta retorna ativos e inativos. Envie `name_cont` com 1 a 200 caracteres e `status_eq` com `active` ou `inactive`.

Exemplo:

```http
GET /api/partner/v1/drivers?filters[name_cont]=JOÃO&filters[status_eq]=inactive
```

O parâmetro `q` retorna `400`, mesmo quando você também envia `filters`. Filtros desconhecidos, nomes vazios ou acima do limite, status inválidos e valores em formato de objeto ou lista também retornam `400`.

**Autenticação:** OAuth 2.0 com escopo `drivers`. Não aceita API Key.

**Rate limit:** 300 requisições a cada 3 minutos.



## OpenAPI

````yaml /reference/api-entregadores.json get /api/partner/v1/drivers
openapi: 3.1.0
info:
  title: API Entregadores
  version: '1.0'
  description: >-
    A API de entregadores lista os entregadores cadastrados no estabelecimento.


    ## Autenticação


    Apps da CW App Store usam `Authorization: Bearer <access_token>` (OAuth 2.0)
    com escopo `drivers`.


    Esta API não aceita API Key.


    Consulte a documentação em /autenticacao/modelos-de-autenticacao.


    ## Rate Limits


    Os endpoints de entregadores permitem **300 requisições a cada 3 minutos**.
    Consulte /sobre-a-api#rate-limits.
  contact:
    email: integracao@cardapioweb.com
    url: https://cardapioweb.com
    name: Cardápio Web
servers:
  - url: https://integracao.sandbox.cardapioweb.com
    description: Sandbox
  - url: https://integracao.cardapioweb.com
    description: Produção
security:
  - bearerAuth: []
tags:
  - name: Entregadores
    description: Consulta dos entregadores do estabelecimento.
paths:
  /api/partner/v1/drivers:
    get:
      tags:
        - Entregadores
      summary: Listar entregadores
      description: >-
        Retorna os entregadores ativos e inativos do estabelecimento, em ordem
        alfabética. Entregadores removidos não são retornados.


        Use `filters[name_cont]` para buscar por parte do nome, sem
        diferenciação entre maiúsculas e minúsculas. Use `filters[status_eq]`
        para filtrar pelo status público.


        Você pode combinar os dois filtros. Sem filtros, a consulta retorna
        ativos e inativos. Envie `name_cont` com 1 a 200 caracteres e
        `status_eq` com `active` ou `inactive`.


        Exemplo:


        ```http

        GET
        /api/partner/v1/drivers?filters[name_cont]=JOÃO&filters[status_eq]=inactive

        ```


        O parâmetro `q` retorna `400`, mesmo quando você também envia `filters`.
        Filtros desconhecidos, nomes vazios ou acima do limite, status inválidos
        e valores em formato de objeto ou lista também retornam `400`.


        **Autenticação:** OAuth 2.0 com escopo `drivers`. Não aceita API Key.


        **Rate limit:** 300 requisições a cada 3 minutos.
      operationId: list-drivers
      parameters:
        - $ref: '#/components/parameters/Page'
        - $ref: '#/components/parameters/PerPage'
        - name: filters
          in: query
          required: false
          style: deepObject
          explode: true
          description: >-
            Filtros planos da consulta. Envie somente `name_cont` e `status_eq`
            dentro de `filters`. Você pode combinar os dois campos.
          schema:
            type: object
            additionalProperties: false
            properties:
              name_cont:
                type: string
                minLength: 1
                maxLength: 200
                description: >-
                  Parte do nome do entregador. A busca não diferencia maiúsculas
                  e minúsculas.
                example: João
              status_eq:
                type: string
                enum:
                  - active
                  - inactive
                description: Status do entregador.
                example: active
      responses:
        '200':
          description: Lista de entregadores retornada com sucesso.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DriversList'
              example:
                data:
                  - id: 42
                    name: João da Silva
                    status: active
                meta:
                  page: 1
                  per_page: 20
                  total: 1
                  total_pages: 1
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
components:
  parameters:
    Page:
      name: page
      in: query
      required: false
      description: Número da página.
      schema:
        type: integer
        minimum: 1
        default: 1
    PerPage:
      name: per_page
      in: query
      required: false
      description: Quantidade de entregadores por página.
      schema:
        type: integer
        minimum: 1
        maximum: 100
        default: 20
  schemas:
    DriversList:
      type: object
      title: Lista de entregadores
      required:
        - data
        - meta
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Driver'
        meta:
          $ref: '#/components/schemas/PaginationMeta'
    Driver:
      type: object
      title: Entregador
      description: Entregador cadastrado no estabelecimento.
      required:
        - id
        - name
        - status
      properties:
        id:
          type: integer
          description: Identificador único do entregador.
          example: 42
        name:
          type: string
          description: Nome do entregador.
          example: João da Silva
        status:
          type: string
          enum:
            - active
            - inactive
          description: Indica se o entregador está disponível para novas associações.
          example: active
    PaginationMeta:
      type: object
      title: Metadados de paginação
      required:
        - page
        - per_page
        - total
        - total_pages
      properties:
        page:
          type: integer
          description: Página atual.
        per_page:
          type: integer
          description: Quantidade de registros por página.
        total:
          type: integer
          description: Quantidade total de entregadores.
        total_pages:
          type: integer
          description: Quantidade total de páginas.
    Error:
      type: object
      title: Erro
      required:
        - code
        - message
      properties:
        code:
          type: integer
          description: Código interno do erro.
        message:
          type: string
          description: Resumo do erro.
        details:
          type:
            - string
            - 'null'
          description: Detalhes sobre o erro.
  responses:
    BadRequest:
      description: >-
        Algum parâmetro enviado é inválido, incluindo o uso de `q` em vez de
        `filters`.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            code: 4000
            message: Parâmetros inválidos.
            details: Use filters no lugar de q.
    Unauthorized:
      description: Token OAuth inválido ou ausente.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Forbidden:
      description: O token não possui o escopo `drivers`.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    TooManyRequests:
      description: Muitas requisições foram feitas em um curto período.
      content: {}
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: OAuth2
      description: >-
        Access token OAuth 2.0 de app instalado na CW App Store. Escopo:
        drivers.

````