Skip to main content
GET
/
candidate
/
{candidateid}
Get candidate by ID
curl --request GET \
  --url https://jobaffinity.fr/restapi/v1/candidate/{candidateid} \
  --header 'Authorization: Basic <encoded-value>'
{
  "_self": "<string>",
  "_schema": "<string>",
  "_status": "OK",
  "id": 123,
  "title": "MR",
  "first_name": "<string>",
  "last_name": "<string>",
  "email": "[email protected]",
  "phone": "<string>",
  "mobile": "<string>",
  "address": {
    "address": "<string>",
    "postalcode": "<string>",
    "town": "<string>",
    "country": "<string>"
  },
  "applications": {
    "_self": "<string>"
  },
  "notes": {
    "_self": "<string>"
  },
  "pools": [
    {
      "id": 123,
      "name": "<string>"
    }
  ]
}

Authorizations

Authorization
string
header
required

HTTP Basic Authentication with API credentials

Path Parameters

candidateid
integer
required

Candidate ID

Response

Candidate details

_self
string<uri>

URL of the candidate resource

_schema
string<uri>
_status
enum<string>
Available options:
OK,
INVALID
id
integer

Candidate identifier

title
enum<string>

Candidate title

Available options:
MR,
MS
first_name
string

First name

last_name
string

Last name

email
string<email>

Email address

phone
string

Phone number

mobile
string

Mobile phone number

address
object
applications
object
notes
object
pools
object[]

Candidate pools