Contactos

Listado de contactos

Endpoint que permite consultar los contactos registrados en la aplicación

get/contacts

Query parameters

metadataboolean

Incluye en la respuesta del request el total de contactos.

startinteger

A partir de cual contacto se desea consultar. Por ejemplo para consultar desde el contacto número 20, se envía start=20.

limitinteger

Cantidad de contactos a consultar. Por defecto tiene valor 30 y es el máximo valor que acepta. En caso de un valor superior se obtendrá un error en el response.

order_direction'DESC' | 'ASC'

Orden ascendente o descendente para el listado de contacto.

order_field'id' | 'name' | 'email'

Campo por el cual se desea ordenar.

querystring

Cadena de texto que se quiere utilizar para buscar los contactos que en el nombre o en la identificación contienen dicho texto.

identificationstring

Filtrar resultados según la identificación del contacto. Se retornarán todos los contactos que en su identificación contenga el valor enviado en este parámetro.

namestring

Filtrar resultados según el nombre del contacto. Se retornarán todos los contactos que en su nombre contenga el valor enviado en este parámetro.

type'client' | 'provider'

Filtrar por clientes o proveedores, para filtrar por clientes se debe enviar 'client', para filtrar por proveedores 'provider'.

mode'simple' | 'advanced'

El modo simple permite traer los contacts excluyendo los siguientes atributos: seller, term, priceList, internalContacts, accountReceivable, debtToPay. El modo avanzado retorna el contact sin excluir ninguno de los atributos.

Response

Se obtiene listado de contactos

0 required— unresolved $ref
OR
1 required— unresolved $ref
OR
2 required— unresolved $ref
OR
3 required— unresolved $ref
OR
4 required— unresolved $ref
OR
5 required— unresolved $ref
OR
6 required— unresolved $ref
OR
7 required— unresolved $ref
OR
8 required— unresolved $ref
OR
9 required— unresolved $ref
OR
11 required— unresolved $ref
OR
12 required— unresolved $ref
OR
13 required— unresolved $ref
OR
14 required— unresolved $ref
OR
15 required— unresolved $ref
OR
16 required— unresolved $ref
OR
17 required— unresolved $ref

Changes

No recorded changes to this endpoint across all 1 revision of this API.