Fields' description and JSON of various objects returned in our API Responses.

Location

Location is an object accessible via the field location and follows the JSON structure below:

FieldTypeDescription
textstring
Required
Location text address.
latfloat
Required
Geocentric latitude of the Location.
lngfloat
Required
Geocentric longitude of the Location.
{
  "text": "Scotland", 
  "lat": "56.4907",
  "lng": "4.2026"
}

Skills

Skills is an array of objects accessible via the field skills and follows the JSON structure below:

FieldTypeDescription
namestring
Required
Identification name of the Skill.
typestring
Required
Type of the Skill. hard or soft
valuestringValue associated to the Skill.
[
  {
    "name": "communication",
    "value": null,
    "type": "soft"
  },
  {
    "name": "salesforce",
    "value": null,
    "type": "hard"
  }
]

Languages, Certifications, Courses, Tasks, Interests, Tags, Metadatas

Languages, Certifications, Courses, Tasks, Interests, Metadatas, Tags are arrays of objects following the JSON structure below:

FieldTypeDescription
namestring
Required
Identification name of the Object.
valuestringValue associated to the Object's name.
[
  {
    "name": "english",
    "value": null
  },
  {
    "name": "french",
    "value": null
  }
]
[
  {
    "name": "salesforce",
    "value": null,
  },
  {
    "name": "toefl",
    "value": null,
  }
]
[
  {
    "name": "maths",
    "value": null,
  },
  {
    "name": "physics",
    "value": null,
  }
]
[
  {
    "name": "Teaching maths",
    "value": null,
  },
  {
    "name": "Learning physics",
    "value": null,
  }
]
[
  {
    "name": "football",
    "value": null,
  },
  {
    "name": "tennis",
    "value": null,
  }
]
[
  {
    "name": "subject",
    "value": "Greetings",
  },
  {
    "name": "message",
    "value": "Hellow world!",
  }
]
[
  {
    "name": "active",
    "value": True,
  },
  {
    "name": "archived",
    "value": False,
  }
]

Labels

Labels is an array of objects accessible via the field labels and follows the JSON structure below:

FieldTypeDescription
board_keystring
Required
Identification key of the Board containing the target Job.
job_keystring
Required
Identification key of the Job.
job_referencestring
Required
Custom identifier of the Job.
stagestring
Required
Stage associated to the Profile following the action of a recruiter (yes, no, later).
date_stagedatetime ISO 8601
Required
Date of the stage edit action.
ratingintRating associated to the Profile following the action of a recruiter (from 1 to 5).
date_ratingdatetime ISO 8601
Required
Date of the rating action.
[
  {
    "board_key": "xxx", 
    "job_key": "yyy",
    "job_reference": null, 
    "stage": "yes", 
    "date_stage": "2016-01-01T00:00:00", 
    "rating": 1, 
    "date_rating": "2018-01-01T00:00:00"
  },
  {
    "board_key": "zzz", 
    "job_key": null,
    "job_key": "www", 
    "stage": "yes", 
    "date_stage": "2017-05-01T00:00:00", 
    "rating": 4, 
    "date_rating": "2020-07-01T00:00:00"
  }
]

User

FieldTypeDescription
emailstringUser email.
pseudostringUser pseudo.
first_namestringUser first name.
last_namestringUser last name.
avatar_urlstringUser avatar url.
localestringUser locale language.
positionstringUser position.
phonestringUser phone number.
"user": {
  "email": "[email protected]",
  "pseudo": "seivjobs",
  "first_name": "Mouhidine",
  "last_name": "SEIV",
  "avatar_url": "uploads/user/avatar/7c9667656278dbf5d046288c33372527403d8900.jpeg",
  "locale": "english",
  "position": null,
  "phone": null
}

URLs

URLs is an array of objects accessible via the field urls and each object follows the JSON structure below:

FieldTypeDescription
typestringIdentification name of the type of URL. The different possible values are: from_resume, linkedin, twitter, facebook, github
urlstringThe URL link.

URLs is an array of objects accessible via the field urls and follows the JSON structure below:

"urls": [
  {"type": "from_resume", "url" : "https://hrflow.ai/"},
  {"type": "from_resume", "url" : "https://developers.hrflow.ai/"},
  {"type": "linkedin", "url" : "https://fr.linkedin.com/doe-john"},
  {"type": "linkedin", "url" : "https://fr.linkedin.com/doe-jane"},
  {"type": "twitter", "url" : "https://twitter.com/hrflowai"},
  {"type": "facebook", "url" : "https://www.facebook.com/hrflowai/"},  
  {"type": "github", "url" : "https://github.com/harry-james-potter"}, 
]