Get candidate profile for an application

GET

application

{applicationid}

profile

curl --request GET \
  --url https://jobaffinity.fr/restapi/v1/application/{applicationid}/profile \
  --header 'Authorization: Basic <encoded-value>'

{
  "_schema": "<string>",
  "identity": [
    {
      "first_name": "<string>",
      "last_name": "<string>",
      "email": "jsmith@example.com",
      "phone": "<string>",
      "address": "<string>",
      "zip_code": "<string>",
      "town": "<string>",
      "country": "<string>"
    }
  ],
  "employments": [
    {
      "start": "<string>",
      "end": "<string>",
      "readable_start": "<string>",
      "readable_end": "<string>",
      "title": "<string>",
      "employer": "<string>",
      "description": "<string>"
    }
  ],
  "educations": [
    {
      "start": "<string>",
      "end": "<string>",
      "readable_start": "<string>",
      "readable_end": "<string>",
      "title": "<string>",
      "institution": "<string>",
      "level": 123,
      "level_text": "<string>",
      "description": "<string>"
    }
  ],
  "languages": [
    {
      "name": "<string>",
      "level": 123,
      "level_name": "<string>"
    }
  ],
  "skills": [
    {
      "name": "<string>",
      "level": 123,
      "level_name": "<string>"
    }
  ],
  "hobbies": [
    {
      "name": "<string>"
    }
  ],
  "avatar_url": "<string>",
  "cv_url": "<string>"
}

Authorizations

Authorization

string

header

required

HTTP Basic Authentication with API credentials

Path Parameters

applicationid

integer

required

Application ID

Response

Candidate profile

_status

enum<string>

Available options:

OK,

INVALID

_schema

string<uri>

identity

object[]

Show child attributes

employments

object[]

Show child attributes

educations

object[]

Show child attributes

languages

object[]

Show child attributes

skills

object[]

Show child attributes

hobbies

object[]

Show child attributes

avatar_url

string

Presigned URL to the candidate avatar image, or empty string if none. Short-lived (~1 hour).

cv_url

string

Presigned URL to the latest CV document, or empty string if none. Short-lived (~1 hour).

Reject an application (one-click)Moves the application to the configured rejection step and optionally sends a rejection email. Requires a OneClickRejectConfig to be enabled for the application's process. The rejection step and email template are determined by the organisation's one-click reject configuration.

Get candidate profile for an application

curl --request GET \
  --url https://jobaffinity.fr/restapi/v1/application/{applicationid}/profile \
  --header 'Authorization: Basic <encoded-value>'

{
  "_schema": "<string>",
  "identity": [
    {
      "first_name": "<string>",
      "last_name": "<string>",
      "email": "jsmith@example.com",
      "phone": "<string>",
      "address": "<string>",
      "zip_code": "<string>",
      "town": "<string>",
      "country": "<string>"
    }
  ],
  "employments": [
    {
      "start": "<string>",
      "end": "<string>",
      "readable_start": "<string>",
      "readable_end": "<string>",
      "title": "<string>",
      "employer": "<string>",
      "description": "<string>"
    }
  ],
  "educations": [
    {
      "start": "<string>",
      "end": "<string>",
      "readable_start": "<string>",
      "readable_end": "<string>",
      "title": "<string>",
      "institution": "<string>",
      "level": 123,
      "level_text": "<string>",
      "description": "<string>"
    }
  ],
  "languages": [
    {
      "name": "<string>",
      "level": 123,
      "level_name": "<string>"
    }
  ],
  "skills": [
    {
      "name": "<string>",
      "level": 123,
      "level_name": "<string>"
    }
  ],
  "hobbies": [
    {
      "name": "<string>"
    }
  ],
  "avatar_url": "<string>",
  "cv_url": "<string>"
}