Introduction

This RESTful JSON API uses HTTP GET, POST, PUT, DELETE Requests to communicate with the System.

HTTP/1.1 Status Codes:

  • 200 OK
  • 201 Created
  • 202 Accepted
  • 204 No Content
  • 301 Moved Permanently
  • 302 Found
  • 303 See Other
  • 304 Not Modified
  • 400 Bad Request
  • 401 Unauthorized
  • 402 Payment Required
  • 403 Forbidden
  • 404 Not Found
  • 405 Method Not Allowed
  • 406 Not Acceptable
  • 408 Request Time-out
  • 409 Conflict
  • 410 Gone
  • 411 Length Required
  • 412 Precondition Failed
  • 414 Request-URI Too Large
  • 415 Unsupported Media Type
  • 416 Requested range not satisfiable
  • 500 Internal Server Error
  • 501 Not Implemented
  • 502 Bad Gateway
  • 505 HTTP Version not supported



JSON Errors (HTTP/1.1 STATUS CODES 4xx & 5xx)

{
  "success": false,
  "error": {
    "message": "The email field is required.",
    "code": 400
  }
}

Single Response (HTTP/1.1 STATUS CODES 2xx)

{
    "success": true,
    "data": {
        "id": 1,
    }
}

Collection Response (HTTP/1.1 STATUS CODES 2xx)

{
  "success": true,
  "items" : {
    "per_page" : 15,
    "from" : 1,
    "data" : [
      {
        "id" : 1,
      }
    ],
    "total" : 1,
    "current_page" : 1,
    "last_page" : 1,
    "to" : 1
  }
}

Area

  • GET

  • index

  • api/v1/areas?api_token={api_token}
Display a listing of the company's areas.

Parameters

  • PARAMETER
    TYPE
    DESCRIPTION
    VALUE
  • api_token
    string
    Required. Your api token.

  • GET

  • show

  • api/v1/areas/{area_id}?api_token={api_token}
Display the specified area.

Parameters

  • PARAMETER
    TYPE
    DESCRIPTION
    VALUE
  • api_token
    string
    Required. Your api token.
  • area_id
    string
    Required. The code of an area.

AttendanceRecord

  • POST

  • store

  • api/v1/attendance_record?api_token={api_token}

Parameters

  • PARAMETER
    TYPE
    DESCRIPTION
    VALUE
  • api_token
    string
    Required. Your api token.
  • data
    string
    array of objects [
    {
    number_employee : (string) number employee "required"
    clock_name : (string) clock name "required"
    longitude : (string) longitude
    latitude : (string) latitude
    place : (string) place
    record_type_id : (integer) record type
    1. Check in time / Hora de entrada.
    2. Check out time / Hora de salida.
    3. Lunch time start / Comienzo de la hora del almuerzo.
    4. Lunch time finish / Finaliza la hora del almuerzo.
    date_access : (datetime) date access at "required" format "YYYY-MM-DD hh:mm:ss"
    timezone : (string) timezone default "America/Monterrey"
    }
    ]
    Required. The data records to save.

AttendanceRequest

  • GET

  • index

  • api/v1/attendance_requests?api_token={api_token}
Displays a listing of the all attendance requests on the last month by default.

