Listar campos adicionales

get

https://api.alegra.com/api/v1/custom-fields

Endpoint que permite consultar los campos adicionales registrados en la aplicación.

Query Params

start

integer

Desde cual campo se quiere consultar. Por ejemplo para consultar desde el campo 20, se envía start=20.

limit

integer

Cantidad de campos a partir del inicio que se desea retornar. Por defecto retorna 30 atributos. Si este valor es mayor que 30, la aplicación retorna error.

name_query

string

Cadena de texto que se utiliza para consultar campos adicionales que contengan dicho texto en su nombre.

description_query

string

Cadena de texto que se utiliza para consultar campos adicionales que contengan dicho texto en su descripción.

metadata

boolean

Incluir en los resultados metadatos. Se debe tener en cuenta que si se envía este parámetro el objeto que retorna la aplicación incluye un atributo "metadata" y otro "data" en donde se envían los campos adicionales. Actualmente la información que se envía en metadata incluye el total de campos adicionales que tiene registrada la empresa.

status

string

Filtrar campos adicionales por el estado. Se retornarán todos los campos adicionales cuyo estado actual sea el enviado como parámetro.

resourceType

string

Filtrar campos adicionales por el tipo de recurso asociado. Se retornarán todos los campos adicionales que sean del tipo de recurso enviado como parámetro.

type

string

Filtrar campos adicionales por el tipo de campo. Se retornarán todos los campos adicionales que sean del tipo enviado como parámetro.

Responses

Language

Credentials

Basic

base64

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Objeto que representa la respuesta al consultar la lista de campos adicionales.

400Objeto que representa la respuesta al intentar consultar la lista de campos adicionales