Sign in

v1

latestOpenAPI 3.1.02026-07-24181585937.4 KB
Application

application.info

Fetch application details by application id or by submitted form instance id (which is returned by the applicationForm.submit endpoint). If both applicationId and submittedFormInstanceId are provided, the lookup uses applicationId.

Requires the candidatesRead permission.

post/application.info

Request body

applicationIdstring nullable

The id of the application to fetch.

submittedFormInstanceIdstring nullable

The id of the application's submitted form instance to fetch. Either applicationId or submittedFormInstanceId must be provided. When both are supplied, the lookup uses applicationId.

expandstring[] nullable

Choose to expand the result and include additional data for related objects.

Response

Responses from the application.info endpoint

OR

Example response

{
  "success": true,
  "results": {
    "id": "e9ed20fd-d45f-4aad-8a00-a19bfba0083e",
    "createdAt": "2024-01-15T10:30:00.000Z",
    "updatedAt": "2024-01-16T10:30:00.000Z",
    "status": "Active",
    "customFields": [],
    "candidate": {
      "id": "84bfbed7-ed0a-496d-bb18-11b73369f666",
      "name": "Michael Bluth",
      "primaryEmailAddress": {
        "value": "michael@bluth.example",
        "type": "Personal",
        "isPrimary": true
      },
      "primaryPhoneNumber": null
    },
    "currentInterviewStage": {
      "id": "c153b3e9-8b97-4fc0-bad1-6c654122c1f8",
      "title": "Application Review",
      "type": "PreInterviewScreen",
      "orderInInterviewPlan": 1,
      "interviewStageGroupId": null,
      "interviewPlanId": "d3f4762e-1234-4abc-9876-aabbccddeeff"
    },
    "source": null,
    "archiveReason": null,
    "archivedAt": null,
    "job": {
      "id": "4071538b-3cac-4fbf-ac76-f78ed250ffdd",
      "title": "First Designer",
      "locationId": null,
      "departmentId": null
    },
    "creditedToUser": null,
    "hiringTeam": [],
    "appliedViaJobPostingId": null,
    "submitterClientIp": null,
    "submitterUserAgent": null
  }
}