Parameters

  • PARAMETER
    TYPE
    DESCRIPTION
    VALUE
  • api_token
    string
    Required. Your api token.
  • approbation_date
    string
    Optional date formatted as "YYYY-MM-DD". A specific approbation date. For filtering.
  • employee_id
    string
    Optional. The code of the affected employee. For filtering.
  • ending_date
    string
    Optional date formatted as "YYYY-MM-DD". A specific ending date. For filtering.
  • final_approbation_date
    string
    Optional date formatted as "YYYY-MM-DD" or "YYYY-MM-DD hh:mm:ss". The final range of the approbation date. It will be ignored if the parameter approbation_date is setted. For filtering.
  • final_ending_date
    string
    Optional date formatted as "YYYY-MM-DD" or "YYYY-MM-DD hh:mm:ss". The final range of the ending date. It will be ignored if the parameter ending_date is setted. For filtering.
  • final_requesting_date
    string
    Optional date formatted as "YYYY-MM-DD" or "YYYY-MM-DD hh:mm:ss". The final range of the requesting date. It will be ignored if the parameter requesting_date is setted. For filtering.
  • final_starting_date
    string
    Optional date formatted as "YYYY-MM-DD" or "YYYY-MM-DD hh:mm:ss". The final range of the starting date. It will be ignored if the parameter starting_date is setted. For filtering.
  • initial_approbation_date
    string
    Optional date formatted as "YYYY-MM-DD" or "YYYY-MM-DD hh:mm:ss". The initial range of the approbation date. It will be ignored if the parameter approbation_date is setted. For filtering.
  • initial_ending_date
    string
    Optional date formatted as "YYYY-MM-DD" or "YYYY-MM-DD hh:mm:ss". The initial range of the ending date. It will be ignored if the parameter ending_date is setted. For filtering.
  • initial_requesting_date
    string
    Optional date formatted as "YYYY-MM-DD" or "YYYY-MM-DD hh:mm:ss". The initial range of the requesting date. It will be ignored if the parameter requesting_date is setted. For filtering.
  • initial_starting_date
    string
    Optional date formatted as "YYYY-MM-DD" or "YYYY-MM-DD hh:mm:ss". The initial range of the starting date. It will be ignored if the parameter starting_date is setted. For filtering.
  • requesting_date
    string
    Optional date formatted as "YYYY-MM-DD". A specific requesting date. For filtering.
  • starting_date
    string
    Optional date formatted as "YYYY-MM-DD". A specific starting date. For filtering.
  • starting_time
    string
    Optional date formatted as "YYYY-MM-DD" hh:mm:ss. A specific starting date time. For filtering.
  • ending_time
    string
    Optional date formatted as "YYYY-MM-DD" hh:mm:ss. A specific ending date time. For filtering.
  • status
    string
    Optional. The status of the request: in_revision, approved, rejected, canceled. For filtering.
  • type
    string
    Optional. The type of request:

    absence: Falta
    administrative_days: Días administrativos
    assistance: Asistencia
    break: Descanso
    disability_accident_at_work: Incapacidad (Accidente en trabajo)
    disability_maternity: Incapacidad (Maternidad)
    disability_occupational_risk: Incapacidad (Riesgo de trabajo)
    early_arrival: Llegada temprano
    early_departure: Salida temprano
    extra_hours: Horas extras
    half_day: Medio día de vacaciones
    half_foul: Media falta
    incapacity: Incapacidad (Enfermedad general)
    late_arrival: Llegada tarde
    late_departure: Salida tarde
    permission_without_payment: Permiso sin goce de sueldo
    special_permission: Permiso especial
    vacation: Vacaciones

  • GET

  • show

  • api/v1/attendance_requests/{attendance_request_id}?api_token={api_token}
Display the specified attendance request.

Parameters

  • PARAMETER
    TYPE
    DESCRIPTION
    VALUE
  • api_token
    string
    Required. Your api token.
  • attendance_request_id
    int
    Required. The key of the attendance request.

CostCenter

  • GET

  • index

  • api/v1/cost_centers?api_token={api_token}
Display a listing of the const centers.

Parameters

  • PARAMETER
    TYPE
    DESCRIPTION
    VALUE
  • api_token
    string
    Required. Your api token.

  • GET

  • show

  • api/v1/cost_centers/{cost_center_id}?api_token={api_token}
Display the specified cost center.

Parameters

  • PARAMETER
    TYPE
    DESCRIPTION
    VALUE
  • api_token
    string
    Required. Your api token.
  • cost_center_id
    string
    Required. The code of a cost center.

CustomizedField

  • GET

  • index

  • api/v1/customized_fields?api_token={api_token}
Display a listing of the resource.

Parameters

  • PARAMETER
    TYPE
    DESCRIPTION
    VALUE
  • api_token
    string
    Required. Your api token.
  • employee_id
    string
    Optional. A code of an employee. For filtering.
  • section
    string
    Optional. The section in the profile: documents, others, or personal. For filtering.
  • type
    string
    Optional. The type of field: boolean, date, document, file, choice, multiline, number, or text. For filtering.

  • GET

  • show

  • api/v1/customized_fields/{customized_field_id}?api_token={api_token}
Display the specified resource.

Parameters

  • PARAMETER
    TYPE
    DESCRIPTION
    VALUE
  • api_token
    string
    Required. Your api token.
  • customized_field_id
    int
    Required. The key of a customized field.

Employee

  • GET

  • index

  • api/v1/employees?api_token={api_token}
