Documentación
Ir a AlegraForoNovedadesContactoX/Twitter

Listado de contactos

get
https://api.alegra.com/api/v1/contacts

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

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
boolean

Incluye en la respuesta del request el total de contactos.

integer
≥ 0

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

integer
≥ 1

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.

string
enum
Defaults to ASC

Orden ascendente o descendente para el listado de contacto.

Allowed:
string
enum

Campo por el cual se desea ordenar.

Allowed:
string

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

string

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.

string

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.

string
enum

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

Allowed:
string
enum

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.

Allowed:
Responses

Updated 6 months ago

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 6 months ago