Interfaccia (API) per interrogare i dati dei dipendenti

I dati dei dipendenti di onboard possono essere interrogati tramite un’interfaccia JSON.

API Endpoint

L’endpoint può essere raggiunto tramite il seguente indirizzo:

https://<azienda>.onboard.org/exports/v2/employees.json

Header

• API-KEY: obbligatorio per l’autorizzazione. Riceverete la chiave API dal nostro team di sopporto su richiesta.

Parametri

• page: pagina visualizzata. Inizia da 1.

Esempio:

https://<azienda>.onboard.org/it/exports/v2/employees.json?page=1

Contenuto

L’interfaccia fornisce i seguenti contenuti:

• entries: Informazioni sui dipendenti
• current_page: Pagina attuale
• per_page: Voci visualizzate per pagina
• total_entries: Numero totale di voci

Le informazioni sul dipendente contengono i dati anagrafici e tutte le informazioni sul rapporto di lavoro:

• id: ID unico di onboard
• gender: Genere. Valori possibili:
  • unknown: non conosciuto / non impostato
  • male: maschile
  • female: femminile
  • diverse: diverso
  • not_defined: nicht gesetzt
• language: lingua dei dipendenti in formato ISO 639-1
• first_name: nome
• last_name: cognome
• email: indirizzo e-mail privato
• company_email: indirizzo e-mail dell’azienda
• phone: numero di telefono privato
• company_phone: telefono dell’azienda
• birthday: data di nascita nel formato YYYY-MM-DD
• tax_number: Codice fiscale italiano
• employee_number: numero del personale
• nationality: nazionalità come codice ISO del paese (ad es. “IT”)
• birthplace: luogo di nascita
• street: residenza – strada
• street_number: residenza – numero civico
• city: residenza – città
• postal_code: residenza – codice postale
• region: residenza – regione o distretto
• country_code: residenza – paese come codice ISO del paese (ad es. “IT”)
• iban: IBAN
• swift: BIC/SWIFT
• hired_at: data di assunzione nel formato AAAA-MM-GG. Può essere null se non è ancora stato impostato.
• leaving_at: data di cessazione nel formato AAAA-MM-GG. Può essere null se non è ancora stato impostato o se il dipendente non ha una data di uscita.
• employee_status_id: ID dello stato
• location_id: ID della sede
• department_id: ID del dipartimento
• supervisor_id: ID del supervisore
• created_at: Data di creazione in formato ISO 8601
• updated_at: Ultimo aggiornamento in formato ISO 8601
• photo_url: URL all’immagine del dipendente (originale)
• photo_url_big: URL all’immagine del dipendente (400x400px)
• photo_url_default: URL all’immagine del dipendente (80x80px)

Alcuni valori sono facoltativi. Se applicabile, l’interfaccia contiene campi aggiuntivi (a seconda delle impostazioni dell’azienda).

Esempio di risposta:

{
   "entries":[
      {
         "id":"RGb11O42",
         "email":"[email protected]",
         "first_name":"Max",
         "last_name":"Mustermann",
         "phone":null,
         "created_at":"2021-10-13T10:03:45.853Z",
         "updated_at":"2021-10-13T10:03:45.853Z",
         "language":"de",
         "gender":"unknown",
         "employee_status_id":4,
         "location_id":77,
         "department_id":9
      }
   ],
   "current_page":1,
   "per_page":30,
   "total_entries":1
}