Display a listing of the employees.
fields: It can contain the next fields separated by comma.
  • academic_degree: The academic degree
  • address_external_number: The address external number
  • address_internal_number: The address internal number
  • address_street: The address street
  • address_suburb: The address suburb
  • allergies
  • approbation_date: The approbation date of the employee incorporation formatted as YYYY-MM-DD.
  • area_id: The ID of the working area
  • area_name: The name of the working area
  • bank: The bank CLABE of the employee
  • base_seniority_date: The base seniority date of the employee
  • blood_type: The blood type
  • boss_id: The employee ID of the direct superior
  • boss_name: The full name of the direct superior
  • complexion: The phisical complexion
  • contact_email: A contact e-mail
  • cost_center_id: The ID of the cost center
  • cost_center_name: The name of the cost center
  • current_country: The name of the country of residence
  • current_municipality: The name of the town, city or municipallity of residence
  • current_state: The name of the state or province of residence
  • dob: The date of birth formatted as YYYY-MM-DD
  • effective_date: The effective date of the employee available in YYYY-MM-DD format (Field available to know when the integrated daily salary is taken).
  • emergency_contact: A record of an emergency contact
  • end_date: The working termination date of the employee formatted as YYYY-MM-DD (Field available for terminated employees).
  • eyes_color: The eyes color
  • first_name: The first name
  • full_address: The full address
  • full_name: The full name
  • gender: The sex gender
  • has_union: The employee is unionized.
  • hair_color: The hair color
  • height
  • home_phone: The home phone
  • integrated_salary: The integrated salary
  • last_name: The last name
  • locality_id: The ID of the work locality
  • locality_name: The name of the work locality
  • marital_status: The marital status
  • mobile_phone: The mobile phone number
  • national_identification_number: CURP
  • national_identity_card: IFE
  • origin_country: The name of the birth country
  • origin_municipality: The name of the town, city or municipality country
  • origin_state: The name of the state or province country
  • payment_type:Payment type of the employee.
  • personal_email: A personal e-mail
  • person_details: The phisical person details
  • phone: The work phone number
  • phone_ext: The work phone extention number
  • position_id: The ID of the job position
  • position_name: The name of the job position
  • professional_licensure: Número de cédula profesional
  • salary: Salario mensual/Montlhy salary
  • second_last_name: The second last name
  • social_security_number: Número de seguridad social NSS
  • start_date: The start working date formatted as YYYY-MM-DD
  • style
  • tax_id: RFC
  • termination_id: The ID of the termination cuase (Field available for terminated employees).
    1. He never was an employee / Nunca fue empleado.
    2. Finalized contract / Término de contrato.
    3. Desertion / Abandono de empleo.
    4. Death / Defunción.
    5. Other reason / Otra razón.
    6. Retirement / Jubilación.
    7. Better economic offer or development / Mejor oferta económica o de desarrollo.
    8. Work environment / Ambiente de trabajo.
    9. Relation with his superior / Relación con jefe.
    10. Residence changing / Cambio de residencia.
  • work_permit: FM3
  • worker_type: indicates the type of worker
    • permanent: Permanent / Permanente
    • eventual: Eventual
    • eventual_construction: Eventual construction / Eventual de la construcción
  • zip_code: The ZIP code
To retrieve some specific fields add them separated by comma to the GET variable named 'fields'.
Example: https://api.people-cloud.com/api/v1/employees?fields=full_name,dob,boss_id,position_id

Parameters

  • PARAMETER
    TYPE
    DESCRIPTION
    VALUE
  • api_token
    string
    Required. Your api token.
  • fields
    string
    Optional. A comma separated list of fields to query. Example: full_name,dob,boss_id,position_id
  • status
    string
    Optional. 'active' (default) or 'inactive'.

  • GET

  • create

  • api/v1/employees/create?api_token={api_token}
Create Employee.
Requirements for employee creation:
For the creation an object with the following parameters is needed:

Parameters

  • PARAMETER
    TYPE
    DESCRIPTION
    VALUE
  • api_token
    string
    Required. Your api token.
  • id
    string
    Required. The code of the employee.
  • basic_seniority
    string
    Optional. The basic seniority date formatted as "YYYY-MM-DD".
  • contact_email
    string
    Required. An e-mail address.
  • effective_date
    string
    Optional. The effective date formatted as "YYYY-MM-DD".
  • first_name
    string
    Required. The first name.
  • integrated_salary
    float
    Optional. The integrated daily wage
  • last_name
    string
    Required. The last name.
  • national_identification_number
    string
    Optional. CURP.
  • nss_date
    string
    Optional. Social security affiliation date.
  • salary
    float
    Optional. The monthly salary.
  • position_id
    string
    Required. The code of the position.
  • second_last_name
    string
    Optional. The second last name.
  • social_security_number
    string
    Optional. NSS.
  • start_date
    string
    Required. The incomming date formated as "YYYY-MM-DD".
  • supervisor_employee
    string
    Optional. The employee code of the direct boss.
  • tax_id
    string
    Optional. RFC.

  • GET

  • show

  • api/v1/employees/{employee_id}?api_token={api_token}
