Listar etiquetas

GEThttps://carchost.fieldcontrol.com.br/labels

Lista las etiquetas de la cuenta, de todos los tipos (órdenes, clientes, presupuestos, etc.). Las etiquetas se registran en el Panel del Gestor.

Requiere los headers X-Api-Key y User-Agent. Límite: 1 solicitud por segundo (más información).

Solicitud

Parámetros de consulta

limitinteger

Cantidad de ítems por página.

De 1 a 100.Predeterminado: 10.

offsetinteger

Cantidad de ítems que se omiten.

De 0 a 200000.Predeterminado: 0.

qstring

Filtros en el formato campo:valor, separados por espacios (cómo filtrar). Los filtros aceptados están en la tabla de abajo.

Ejemplo: name:Garantia.

Filtro	Qué hace
name	Nombre de la etiqueta, igual al registrado sin distinguir mayúsculas y minúsculas. De 2 a 150 caracteres.

sortstring

Ordenación. El prefijo - invierte el orden.

Valores aceptados: id, name, -name, created_at, -created_at.Predeterminado: id.

Headers

User-Agentstringobligatorio

Identificación de su aplicación.

Ejemplo: MinhaIntegracao/1.0.

Respuestas

• 200

  Lista de etiquetas.

• 401

  Clave de API ausente (Missing API Key) o inválida (Invalid API Key). Consulte Autenticación.

• 403

  Cuenta bloqueada (Account blocked), vencida (Account expired) o con un plan que no permite integración (Account plan not allowed). Consulte Autenticación.

• 422

  Filtro, paginación u ordenación inválidos (parametersValidationErr).

• 429

  Se superó el límite de 1 solicitud por segundo. Consulte Límite de solicitudes.

• 500

  Error inesperado en el servidor.