Export Recruitment Report Data via API Integration

The integration flow with BrioHR will consist 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/recruitment-report/download

Available Data Modes for applicationDateMode:

Filter Syntax:
Filters are passed via the query parameter using pipe-delimited format:
fieldName|operator|value

Multiple filters are joined with AND (URL-encoded as %20AND%20)

Multi-values are separated by @x@ (e.g. job|includes|jobId1@x@jobId2)

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/recruitment-report/download?
format=csv&company=&resource=recruitment

Expected output: recruitment_report.csv

Example of CURL 

curl -o recruitment.csv --location
'https://static.api.briohr.com/v2/api/external/reports/recruitmentreport/
download?format=csv' \
--header 'Authorization: Basic aHotYXBwOmJyaW9ocg==' \
--header 'x-api-context-company: 412cc8a9d90158c489b83e83' \
--header 'x-resource-type: recruitment'

Example of CURL with Date Filter (Last 30 Days)

curl -o recruitment.csv --location
'https://static.api.briohr.com/v2/api/external/reports/recruitmentreport/
download?format=csv&query=applicationDateMode|eq|LAST_30_DAYS' \
--header 'Authorization: Basic aHotYXBwOmJyaW9ocg==' \
--header 'x-api-context-company: 412cc8a9d90158c489b83e83' \
--header 'x-resource-type: recruitment'

Example of CURL with Custom Date Range

curl -o recruitment.csv --location
'https://static.api.briohr.com/v2/api/external/reports/recruitmentreport/
download?format=csv&query=applicationDateMode|eq|CUSTOM AND
applicationDateCustomDates|gte|2026-01-01 AND
applicationDateCustomDates|lte|2026-03-27' \
--header 'Authorization: Basic aHotYXBwOmJyaW9ocg==' \
--header 'x-api-context-company: 412cc8a9d90158c489b83e83' \
--header 'x-resource-type: recruitment'

Example of CURL with Custom Date Range + Job Filter

curl -o recruitment.csv --location
'https://static.api.briohr.com/v2/api/external/reports/recruitmentreport/
download?format=csv&query=applicationDateMode|eq|CUSTOM AND
applicationDateCustomDates|gte|2026-01-01 AND
applicationDateCustomDates|lte|2026-03-27 AND
job|includes|64a1b2c3d4e5f6a7b8c9d0e1@x@64a1b2c3d4e5f6a7b8c9d0e2' \
--header 'Authorization: Basic aHotYXBwOmJyaW9ocg==' \
--header 'x-api-context-company: 412cc8a9d90158c489b83e83' \
--header 'x-resource-type: recruitment'

Example of CURL for PowerBI

curl -o recruitment.csv --location
'https://static.api.briohr.com/v2/api/external/reports/recruitmentreport/
download?
format=csv&query=applicationDateMode|eq|LAST_30_DAYS&company=412cc8a9d9
0158c489b83e83&resource=recruitment' \
--header 'Authorization: Basic aHotYXBwOmJyaW9ocg=='

Example of CSV Output

"name","job","active","appliedDate","firstName","lastName","preferredNa
me","email","mobilePhone","gender","birthAt","source","status","hiringM
anager","recruiter","expectedSalaryCurrency","expectedSalary","previous
SalaryCurrency","previousSalary","noticePeriod","yearsOfExperience","jo
bGrade","specialization","currentLocation","linkedIn","github","screeni
ngAverageRating","interviewAverageRating"
"John Doe","Software Engineer","true","2026-03-
15","John","Doe","John","john.doe@example.com","+60123456789","Male","1
990-05-20","LinkedIn","interview","Jane Smith","Bob
Wilson","MYR","8000","MYR","6500","2","5","L3","Backend
Development","Kuala
Lumpur","https://linkedin.com/in/johndoe","https://github.com/johndoe",
"4.2","3.8"
"Sarah Lee","Product Manager","true","2026-03-
10","Sarah","Lee","Sarah","sarah.lee@example.com","+60198765432","Femal
e","1992-08-15","Indeed","screening","Alex Tan","Bob
Wilson","MYR","12000","MYR","10000","3","8","L4","Product
Management","Penang","https://linkedin.com/in/sarahlee","","3.5",""

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.