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

# Listar Categorias

> Retorna a lista de categorias da conta autenticada.

## Requisição

`GET https://crm.wavups.com/api/v1/category`

<ParamField header="Token" type="string" required>
  Seu token de autenticação.
</ParamField>

### Query Parameters

<ParamField query="status" type="string">
  Filtra categorias pelo status. Exemplo: `active` ou `inactive`.
</ParamField>

***

## Resposta

Retorna um array de objetos de categoria, ordenados do mais recente para o mais antigo.

<ResponseField name="id" type="string">
  Identificador único da categoria.
</ResponseField>

<ResponseField name="name" type="string">
  Nome da categoria.
</ResponseField>

<ResponseField name="description" type="string | null">
  Descrição da categoria.
</ResponseField>

<ResponseField name="images" type="string[] | null">
  Array de URLs das imagens da categoria (máximo 5 URLs).
</ResponseField>

<ResponseField name="status" type="string">
  Status da categoria. Padrão: `active`.
</ResponseField>

<ResponseField name="createdAt" type="string">
  Data de criação (ISO 8601).
</ResponseField>

***

## Exemplos

<RequestExample>
  ```bash GET /api/v1/category theme={null}
  curl --request GET \
    --url 'https://crm.wavups.com/api/v1/category?status=active' \
    --header 'Token: SEU_TOKEN_DE_API'
  ```
</RequestExample>

<ResponseExample>
  ```json 200 theme={null}
  [
    {
      "id": "cat_001",
      "name": "Serviços",
      "description": "Categoria de serviços oferecidos",
      "images": null,
      "status": "active",
      "createdAt": "2025-03-10T09:00:00.000Z"
    }
  ]
  ```

  ```json 500 theme={null}
  {
    "error": "Error to get products"
  }
  ```
</ResponseExample>


## OpenAPI

````yaml GET /category
openapi: 3.0.3
info:
  title: WavUps CRM API
  description: >-
    API pública da plataforma WavUps CRM — gerencie leads, produtos, categorias,
    atendimentos, agendamentos, conversas e pipelines de CRM.
  version: 1.0.0
servers:
  - url: https://crm.wavups.com/api/v1
    description: Servidor de produção
security:
  - Token: []
paths:
  /category:
    get:
      tags:
        - Categorias
      summary: Listar Categorias
      description: Retorna a lista de categorias da conta autenticada.
      operationId: listCategories
      responses:
        '200':
          description: Lista de categorias retornada com sucesso.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Category'
        '500':
          $ref: '#/components/responses/Error500'
components:
  schemas:
    Category:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        description:
          type: string
          nullable: true
        createdAt:
          type: string
          format: date-time
    ErrorMessage:
      type: object
      properties:
        error:
          type: string
          example: Recurso não encontrado.
  responses:
    Error500:
      description: Erro interno no servidor.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorMessage'
  securitySchemes:
    Token:
      type: apiKey
      in: header
      name: Token
      description: Token de autenticacao gerado na plataforma WavUps CRM.

````