Applications

This is an object representing your candidate's application in SmartRecruiters. You can create, retrieve and update an application object to keep track of a candidate's recruiting process of a specific job using the Applications API. An application is identified by pairing a unique job ID and a unique candidate ID in the current API.

{
  "firstName": "string",
  "lastName": "string",
  "email": "string",
  "phoneNumber": "string",
  "location": {
    "country": "string",
    "countryCode": "string",
    "region": "string",
    "regionCode": "string",
    "city": "string",
    "lat": 0,
    "lng": 0
  },
  "web": {
    "skype": "string",
    "linkedIn": "string",
    "facebook": "string",
    "twitter": "string",
    "website": "string"
  },
  "tags": [
    "string"
  ],
  "education": [
    {
      "institution": "string",
      "degree": "string",
      "major": "string",
      "current": true,
      "startDate": "string",
      "endDate": "string",
      "location": "string",
      "description": "string"
    }
  ],
  "experience": [
    {
      "title": "string",
      "company": "string",
      "current": true,
      "startDate": "string",
      "endDate": "string",
      "location": "string",
      "description": "string"
    }
  ],
  "sourceDetails": {
    "sourceTypeId": "string",
    "sourceSubTypeId": "string",
    "sourceId": "string"
  },
  "resume": {
    "fileName": "string",
    "mimeType": "string",
    "fileContent": "string"
  },
  "avatar": {
    "fileName": "string",
    "mimeType": "string",
    "fileContent": "string"
  },
  "attachments": [
    {
      "fileName": "string",
      "mimeType": "string",
      "fileContent": "string"
    }
  ],
  "answers": [
    {
      "id": "string",
      "records": [
        {
          "fields": {
            "additionalProp1": [
              "string"
            ],
            "additionalProp2": [
              "string"
            ],
            "additionalProp3": [
              "string"
            ]
          }
        }
      ]
    }
  ],
  "messageToHiringManager": "string",
  "consent": true,
  "consentDecisions": {
    "additionalProp1": true,
    "additionalProp2": true,
    "additionalProp3": true
  },
  "internal": true
}

The application object

firstName string
The candidate's first name

lastName string
The candidate's last name

email string
The candidate's email address. Email communication with the candidate such interview invitation and direct conversations will be send to this email address.

phoneNumber string
The candidate's phone number

location object
The candidate's location information

  • location.country string
    Name of the candidate's country of residence
  • location.countryCode string
    Two-letter, ISO 3166-1 alpha-2 formatted country code of the candidate's country of residence
  • location.regionCode string
    Four-letter ISO 3166-2:US formatted region code for regions in the United State. The regionCode field is not required and not recommend to be used for regions outside of the United States.
  • location.region string
    The candidate's area of residence description, such as state, province or voivodeship.
  • location.city string
    The candidate's city of residence
  • location.lat float
    ISO 6709 formatted latitude of the candidate's residence address
  • location.lng string
    ISO 6709 formatted longitude of the candidate's residence address

web object
The candidate's profiles from different social media sites or platforms

  • web.skype string
    The candidate's Skype profile URI
  • web.linkedin string
    The candidate's LinkedIn profile URI
  • web.facebook string
    The candidate's Facebook profile URI
  • web.twitter string
    The candidate's Twitter profile URI
  • web.website string
    Additional URI or site of the candidate

tag array of strings
Category labels that can be used to identify group of candidates

education array of objects
The candidate's education history

  • education.institution string
    The name of the institution
  • education.degree string
    The degree, diploma or certificate the candidate obtained from the institution
  • education.major string
    The specialized area of study of the candidate's degree, diploma or certificate
  • education.current boolean
    Whether the candidate is currently pursuing the degree. Set education.current=true if the candidate is currently pursuing the degree
  • education.location string
    The address of the institution
  • education.startDate string
    The start date of the candidate pursue of the degree. The value should be ISO8601-formatted date with the following format: yyyy-MM-dd
  • education.endDate string
    The last date of the candidate pursue of the degree. The value should be ISO8601-formatted date with the following format: yyyy-MM-dd
  • education.description string
    Additional description of the eduction record

experience array of objects
The candidate's work experience

  • experience.title string
    The job title of the candidate's previous role
  • experience.company string
    The name of the candidate's previous company
  • experience.current boolean
    Whether the candidate still holds the role. Set experience.current=true if the candidate is still working on the role.
  • experience.startDate string
    The start date of the candidate first held the role. The value should be ISO8601-formatted date with the following format: yyyy-MM-dd
  • experience.endDate string
    The last date of the candidate is employed for the role. The value should be ISO8601-formatted date with the following format: yyyy-MM-dd
  • experience.location string
    The address of the institution
  • experience.description string
    Additional description of the work record

sourceDetails object
An object that describes the origin of the application

  • sourceDetails.sourceTypeId string
    Unique identifier for a general group of application sources (e.g. Paid or Organic). Possible values can be retrieved from the Company API
  • sourceDetails.sourceSubTypeId string
    Unique identifier for a more defined group of application sources (e.g. Job Board). Possible values can be retrieved from the Company API
  • sourceDetails.sourceId string
    Unique identifier for a specific application source (e.g. LinkedIn). Possible values can be retrieved from the Company API

resume object
The candidate's resume of the application

  • resume.fileName string
    The name of the resume file
  • resume.mimeType string
    The media type of the resume. Possible values are defined in RFC 6838
  • resume.fileContent string
    The content of the resume file

avatar object
The candidate's profile picture

  • avatar.fileName string
    The name of the avatar file
  • avatar.mimeType string
    The media type of the avatar. Possible values are defined in RFC 6838
  • avatar.fileContent string
    The content of the avatar

attachment array of objects
Additional attachments of the application

  • attachment.fileName string
    The name of the attachment file
  • attachment.mimeType string
    The media type of the attachment. Possible values are defined in RFC 6838
  • attachment.fileContent string
    The content of the attachment file

answers array of objects
The candidate's answers to the application screening questions

  • answers.id string
    Unique identifier of the screening question. Possible values can be retrieved via the Company API
  • answers.id.records array of objects
    Answers to the set of screening questions
    • answers.id.fields object
      Key-value pairs that describe the screening questions and the respective values of each questions
      • answers.id.fields.{exampleLabel} array of strings
        An example screening question
        • answers.id.fields.{exampleLabel}.{exampleValue} string
          An example value for example screening question

consent boolean
Whether the candidate provide consent to use his/her information during the recruiting process. The default is conset=false

consentDecisions object

Internal boolean
Whether the application is an internal application. Set internal=true if the application is from an internal employee