GET: /profile/indexing/attachment

This endpoint allows you to get the Profile's attachment.

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

get
Get /profile/indexing/attachments

https://api.hrflow.ai/v1/profile/indexing/attachments
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 successfully retrieved.
{'code': 200,
'data': [{'alt': 'alt_key',
'created_at': '2020-09-11T09:58:32+0000',
'extension': '.pdf',
'file_name': 'resume',
'file_size': 528305,
'original_file_name': 'resume',
'public_url': 'public_url_resume',
'type': 'resume',
'updated_at': '2020-09-11T09:58:32+0000'},
{'alt': 'alt_key',
'created_at': '2020-09-11T09:58:32+0000',
'extension': '.pdf',
'file_name': 'original',
'file_size': 537789,
'original_file_name': 'original',
'public_url': 'public_url_original',
'type': 'original',
'updated_at': '2020-09-11T09:58:32+0000'}],
'message': 'Profile attachment list'}
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 "
}

Example

Python
Javascript
Python
from hrflow import Hrflow
client = Hrflow(api_secret="Your API Key", api_user="Your API user email")
client.profile.attachment.list(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.attachment.list('source_key', {
key: 'profile_key',
// or
reference: 'profile_reference'
// or
email: 'example@example.com',
}).then(response => {
console.log(response);
// ...
});