Get Applicant References

curl https://app.brightmove.com/ATS/app/appl/reference/guid \
     -H "Content-Type: application/json"

[
  {
    "referenceGk": 10234,
    "referenceName": "Jane Doe",
    "companyName": "Acme Corporation",
    "phone": "+1-555-123-4567",
    "email": "jane.doe@acmecorp.com",
    "comments": "Provided excellent feedback on candidate's work ethic and skills.",
    "contactDate": "2024-05-10T14:22:00Z",
    "employeeGk": 5678,
    "createUserGk": 7890,
    "employeeName": "John Smith",
    "applicantGk": 3456,
    "verified": true,
    "sections": [
      {
        "sectionGk": 201,
        "sectionName": "Professional References",
        "sortOrder": 1,
        "fields": [
          {
            "fieldGk": 301,
            "name": "Relationship",
            "fieldName": "relationship",
            "fieldValue": "Former Manager",
            "optionGk": 401,
            "optionValue": "Manager",
            "data": {},
            "fieldTypeId": 2,
            "fieldTypeName": "Dropdown",
            "delete": false,
            "sortOrder": 1,
            "options": [
              {
                "optionGk": 401,
                "optionName": "Manager",
                "sortOrder": 1,
                "optionValue": "Manager",
                "fieldGk": 301
              },
              {
                "optionGk": 402,
                "optionName": "Colleague",
                "sortOrder": 2,
                "optionValue": "Colleague",
                "fieldGk": 301
              }
            ],
            "date": "2024-05-10T14:22:00Z",
            "required": true,
            "sectionGk": 201,
            "input": true,
            "defaultValue": "Manager"
          },
          {
            "fieldGk": 302,
            "name": "Reference Notes",
            "fieldName": "referenceNotes",
            "fieldValue": "Candidate demonstrated strong leadership skills.",
            "optionGk": 0,
            "optionValue": "",
            "data": {},
            "fieldTypeId": 1,
            "fieldTypeName": "Text",
            "delete": false,
            "sortOrder": 2,
            "options": [],
            "date": "2024-05-10T14:22:00Z",
            "required": false,
            "sectionGk": 201,
            "input": true,
            "defaultValue": ""
          }
        ],
        "fieldGk": 0,
        "entityTypes": [
          "3",
          "5"
        ]
      }
    ]
  }
]

Get a list of references for an Applicant

Path parameters

guidstringRequired

Path parameters

Headers

Response