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

# Listar atributos personalizados

> Catálogo del tenant para ticket, contact_person (contactos) o contact_org (organizaciones). Excluye definiciones del simulador. Una API key o un administrador puede administrar este catálogo.



## OpenAPI

````yaml /openapi.json get /custom-attributes/public/v1/{entityType}
openapi: 3.1.0
info:
  title: Revem API
  version: 1.0.0
  description: >-
    La API pública de Revem para integraciones de servidor a servidor:
    contactos, organizaciones, tickets, reuniones y el canal de webchat. Se
    autentica con la API key de tu organización.
  contact:
    name: Soporte Revem
    email: soporte@revem.ai
    url: https://revem.ai
servers:
  - url: https://api.revem.ai
    description: Producción
security:
  - apiKey: []
tags:
  - name: WhatsApp
    description: >-
      Envía plantillas aprobadas desde los números conectados de tu
      organización.
  - name: Organizaciones
    description: >-
      Sincroniza empresas por identificador tributario, con atributos
      personalizados por nombre.
  - name: Contactos
    description: >-
      Sincroniza tu base de clientes con Revem. Los contactos se identifican por
      teléfono al crearlos y por id después.
  - name: Tickets
    description: >-
      Crea, lee y actualiza los tickets de tu embudo desde tu sistema de
      gestión.
  - name: Atributos personalizados
    description: Administra definiciones para tickets, contactos y organizaciones.
  - name: Webchat
    description: >-
      Conecta el chat de tu sitio con Revem: registra lo que escribe el
      visitante y lee las respuestas del equipo o del agente.
  - name: Reuniones
    description: >-
      Requiere el módulo meetings. Reuniones independientes de las citas
      médicas, con responsable, capacidad y reservas por contacto y ocurrencia.
paths:
  /custom-attributes/public/v1/{entityType}:
    get:
      tags:
        - Atributos personalizados
      summary: Listar atributos personalizados
      description: >-
        Catálogo del tenant para ticket, contact_person (contactos) o
        contact_org (organizaciones). Excluye definiciones del simulador. Una
        API key o un administrador puede administrar este catálogo.
      operationId: listCustomAttributes
      parameters:
        - name: entityType
          in: path
          required: true
          description: ticket, contact_person o contact_org.
          schema:
            type: string
            enum:
              - ticket
              - contact_person
              - contact_org
        - name: limit
          in: query
          required: false
          description: Máximo 100.
          schema:
            default: 50
            type: integer
            minimum: 1
            maximum: 100
        - name: offset
          in: query
          required: false
          description: Usar nextOffset para la siguiente página.
          schema:
            default: 0
            type: integer
            minimum: 0
      responses:
        '200':
          description: Definiciones y siguiente página.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AttributeList'
        '400':
          description: Parámetros inválidos.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AttributeError'
        '401':
          description: Sin credencial, o la API key no existe o fue revocada.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthError'
              example:
                error: Unauthorized
                message: Invalid API key
        '403':
          description: Sin permiso.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AttributeError'
        '429':
          description: >-
            La key superó su presupuesto de unidades por minuto: una por
            solicitud individual o elemento de lote. El header `retry-after`
            indica cuánto esperar.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RateLimitError'
              example:
                ok: false
                error: Too many requests. Retry in 60 seconds.
          headers:
            retry-after:
              description: Segundos que esperar antes de reintentar.
              schema:
                type: integer
            x-ratelimit-limit:
              description: >-
                Unidades permitidas por minuto: cada solicitud individual
                consume 1; cada elemento de un lote de organizaciones consume 1.
              schema:
                type: integer
            x-ratelimit-remaining:
              description: Unidades que quedan en la ventana actual.
              schema:
                type: integer
            x-ratelimit-reset:
              description: Segundos hasta que la ventana se reinicia.
              schema:
                type: integer
components:
  schemas:
    AttributeList:
      type: object
      properties:
        attributes:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
              entityType:
                type: string
                enum:
                  - ticket
                  - contact_person
                  - contact_org
              name:
                type: string
              dataType:
                type: string
              description:
                anyOf:
                  - type: string
                  - type: 'null'
              options:
                maxItems: 5
                type: array
                items:
                  type: string
              optionCount:
                type: integer
              isRequired:
                type: boolean
              isFilterable:
                type: boolean
              isAgentVisible:
                type: boolean
              isUnique:
                type: boolean
              disabledFunnelIds:
                type: array
                items:
                  type: string
                  format: uuid
              defaultValue: 25995c43-e506-4fa2-852a-8c3cd95e5dd2
            required:
              - id
              - entityType
              - name
              - dataType
              - description
              - options
              - optionCount
              - isRequired
              - isFilterable
              - isAgentVisible
              - isUnique
              - disabledFunnelIds
              - defaultValue
            additionalProperties: false
        nextOffset:
          anyOf:
            - type: number
            - type: 'null'
      required:
        - attributes
        - nextOffset
      additionalProperties: false
      $defs:
        __schema0:
          anyOf:
            - type: string
            - type: number
            - type: boolean
            - type: 'null'
            - type: array
              items:
                $ref: '#/components/schemas/AttributeList/$defs/__schema0'
            - type: object
              additionalProperties:
                $ref: '#/components/schemas/AttributeList/$defs/__schema0'
    AttributeError:
      type: object
      properties:
        ok:
          type: boolean
        error:
          type: string
      required:
        - ok
        - error
      additionalProperties: false
    AuthError:
      type: object
      properties:
        ok:
          type: boolean
          const: false
          description: Presente sólo en el `403`.
        error:
          type: string
        message:
          type: string
      required:
        - error
        - message
    RateLimitError:
      type: object
      properties:
        ok:
          type: boolean
          const: false
        error:
          type: string
          description: Incluye cuánto esperar antes de reintentar.
      required:
        - ok
        - error
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: >-
        La API key de tu organización, con la forma `rvm_<prefijo>.<secreto>`,
        enviada como `Authorization: Bearer rvm_…`. Revem la emite y sólo se
        muestra una vez; si la pierdes se reemplaza, no se recupera.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.