Developers
Ingresar a la plataforma

Listar campos personalizados de empresa

GET/api/public/v1/company-custom-fields

Devuelve una página de campos personalizados configurados para las empresas. Admite filtros por companyCode, entityName, enabled y archived, además de paginado. La respuesta usa el formato HAL.

Autorización

apiKeyScheme
X-API-KEY<token>

En: header

Parámetros de consulta

companyCode?string

Código de la empresa a la que pertenecen los campos personalizados.

entityName?string

Nombre de la entidad de negocio para filtrar los campos personalizados.

enabled?boolean

Filtra campos personalizados habilitados o deshabilitados.

archived?boolean

Filtra campos personalizados archivados o no archivados.

page?integer

Número de página a devolver, comenzando en 0.

Formatoint32
Rango0 <= value
size?integer

Cantidad de elementos por página. Por defecto 20; un valor mayor al máximo de la operación (500 salvo que se indique otro) se recorta a ese máximo.

Formatoint32
sort?array<>

Criterios de ordenamiento, en orden de prioridad. Cada criterio se envía con índice: sort[0].property=<campo>&sort[0].direction=ASC|DESC.

Criterios de ordenamiento, enviados como sort[0].property y sort[0].direction (ASC o DESC). Sin ordenamiento explícito, el orden de los resultados no está garantizado.

property?string
direction?string

Valor en

  • "ASC"
  • "DESC"
excludeCount?boolean

Si es true, omite el cálculo del total de resultados para responder más rápido.

Cuerpo de la respuesta

application/vnd.hal+json

application/json

application/json

curl -X GET "https://example.com/api/public/v1/company-custom-fields"
{  "_embedded": {    "companyCustomFields": [      {        "name": "string",        "description": "string",        "entityName": "string",        "fieldNumber": 0,        "fieldType": "SELECTOR",        "archived": true,        "enabled": true,        "selectorValidValues": [          {            "value": "string",            "enabled": true          }        ]      }    ]  },  "_links": {    "property1": {      "href": "string",      "hreflang": "string",      "title": "string",      "type": "string",      "deprecation": "string",      "profile": "string",      "name": "string",      "templated": true    },    "property2": {      "href": "string",      "hreflang": "string",      "title": "string",      "type": "string",      "deprecation": "string",      "profile": "string",      "name": "string",      "templated": true    }  },  "page": {    "size": 0,    "totalElements": 0,    "totalPages": 0,    "number": 0  }}