/users/v1/Buscar Usuarios
El endpoint /users/v1/ te permite buscar un grupo de usuarios y recibir una lista ordenada en base a los parámetros especificados.
Consideraciones
Tendrás que especificar tus filtros como parámetros siguiendo este patrón: filter[campo]=valor. Por ejemplo: /users/v1/?filter[status]=ACTIVE
Para filtrar un atributo con varios valores posibles, deberás separar los valores con comas.
Veamos un ejemplo: filter[status]=ACTIVE,BLOCKED
Los resultados serán paginados y podrás especificar la cantidad de datos por página y también qué página ver utilizando: page[number]=valor y page[size]=valor
Ordenamiento
Podrás especificar el orden de los resultados con determinados parámetros que deberás enviar como una lista de strings en el filtro de tipo sort\. Por ejemplo: ?filter[status]=ACTIVE&sort=status,gender
El ordenamiento por defecto será ascendente. Para especificar un orden descendente, deberás enviar el carácter '-' como prefijo del atributo. Por ejemplo: /users/v1/?filter[status]=ACTIVE&sort=status,-gender
Los posibles atributos para ordenar son:
idgenderidentification_typeidentification_valuestatus
Si un parámetro es incorrecto o está mal escrito, responderemos con un error.
Parámetros disponibles
Detalle de respuestas
curl -X GET "https://api.pomelo.la/users/v1/?filter[identification_value]=example_value&filter[identification_type]=DNI&filter[tax_identification_type]=CUIL&filter[tax_identification_value]=example_value&filter[gender]=MALE&filter[birthdate]=1998-08-20&filter[name]=Juan&filter[surname]=Rodriguez&filter[email][email protected]&filter[status]=example_value&filter[country_code]=example_value&filter[company_id]=cmp-123e4567e89b12d3a456&filter[tax_condition]=VAT_REGISTERED&page[size]=123&page[number]=123&sort=id,-name" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_KEY"{
"data": [
{
"id": "usr-203c6jQq0O3nVWXj6jRUQXy7QkC",
"name": "Diego",
"surname": "Pomelo",
"identification_type": "DNI",
"identification_value": 42345678,
"birthdate": "1998-08-20",
"gender": "MALE",
"email": "[email protected]",
"phone": "1123456789",
"tax_identification_type": "CUIL",
"tax_identification_value": 20423456789,
"nationality": "ARG",
"tax_condition": "VAT_REGISTERED",
"status": "ACTIVE",
"operation_country": "ARG",
"legal_address": {
"street_name": "Av. Corrientes",
"street_number": 300,
"floor": 1,
"apartment": "A",
"zip_code": 1414,
"neighborhood": "Villa Crespo",
"city": "CABA",
"region": "Buenos Aires",
"additional_info": "Torre 2",
"country": "ARG"
}
}
],
"meta": {
"pagination": {
"total_pages": 1,
"current_page": 0
},
"filters": [
{
"key": "status",
"value": [
"ACTIVE",
"BLOCKED"
]
}
]
}
}