Display the specified employee.
There can query information like:
  • academic_degree: The academic degree
  • address_external_number: The address external number
  • address_internal_number: The address internal number
  • address_street: The address street
  • address_suburb: The address suburb
  • allergies
  • approbation_date: The approbation date of the employee incorporation formatted as YYYY-MM-DD.
  • area_id: The ID of the working area
  • area_name: The name of the working area
  • bank: The bank CLABE of the employee
  • base_seniority_date: The base seniority date of the employee
  • blood_type: The blood type
  • boss_id: The employee ID of the direct superior
  • boss_name: The full name of the direct superior
  • complexion: The phisical complexion
  • contact_email: A contact e-mail
  • cost_center_id: The ID of the cost center
  • cost_center_name: The name of the cost center
  • current_country: The name of the country of residence
  • current_municipality: The name of the town, city or municipallity of residence
  • current_state: The name of the state or province of residence
  • dob: The date of birth formatted as YYYY-MM-DD
  • effective_date: The effective date of the employee available in YYYY-MM-DD format (Field available to know when the integrated daily salary is taken).
  • emergency_contact: A record of an emergency contact
  • end_date: The working termination date of the employee formatted as YYYY-MM-DD (Field available for terminated employees).
  • eyes_color: The eyes color
  • first_name: The first name
  • full_address: The full address
  • full_name: The full name
  • gender: The sex gender
  • has_union: The employee is unionized.
  • hair_color: The hair color
  • height
  • home_phone: The home phone
  • integrated_salary: The integrated salary
  • last_name: The last name
  • locality_id: The ID of the work locality
  • locality_name: The name of the work locality
  • marital_status: The marital status
  • mobile_phone: The mobile phone number
  • national_identification_number: CURP
  • national_identity_card: IFE
  • origin_country: The name of the birth country
  • origin_municipality: The name of the town, city or municipality country
  • origin_state: The name of the state or province country
  • payment_type:Payment type of the employee.
  • personal_email: A personal e-mail
  • person_details: The phisical person details
  • phone: The work phone number
  • phone_ext: The work phone extention number
  • position_id: The ID of the job position
  • position_name: The name of the job position
  • professional_licensure: Número de céula profesional
  • salary: Salario mensual/Montlhy salary
  • second_last_name: The second last name
  • social_security_number: Número de seguridad social NSS
  • start_date: The start working date formatted as YYYY-MM-DD
  • style
  • tax_id: RFC
  • termination_id: The ID of the termination cuase (Field available for terminated employees).
    1. He never was an employee / Nunca fue empleado.
    2. Finalized contract / Término de contrato.
    3. Desertion / Abandono de empleo.
    4. Death / Defunción.
    5. Other reason / Otra razón.
    6. Retirement / Jubilación.
    7. Better economic offer or development / Mejor oferta económica o de desarrollo.
    8. Work environment / Ambiente de trabajo.
    9. Relation with his superior / Relación con jefe.
    10. Residence changing / Cambio de residencia.
  • work_permit: FM3
  • worker_type: indicates the type of worker
    • permanent: Permanent / Permanente
    • eventual: Eventual
    • eventual_construction: Eventual construction / Eventual de la construcción
  • zip_code: The ZIP code
To retrieve some specific fields add them separated by comma to the GET variable named 'fields'.

Parameters

  • PARAMETER
    TYPE
    DESCRIPTION
    VALUE
  • api_token
    string
    Required. Your api token.
  • employee_id
    string
    Required. The code of an employee.
  • fields
    string
    Optional. A comma separated list of fields to query. Example: full_name,dob,boss_id,position_id

  • PUT

  • update

  • api/v1/employees/{employee_id}?api_token={api_token}
update Num employee.
Requirements to update num employees:

Parameters

  • PARAMETER
    TYPE
    DESCRIPTION
    VALUE
  • api_token
    string
    Required. Your api token.
  • employee_id
    string
    Required. The code of the employee.
  • new_id
    string
    Required. The new number of the employee

  • DELETE

  • destroy

  • api/v1/employees/{employee_id}?api_token={api_token}
