Applicants: get

Return information about the applicant by Applicant Id.

Request - GET{applicantid}

You will need to supply the Applicant Id on your request parameters with this method. You can get your Applicant Id from the return of the Applicants List.
You will need to include your access token upon making a request. For more information, see the authentication and authorization page.

Example request with authorization:

curl -- GET Base URI:{applicantid}
--header "Authorization: Bearer MTQ0NjJkZmQ5OTM2NDE1ghNNBiuyUYUN"


If successful, this method returns a response body with the following structure:

Example response:

Content-Type: application/json
"applicants": [
"applicantid": long,
"lettings": boolean,
"sales": boolean,
"title": "string",
"forename": "string",
"surname": "string",
"companyname": "string",
"website": "string",
"phone": "string",
"workphone": "string",
"mobilephone": "string",
"email": "string",
"salutation": "string",
"source": "string",
"temperature": "string",
"AddedDate": "date",
"ModifiedDate": "date",
"internalreference": "string",
"archivedDate": "date",
"negotiator": {
"userid": long,
"name": "string",
"email": "string"
"branch": {
"branchid": integer,
"branchname": "string"
"status": "string",
"contactnotes": "string",
"additionalinformation": "string",
"address": {
"houseno": "string",
"address1": "string",
"address2": "string",
"town": "string",
"county": "string",
"postcode": "string",
"latitude": decimal,
"longitude": decimal,
"geocodingverified": boolean,
"countryname": "string",
"countrydisplayname": "string",
"fulladdress": "string",
"shortaddress": "string"
"areas": [
"area": "string",
"miles": decimal,
"minprice": decimal,
"maxprice": decimal,
"bedrooms": integer,
"bathrooms": integer,
"moveindate": "date",
"buyerposition": "string",
"propertyattributes": [
"attribute": "string",
"propertystyle": [
"style": "string",
"GDPR": {
"donotcontact": boolean,
"Email": boolean,
"letter": boolean,
"sms": boolean,
"phone": boolean",
"allowmarketing": boolean,