GET: /profile/parsing

This endpoint allows you to get the Parsing object.

One of key , reference or email parameters should be provided to identify the profile.

get
Get /profile/parsing

https://api.hrflow.ai/v1/profile/parsing
Request
Response
Request
Headers
X-API-KEY
required
string
Authentication token.
X-USER-EMAIL
required
string
User's email.
Query Parameters
source_key
required
string
The source unique identifier
key
optional
string
The profile unique identifier
reference
optional
string
The profile's reference
email
optional
string
The profile's email
Response
200: OK
Parsing object successfully retrieved.
{
'content_uid': 'content_uid',
'key': 'profile_key',
'file_name': 'filename.pdf',
'file_size': null,
'persons': [{'full_name': 'Harry Potter',
'first_name': 'Harry',
'last_name': 'Potter'}],
'emails': ['harry.potter@gmail.com'],
'phones': ['0202'],
'location': {
'text': '803 Green Lane London N07 8MA',
'lat': 51.581551,
'lng': -0.099649,
'geojson': {
'house': null,
'category': null,
'near': null,
'house_number': 803,
'road': 'Green Lane',
'unit': null,
'level': null,
'staircase': null,
'entrance': null,
'po_box': null,
'postcode': null,
'suburb': null,
'city_district': null,
'city': 'London',
'island': null,
'state_district': null,
'state': null,
'country_region': null,
'country': 'UK',
'world_region': null}},
'images': null,
'picture': 'https://riminder-documents-eu-2019-12.s3-eu-west-1.amazonaws.com/picture.png',
'urls': [
{'type': 'from_resume', 'url': []},
{'type': 'linkedin', 'url': null},
{'type': 'twitter', 'url': null},
{'type': 'facebook', 'url': null},
{'type': 'github', 'url': null}],
'gender': 'male',
'driving_licence': null,
'summary': 'Brief summary',
'text': 'Profile s text' ,
'text_language': 'en'
'educations': [
{'content_uid': 'content_uid',
'title': 'Mathematicien'
'school': 'University',
'description': 'Education description',
'date_start': {
'iso8601': '2016-01-01T00:00:00',
'text': '2016-01-01',
'timestamp': 1451602800},
'date_end': {
'iso8601': '2018-01-01T00:00:00',
'text': '2018-01-01',
'timestamp': 1514761200},
'location': {'geojson': {'category': null,
'city': null,
'city_district': null,
'country': null,
'country_region': null,
'entrance': null,
'house': null,
'house_number': null,
'island': null,
'level': null,
'near': null,
'po_box': null,
'postcode': null,
'road': null,
'staircase': null,
'state': null,
'state_district': null,
'suburb': null,
'unit': null,
'world_region': null},
'lat': null,
'lng': null,
'text': null}}
],
'educations_duration': 2,
'experiences': [
{'content_uid': 'content_uid',
'title': 'Data scientist'
'company': 'Mathematic Departement',
'description': 'Experience s description',
'date_start': {'iso8601': '2018-01-01T00:00:00',
'text': '2018-01-01',
'timestamp': 1467324000},
'date_end': {'iso8601': '2018-07-01T00:00:00',
'text': '2018-07-01',
'timestamp': 1530396000},
'location': {'geojson': {'category': null,
'city': null,
'city_district': null,
'country': null,
'country_region': null,
'entrance': null,
'house': null,
'house_number': null,
'island': null,
'level': null,
'near': null,
'po_box': null,
'postcode': null,
'road': null,
'staircase': null,
'state': null,
'state_district': null,
'suburb': null,
'unit': null,
'world_region': null},
'lat': null,
'lng': null,
'text': null}
}],
'experiences_duration': 0.7,
'skills': [{'name':'manual skill', 'type': 'hard', 'value': null},
{'name':'Creative spirit', 'type': 'soft','value': null},
{'name':'Writing skills', 'type': 'hard','value': null},
{'name':'Communication', 'type': 'soft','value': null}],
'languages': [{'name':'english', 'value': null}],
'interests': [{'name':'football', 'value': null}]
}
400: Bad Request
Could not find a source matching this query.
{
"code": 400,
"message": "Invalid source fields"
}
401: Unauthorized
Invalid secret key.
{
"code": 401,
"message": "Unauthorized. Invalid secret key: xxxxx for permission: all"
}

Example

Python
Javascript
Python
from hrflow import Hrflow
client = Hrflow(api_secret="Your API Key", api_user="Your API user email")
client.profile.parsing.get(source_key="source_key",
key="profile_key",
# OR
reference='profile_reference',
# OR
email='example@example.com')
Javascript
import Hrflow from 'hrflow';
const client = new Hrflow({
api_secret: 'Your API Key',
api_user: 'Your API user email',
});
client.profile.parsing.get('source_key', {
key: 'profile_key',
// or
reference: 'profile_reference'
// or
email: 'example@example.com',
}).then(response => {
console.log(response);
// ...
});