Delete Employee.
Requirements to remove employees:

Parameters

  • PARAMETER
    TYPE
    DESCRIPTION
    VALUE
  • api_token
    string
    Required. Your api token.
  • employee_id
    string
    Required. The employee code.
  • comments
    string
    Optional. Comments.
  • reason
    string
    Optional. Reason.
  • id_reason
    int
    Required. The id of the termination reason.
    5 He never was an employee / Nunca fue empleado.
    6 Finalized contract / Término de contrato.
    8 Desertion / Abandono de empleo.
    9 Death / Defunción.
    11 Other reason / Otra razón.
    12 Rescission of contract / Rescisión de contrato.
    13 Retirement / Jubilación.
    14 Pension / Pensión.
    15 Better economic offer or development / Mejor oferta económica o de desarrollo.
    16 Work environment / Ambiente de trabajo.
    17 Relation with his superior / Relación con jefe.
    18 Residence changing / Cambio de residencia.
    22 Performance / Desempeño.
    23 Lack of honesty / Falta de probidad.
    24 Personal situation / Situación personal.
    25 Closure / Clausura.
    26 Absenteeism / Ausentismo.
  • application_date
    string
    Required. The application date formated as "YYYY-MM-DD".

FieldAnswer

  • GET

  • index

  • api/v1/employees/{employee_id}/field_answers?api_token={api_token}
Display a listing of the resource.

Parameters

  • PARAMETER
    TYPE
    DESCRIPTION
    VALUE
  • api_token
    string
    Required. Your api token.
  • employee_id
    string
    Required. The code of an employee.

  • POST

  • store

  • api/v1/employees/{employee_id}/field_answers?api_token={api_token}
Store the specified resource.

Parameters

  • PARAMETER
    TYPE
    DESCRIPTION
    VALUE
  • api_token
    string
    Required. Your api token.
  • employee_id
    string
    Required. The code of an employee.
  • customized_field_id
    int
    Required. The key of the customized field.
  • value
    string
    Optional. The new value of the customized field.

  • GET

  • show

  • api/v1/employees/{employee_id}/field_answers/{customized_field_id}?api_token={api_token}
Display the specified resource.

Parameters

  • PARAMETER
    TYPE
    DESCRIPTION
    VALUE
  • api_token
    string
    Required. Your api token.
  • employee_id
    string
    Required. The code of an employee.
  • customized_field_id
    int
    Required. The key of the customized field.

  • GET

  • file

  • api/v1/employees/{employee_id}/field_answers/{customized_field_id}/file?api_token={api_token}
Display the specified file of the resource.

Parameters

  • PARAMETER
    TYPE
    DESCRIPTION
    VALUE
  • api_token
    string
    Required. Your api token.
  • employee_id
    string
    Required. The code of an employee.
  • customized_field_id
    int
    Required. The key of the customized field.

Hiring

  • GET

  • index

  • api/v1/employees/{employee_id}/hiring_information?api_token={api_token}
Display the hiring information of an employee.

Parameters

  • PARAMETER
    TYPE
    DESCRIPTION
    VALUE
  • api_token
    string
    Required. Your api token.
  • employee_id
    string
    Required. The code of an employee.

Relative

  • GET

  • index

  • api/v1/employees/{employee_id}/relatives?api_token={api_token}
Display a listing of the relatives of an employee.
There can query information like:
  • dob: The date of birth formatted as YYYY-MM-DD
  • home_phone: The home phone
  • job
  • street: The street address
  • suburb: The suburb address
  • zip_code: The ZIP code
  • country: The country name
  • state: The state or province name
  • municipality: The town, city or municipallity name
  • full_name: The full name
  • first_name: The first name
  • last_name: The last name
  • second_last_name: The second last name
  • is_beneficiary: Is the employee's beneficiary
  • relation :This field indicates the type of relationship with the user.
    1. mother / madre.
    2. father / padre.
    3. son / hijo.
    4. spouse / esposo(a).
    5. brother / hermano.
    6. grandparent / abuelo.
    7. uncle / tio.
    8. cousin / primo.
    9. other / otro.
To retrieve some specific fields add them separated by comma to the GET variable named 'fields'.
Example: https://api.people-cloud.com/api/v1/employees/{employee_id}/relatives?fields=full_name,dob,country

