Developers
Ingresar a la plataforma

Listar personas

GET/api/public/v1/people

Devuelve una página de personas. Admite filtros por texto, email, teléfono, estado (status), rol, supervisor, empresa y fechas, entre otros, además de paginado. La respuesta usa el formato HAL.

Autorización

apiKeyScheme
X-API-KEY<token>

En: header

Parámetros de consulta

page?integer

Número de página a consultar (0-indexed).

Formatoint32
size?integer

Cantidad de resultados por página.

Formatoint32
sort?array<>

Criterios de ordenamiento de los resultados.

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"
exclude?array<string>

Lista de uniqueCode de personas a excluir del resultado.

include?array<string>

Lista de uniqueCode de personas: si se informa, sólo se devuelven esas personas (combinado con el resto de los filtros).

text?string

Texto libre para buscar por nombre, apellido o correo electrónico de la persona.

companyCode?array<string>

Lista de códigos de empresas por las que filtrar.

costCenterCode?string

Código del centro de costos por el que filtrar.

email?string

Correo electrónico por el que filtrar.

phoneNumber?string

Número de teléfono por el que filtrar.

phoneNumberLastDigits?string

Últimos dígitos del número de teléfono por los que filtrar.

active?boolean

Filtra por personas activas o inactivas.

externalId?string

Identificador en el sistema externo por el que filtrar.

roles?array<string>

Lista de roles por los que filtrar.

dateFrom?string

Fecha desde la cual filtrar por fecha de creación.

Formatodate-time
dateTo?string

Fecha hasta la cual filtrar por fecha de creación.

Formatodate-time
lastModifiedDateFrom?string

Fecha desde la cual filtrar por fecha de última modificación.

Formatodate-time
lastModifiedDateTo?string

Fecha hasta la cual filtrar por fecha de última modificación.

Formatodate-time
status?array<>

Lista de estados (ACTIVE, INACTIVE) por los que filtrar.

Valor en

  • "ACTIVE"
  • "INACTIVE"
supervisorCodes?array<string>

Lista de códigos de supervisores por los que filtrar.

employeeFile?array<string>

Lista de legajos o números de empleado por los que filtrar.

companyTaxIdentificationType?array<>

Lista de tipos de identificación fiscal de la empresa por los que filtrar.

Valores válidos por cluster:

ClusterValores
MéxicoRFC
ArgentinaDNI, CUIT
CMFRUT

Valor en

  • "RFC"
  • "CNPJ"
  • "CUIT"
  • "CUIL"
  • "CPF"
  • "NIT"
  • "RUC"
  • "RUT"
  • "CPF / CNPJ"
companyTaxIdentificationValue?array<string>

Lista de valores de identificación fiscal de la empresa por los que filtrar.

Cuerpo de la respuesta

application/vnd.hal+json

application/json

application/json

curl -X GET "https://example.com/api/public/v1/people?email=ana.lopez%40empresa.com"
{  "_embedded": {    "persons": [      {        "deleted": true,        "uniqueCode": "0590843e-1d92-4d51-82c6-4a22a6b8be82",        "companyCode": "string",        "lastModifiedDate": "2024-11-13T16:51:00.000Z",        "createdDate": "2024-11-13T16:51:00.000Z",        "createdBy": "string",        "externalId": "string",        "lastUpdatedByFullName": "string",        "name": "Ana",        "lastName": "López",        "secondLastName": "string",        "fullName": "Ana López",        "phoneNumber": "string",        "phoneCountryCode": "string",        "validPhone": true,        "email": "ana.lopez@empresa.com",        "economicGroupCode": "string",        "taxIdentificationType": "CUIL",        "taxIdentificationValue": "string",        "identificationType": "DNI",        "identificationValue": "string",        "costCenterUniqueCode": "string",        "address": {          "line1": "string",          "line2": "string",          "city": "string",          "state": "string",          "zipCode": "string"        },        "logoURL": "string",        "employeeFile": "string",        "nationality": "MEX",        "birthCountry": "MEX",        "genderType": "MALE",        "birthDate": "1990-05-20",        "personalIdentificationCompleted": true,        "active": true,        "lastUpdatedBy": "string",        "companyCodes": [          "string"        ],        "policyGroupsName": [          "string"        ],        "supervisor": {          "uniqueCode": "string",          "email": "ana.lopez@empresa.com"        },        "costCenter": {          "uniqueCode": "string",          "name": "string",          "externalId": "string"        },        "taxIdentificationExempt": true,        "languageTag": "string",        "customFields": [          {            "fieldName": "string",            "value": "string",            "fieldNumber": 0          }        ],        "globalEmployeeFile": "string",        "assistants": [          {            "uniqueCode": "string",            "fullName": "Ana López",            "email": "ana.lopez@empresa.com"          }        ],        "passports": [          {            "uniqueCode": "string",            "name": "string",            "lastName": "string",            "countryCode": "MEX",            "passportNumber": "string",            "expirationDate": "2019-08-24"          }        ],        "login": {          "lastLogin": "2024-11-13T16:51:00.000Z"        },        "externalInformation": {          "externalRoleName": "string"        }      }    ]  },  "_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  }}