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:

Field

Type

Description

text

string
Required

Location text address.

lat

float
Required

Geocentric latitude of the Location.

lng

float
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:

Field

Type

Description

name

string
Required

Identification name of the Skill.

type

string
Required

Type of the Skill. hard or soft

value

string

Value 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:

Field

Type

Description

name

string
Required

Identification name of the Object.

value

string

Value 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:

Field

Type

Description

board_key

string
Required

Identification key of the Board containing the target Job.

job_key

string
Required

Identification key of the Job.

job_reference

string
Required

Custom identifier of the Job.

stage

string
Required

Stage associated to the Profile following the action of a recruiter (yes, no, later).

date_stage

datetime ISO 8601
Required

Date of the stage edit action.

rating

int

Rating associated to the Profile following the action of a recruiter (from 1 to 5).

date_rating

datetime 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

Field

Type

Description

email

string

User email.

pseudo

string

User pseudo.

first_name

string

User first name.

last_name

string

User last name.

avatar_url

string

User avatar url.

locale

string

User locale language.

position

string

User position.

phone

string

User 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 follows the JSON structure below:

Field

Type

Description

from_resume

Array of strings

URLs from resume

linkedin

string

Linkedin Profile Url

twitter

string

Twitter Profile Url

facebook

string

Facebook Profile Url

github

string

Github Profile Url

"urls": {
  "from_resume": ["https://hrflow.ai/", "https://developers.hrflow.ai/"],
  "linkedin": "https://fr.linkedin.com/company/hrflowai",
  "twitter": "https://twitter.com/hrflowai",
  "facebook": "https://www.facebook.com/hrflowai/",
  "github": "https://github.com/Riminder"
}