Parameters

  • PARAMETER
    TYPE
    DESCRIPTION
    VALUE
  • api_token
    string
    Required. Your api token.
  • employee_id
    string
    Required. The code of an employee.
  • fields
    string
    Optional. A comma separated list of fields to query. Example: full_name,street

  • GET

  • create

  • api/v1/employees/{employee_id}/relatives/create?api_token={api_token}
Add employee relative.
Requirements for add employee relative:
For the creation an object with the following parameters is needed:

Parameters

  • PARAMETER
    TYPE
    DESCRIPTION
    VALUE
  • api_token
    string
    Required. Your api token.
  • employee_id
    int
    Required. The code of an employee.
  • first_name
    string
    Required. The first name of the relative.
  • last_name
    string
    Required. The last name of the relative.
  • second_last_name
    string
    The second last name of the relative.
  • relation
    int
    The relation with the relative (1:mother, 2:father, 3:son, etc).
  • phone
    string
    The phone of the relative.
  • job
    string
    The job of the relative.
  • dob
    string
    The date of birth of the relative.
  • street
    string
    The street address.
  • suburb
    string
    The suburb address.
  • zip_code
    string
    The zip code address.
  • country
    string
    The country name.
  • state
    string
    The state name.
  • municipality
    string
    The municipality name.
  • is_beneficiary
    boolean
    Is the beneficiary of the employee? (1:true, "true":true, 0:false, "false":false).

  • GET

  • show

  • api/v1/employees/{employee_id}/relatives/{relative_id}?api_token={api_token}
Display the specified relative of an employee.
There can query information like:
  • dob: The date of birth
  • home_phone: The home phone
  • job
  • street: The street address
  • suburb: The suburb address
  • zip_code: The ZIP code
  • country: The country name
  • state: The state or province name
  • municipality: The town, city or municipallity name
  • full_name: The full name
  • first_name: The first name
  • last_name: The last name
  • second_last_name: The second last name
  • is_beneficiary: Is the employee's beneficiary
  • relation :This field indicates the type of relationship with the user.
    1. mother / madre.
    2. father / padre.
    3. son / hijo.
    4. spouse / esposo(a).
    5. brother / hermano.
    6. grandparent / abuelo.
    7. uncle / tio.
    8. cousin / primo.
    9. other / otro.
To retrieve some specific fields add them separated by comma to the GET variable named 'fields'.
Example: https://api.people-cloud.com/api/v1/employees/{employee_id}/relatives/{relative_id}?fields=full_name,dob,country

Parameters

  • PARAMETER
    TYPE
    DESCRIPTION
    VALUE
  • api_token
    string
    Required. Your api token.
  • employee_id
    string
    Required. The code of an employee.
  • relative_id
    string
    Required. The key of a relative.
  • fields
    string
    Optional. A comma separated list of fields to query. Example: full_name,street

Locality

  • GET

  • index

  • api/v1/localities?api_token={api_token}
Display a listing of the localities.

Parameters

  • PARAMETER
    TYPE
    DESCRIPTION
    VALUE
  • api_token
    string
    Required. Your api token.

  • GET

  • show

  • api/v1/localities/{locality_id}?api_token={api_token}
Display the specified locality.

Parameters

  • PARAMETER
    TYPE
    DESCRIPTION
    VALUE
  • api_token
    string
    Required. Your api token.
  • locality_id
    string
    Required. The code of a locality.

Movement

  • GET

  • index

  • api/v1/movements?api_token={api_token}
Display a listing of the all staff movements on the last month by default.
  • status: The status of the staff movement.
    1. "pending" - Pendiente
    2. "authorized" - Autorizado
    3. "rejected" - Rechazado
    4. "recruitment" - Reclutamiento
    5. "applied" - Aplicado
    6. "canceled" - Cancelado
  • type: The type of the staff movement.
    1. Employee enrollment/Alta de empleado.
    2. Employee termination/Baja de empleado
    3. Salary updating/Cambio de sueldo.
    4. Promotion/Promoción.
    5. Enrollment of a new job position/Alta nueva plaza.
    6. Job position termination/Baja de puesto.
    7. Transference/Transferencia.
    8. Enrollment of a request recruitment/Alta de solicitud de reclutamiento.
    9. Organizational structure movement/Movimiento de estructura organizacional.

