API Integrations
      Back to home
      1. BrioHR | Help Center
      2. API Integrations

      Employee Details API Integration

       

      Note: For a comprehensive overview of the BrioHR API integration flow, please refer to the article here.

       

      The integration flow with BrioHR will consists of the steps below: 

      1. Client request for the APIs/integration access together with the list of IPs (recommended for securing the line of integration).
      2. BrioHR will create the credentials for client. Consists of: Authentication credentials and client’s ID. 
      3. Client can try to connect to BrioHR API using the link, authentication & ID. 

      Report API URL: 

      https://static.api.briohr.com/v2/api/external/reports/employees-main-information/download?format=csv
       



      For Power BI & other 3rd party that cannot inject the x-api-context-company in the header:  

      https://static.api.briohr.com/v2/api/external/reports/employees-main-information/download?format=csv&company=&resource=employees-main-information Expected output: employees-main-information.csv
       

       

      Expected output: employees-main-information.csv (sample)

       

      Example of CURL 

      1 curl -o employees-main-information.csv --location 'https://static.api.briohr.com/v2/api/external/reports/employees-main-information/download?format=csv' \ 2 --header 'Authorization: Basic aHotYXBwOmJyaW9ocg==' \ 

      3 --header 'x-api-context-company: 412cc8a9d90158c489b83e83' \ 

      4 --header 'x-resource-type: employees-main-information' 

       

      Example of CURL for PowerBI 

      1 curl -o employees-main-information.csv --location 'https://static.api.briohr.com/v2/api/external/reports/employees-main-information/download? format=csv&company=412cc8a9d90158c489b83e83&resource=employees-main-information' \ 

      2 --header 'Authorization: Basic aHotYXBwOmJyaW9ocg=='

       

      NOTE:
      Kindly be informed that BrioHR will need to whitelist the client's IP and then provide the client with the username, password and company ID. 

       

      Need Assistance?

      If you have any questions regarding the API above or require assistance, please reach out to our support team via live chat or email us at support@briohr.com.