User/Get
POST https://customerapi.geovictoria.com/api/v1/User/Get
Descripción
Obtener la información detallada de uno o varios usuarios de la empresa asociada al token de autenticación,
consultando por su identificador.
Devuelve un array con un elemento por cada identificador enviado, indicando en el campo Found si el usuario fue encontrado o no.
Request
Request Body
| Campos | Tipo de dato | Obligatorio | Descripción |
|---|---|---|---|
| Identifiers | String | Sí | Identificador del usuario. Para consultar varios usuarios en una misma llamada, se envían los identificadores separados por coma (,). Máximo 500 identificadores por request. |
Ejemplo request
{
"Identifiers": "12345678-9,98765432-1"
}
Importante
- Se devuelven tanto los usuarios habilitados como los deshabilitados. El estado se informa en el campo Enabled.
- El array de respuesta contiene un elemento por cada identificador enviado. Si un
identificador no existe en la empresa, igualmente se devuelve un elemento con Found en
“False” y solo el campo Identifier informado. - Si se envían más de 500 identificadores, el request es rechazado con el mensaje
“Max users allowed 500”. - Los campos sin valor en la ficha del usuario no se incluyen en la respuesta.
- Los campos Id, PositionId, ProfileId, SchedulerId y WeeklyWorkingHoursCodeId se entregan codificados y
deben utilizarse tal cual se reciben, sin modificaciones, al enviarlos a otros endpoints. - La empresa no se envía en el request: se determina a partir del token de autenticación.
Response
Response Body
La respuesta es un objeto con el resultado de la operación:
| Campos | Tipo de dato | Descripción |
|---|---|---|
| Success | Boolean | Indica si la operación fue exitosa. |
| Message | String | Mensaje descriptivo del resultado (vacío o informativo en caso de éxito, detalle del error en caso de fallo). |
| Response | Array | Array con los usuarios consultados, uno por cada identificador enviado. |
Cada objeto del array Response contiene:
| Campos | Tipo de dato | Descripción |
|---|---|---|
| Found | String | Indica si el usuario fue encontrado. Valores posibles: “True” / “False”. |
| Identifier | String | Identificador del usuario, tal como fue enviado en el request. |
| Id | String | Identificador interno del usuario, entregado codificado. Debe usarse tal cual se recibe. |
| Enabled | String | Estado del usuario. “1” habilitado, “0” deshabilitado. |
| Name | String | Nombre del usuario. |
| LastName | String | Apellido del usuario. |
| String | Correo electrónico corporativo del usuario. | |
| PersonalEmail | String | Correo electrónico personal del usuario. |
| GroupDescription | String | Nombre del grupo al que pertenece el usuario. |
| CostCenterCode | String | Código del centro de costos del usuario. |
| PositionId | String | Identificador del cargo del usuario, entregado codificado. |
| PositionDescription | String | Nombre del cargo del usuario. |
| ProfileId | String | Identificador del perfil del usuario, entregado codificado. |
| UserProfile | String | Nombre del perfil del usuario. |
| WeeklyWorkingHoursCodeId | String | Identificador del código de jornada de trabajo del usuario, entregado codificado. |
| WeeklyWorkingHoursCodeDescription | String | Descripción del código de jornada de trabajo del usuario. |
| SchedulerId | String | Identificador del planificador asignado al usuario, entregado codificado. |
| SchedulerStart | String | Fecha de inicio del planificador, en formato yyyyMMddHHmmss. |
| SchedulerPeriodStart | String | Fecha de inicio del ciclo del planificador, en formato yyyyMMddHHmmss. |
| ContractDate | String | Fecha de contratación del usuario, en formato yyyyMMddHHmmss. |
| EndContractDate | String | Fecha de término de contrato (desactivación automática) del usuario, en formato yyyyMMddHHmmss. |
| Birthdate | String | Fecha de nacimiento del usuario, en formato yyyyMMdd. |
| Address | String | Dirección del usuario. |
| Phone | String | Teléfono del usuario. |
| TradeName | String | Razón social asociada al usuario. |
| UserCompanyIdentifier | String | Identificador de la razón social asociada al usuario. |
| UserCard | String | Número de tarjeta del usuario. |
| IntegrationCode | String | Código de integración del usuario. |
| PIS | String | Número PIS del usuario (Brasil). |
| LegalSundayIndicator | String | Indica si al usuario se le aplican domingos legales. “1” aplica, “0” no aplica. |
| HasArt22 | String | Indica si el usuario está acogido al artículo 22. Valores posibles: “True” / “False”. |
| IsHiddenForReports | String | Indica si el usuario se oculta en los reportes. Valores posibles: “True” / “False”. |
| HideInReports | String | Indica si el usuario se oculta en los reportes. Valores posibles: “True” / “False”. |
| CustomColumn1 | String | Valor de la columna personalizada 1 del usuario. |
| CustomColumn2 | String | Valor de la columna personalizada 2 del usuario. |
| CustomColumn3 | String | Valor de la columna personalizada 3 del usuario. |
Códigos
| Código | Descripción |
|---|---|
| 200 | Éxito |
| 400 | Error en el request |
Ejemplo response
{
"Success": true,
"Message": "",
"Response": [
{
"Id": "kK9xQ2vHtA==",
"Identifier": "12345678-9",
"Enabled": "1",
"Name": "Juan",
"LastName": "Pérez",
"Email": "juan.perez@empresa.com",
"PersonalEmail": "juanperez@gmail.com",
"GroupDescription": "Casa Matriz",
"CostCenterCode": "CC-100",
"PositionId": "pL3mR7bXyC==",
"PositionDescription": "Analista",
"WeeklyWorkingHoursCodeId": "rT5nW9dZqE==",
"WeeklyWorkingHoursCodeDescription": "45 horas semanales",
"CustomColumn1": "Turno A",
"IsHiddenForReports": "False",
"ContractDate": "20230301000000",
"EndContractDate": "",
"SchedulerId": "sM4kP8cVzB==",
"SchedulerStart": "20230301000000",
"SchedulerPeriodStart": "20230301000000",
"IntegrationCode": "EMP-0451",
"UserCompanyIdentifier": "76543210-K",
"Birthdate": "19900215",
"Address": "Av. Providencia 1234",
"Phone": "+56912345678",
"UserProfile": "Usuario",
"TradeName": "Empresa Ejemplo SpA",
"UserCard": "0001234",
"LegalSundayIndicator": "0",
"HideInReports": "False",
"HasArt22": "False",
"ProfileId": "vN6jQ1fYwD==",
"Found": "True"
},
{
"Identifier": "98765432-1",
"Found": "False"
}
]
}