Parameters

  • PARAMETER
    TYPE
    DESCRIPTION
    VALUE
  • api_token
    string
    Required. Your api token.
  • affected_employee_end_date
    string
    Optional date formatted as "YYYY-MM-DD". The working termination date of the affected employee. Available for terminated employees. For filtering.
  • affected_employee_id
    string
    Optional. Optional. The code of the affected employee. For filtering.
  • affected_employee_start_date
    string
    Optional date formatted as "YYYY-MM-DD". The working start date of the affected employee. For filtering.
  • application_date
    string
    Optional date formatted as "YYYY-MM-DD". A specific application date. For filtering.
  • approbation_date
    string
    Optional date formatted as "YYYY-MM-DD". A specific approbation date. For filtering.
  • creation_date
    string
    Optional date formatted as "YYYY-MM-DD". A specific creation date. For filtering.
  • creator_employee_id
    string
    Optional. The code of the creator employee. For filtering.
  • final_affected_employee_end_date
    string
    Optional date formatted as "YYYY-MM-DD". The final range of the working termination date of the affected employee. It will be ignored if the parameter affected_employee_end_date is setted. For filtering.
  • final_affected_employee_start_date
    string
    Optional date formatted as "YYYY-MM-DD". The final range of the working start date of the affected employee. It will be ignored if the parameter affected_employee_start_date is setted. For filtering.
  • final_application_date
    string
    Optional date formatted as "YYYY-MM-DD" or "YYYY-MM-DD hh:mm:ss". The final range of the application date. It will be ignored if the parameter application_date is setted. For filtering.
  • final_approbation_date
    string
    Optional date formatted as "YYYY-MM-DD" or "YYYY-MM-DD hh:mm:ss". The final range of the approbation date. It will be ignored if the parameter approbation_date is setted. For filtering.
  • final_creation_date
    string
    Optional date formatted as "YYYY-MM-DD" or "YYYY-MM-DD hh:mm:ss". The final range of the creation date. It will be ignored if the parameter creation_date is setted. For filtering.
  • initial_affected_employee_end_date
    string
    Optional date formatted as "YYYY-MM-DD". The initial range of the working termination date of the affected employee. It will be ignored if the parameter affected_employee_end_date is setted. For filtering.
  • initial_affected_employee_start_date
    string
    Optional date formatted as "YYYY-MM-DD". The initial range of the working start date of the affected employee. It will be ignored if the parameter affected_employee_start_date is setted. For filtering.
  • initial_application_date
    string
    Optional date formatted as "YYYY-MM-DD" or "YYYY-MM-DD hh:mm:ss". The initial range of the application date. It will be ignored if the parameter application_date is setted. For filtering.
  • initial_approbation_date
    string
    Optional date formatted as "YYYY-MM-DD" or "YYYY-MM-DD hh:mm:ss". The initial range of the approbation date. It will be ignored if the parameter approbation_date is setted. For filtering.
  • initial_creation_date
    string
    Optional date formatted as "YYYY-MM-DD" or "YYYY-MM-DD hh:mm:ss". The initial range of the creation date. It will be ignored if the parameter creation_date is setted. For filtering.
  • status
    string
    Optional. The status of the staff movement: applied, authorized, canceled, pending, recruitment, and rejected.
  • type
    int
    Optional. The type of the staff movement: as 1 (Employee enrollment), 2 (Employee termination) ,3 (Salary updating) , etc.

  • GET

  • show

  • api/v1/movements/{movement_id}?api_token={api_token}
Display the specified staff movement.

Parameters

  • PARAMETER
    TYPE
    DESCRIPTION
    VALUE
  • api_token
    string
    Required. Your api token.
  • movement_id
    int
    Required. The key of the movement.

OrganizationalLevel

  • GET

  • index

  • api/v1/organizational_levels?api_token={api_token}
Display a listing of the organizational levels.

Parameters

  • PARAMETER
    TYPE
    DESCRIPTION
    VALUE
  • api_token
    string
    Required. Your api token.

  • GET

  • show

  • api/v1/organizational_levels/{organizational_level_id}?api_token={api_token}
Display the specified organizational level.

Parameters

  • PARAMETER
    TYPE
    DESCRIPTION
    VALUE
  • api_token
    string
    Required. Your api token.
  • organizational_level_id
    string
    Required. The code of an organizational level.

Position

  • GET

  • index

  • api/v1/positions?api_token={api_token}
Display a listing of the job positions.

Parameters

  • PARAMETER
    TYPE
    DESCRIPTION
    VALUE
  • api_token
    string
    Required. Your api token.

  • GET

  • show

  • api/v1/positions/{position_id}?api_token={api_token}
Display the specified job position.

Parameters

  • PARAMETER
    TYPE
    DESCRIPTION
    VALUE
  • api_token
    string
    Required. Your api token.
  • position_id
    string
    Required. The code of a job position.

Requisition

  • GET

  • index

  • api/v1/requisitions?api_token={api_token}
Display a listing of the requisition.

Parameters

  • PARAMETER
    TYPE
    DESCRIPTION
    VALUE
  • api_token
    string
    Required. Your api token.

  • GET

  • show

  • api/v1/requisitions/{requisition_id}?api_token={api_token}
Display a listing of the requisition.

Parameters

  • PARAMETER
    TYPE
    DESCRIPTION
    VALUE
  • api_token
    string
    Required. Your api token.
  • requisition_id
    string
    Required. The code of an requisition.

PublishNetworks

  • GET

  • index

  • api/v1/requisitions/{requisition_id}/publish_networks?api_token={api_token}
Display a listing of the requisition.

Parameters

  • PARAMETER
    TYPE
    DESCRIPTION
    VALUE
  • api_token
    string
    Required. Your api token.
  • requisition_id
    string
    Required. Your requisition id.

RequisitionCandidates

  • GET

  • index

  • api/v1/requisition_candidates?api_token={api_token}
Display a listing of the Cadidates of an publication.
There can query information like:
  • full_name: The full name of the candidate
  • id_publication: The id of the publication where He belong
  • id: The candiate id
  • email: The email of the candidate

Parameters

  • PARAMETER
    TYPE
    DESCRIPTION
    VALUE
  • api_token
    string
    Required. Your api token.

  • GET

  • create

  • api/v1/requisition_candidates/create?api_token={api_token}
Add a new cadidate to an publication/requisition .
Requirements for add Candidate
For the creation an object with the following parameters is needed:

Parameters

  • PARAMETER
    TYPE
    DESCRIPTION
    VALUE
  • api_token
    string
    Required. Your api token.
  • id_publication
    int
    Required. The code of publication/requisition.
  • first_name
    string
    Required. The first name of the candidate.
  • last_name
    string
    Required. The last name of the candidate.
  • second_last_name
    string
    The second last name of the candidate.
  • gender
    string
    The gender of the candidate
  • dob
    string
    The date of birth of the candidate.
  • contact_email
    string
    Required. An e-mail address.
  • state
    string
    The state name.
  • city
    string
    The city name.
  • street
    string
    The street address.
  • external_number
    string
    The external number of his home.
  • suburb
    string
    The suburb address.
  • zip_code
    string
    The zip code address.
  • phone
    string
    The phone of the candidate.

  • GET

  • show

  • api/v1/requisition_candidates/{id_publication}?api_token={api_token}
Display the specified candidate of an requisition.
There can query information like:
  • full_name: The full name of the candidate
  • id_publication: The id of the publication where He belong
  • id: The candiate id
  • email: The email of the candidate

Parameters

  • PARAMETER
    TYPE
    DESCRIPTION
    VALUE
  • api_token
    string
    Required. Your api token.
  • id_publication
    int
    The ID of the publication.

Trajectory

  • GET

  • index

  • api/v1/employees/{employee_id}/trajectory?api_token={api_token}
fields: It can contain the next fields separated by comma.
  • internal_employee_id: The internal_employee_id is equal to the id shown in the data.
  • end_date: The working termination date of the employee formatted as YYYY-MM-DD (Field available for terminated employees).
  • position_id: The id of the job position
  • salary: Salario mensual/Montlhy salary
  • start_date: The start working date formatted as YYYY-MM-DD
  • movement_type: Movement type
    1. Employee registration / Alta de empleado
    2. Salary increase / Incremento de sueldo
    3. Promotion / Promoción
    4. Exchange / Intercambio
    5. Transfer / Transferencia
    6. Increase report / Reporte de incremento
    7. Salary modification / Modificación de salario
To retrieve some specific fields add them separated by comma to the GET variable named 'fields'.
> Example: https://api.people-cloud.com/api/v1/employees/{employee_id}/?fields=end_date,salary,position_id

Parameters

  • PARAMETER
    TYPE
    DESCRIPTION
    VALUE
  • api_token
    string
    Required. Your api token.
  • employee_id
    string
    Required. The code of an employee.
  • fields
    string
    Optional. A comma separated list of fields to query. Example: full_name,street