ApplicationsGet Application

Get Application

Read a specific Application detail identified by its unique ID.

curl -X GET "https://api.getkini.com/applications/example_string" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
{
  "company": "null",
  "job": "null",
  "external_job_id": "example_string",
  "partner": "null",
  "partner_application_id": "null",
  "partner_company_id": "null",
  "partner_job_id": "null",
  "agency": "null",
  "agency_job_id": "null",
  "candidate": {
    "email": "user@example.com",
    "first_name": "John Doe",
    "last_name": "null",
    "full_name": "null",
    "gender": "null",
    "phone": "null",
    "location": {
      "street": "null",
      "city": "null",
      "country": "null",
      "postcode": "null"
    },
    "skills": [
      "Python",
      "Django",
      "React"
    ]
  },
  "social_links": {
    "LinkedIn": "https://linkedin.com/in/username",
    "GitHub": "https://github.com/username",
    "Xing": "https://xing.com/profile/username"
  },
  "screening_questions": [
    {
      "id": "example_string",
      "question": "example_string",
      "answer_type": "boolean",
      "answer": "example_string"
    }
  ],
  "attachments": [
    {
      "type": "cv",
      "name": "John Doe",
      "content_type": "application/msword"
    }
  ],
  "notes": "null",
  "channel": "null",
  "sync_status": "SUCCESS",
  "failure_error": "null",
  "created_at": "2024-12-25T10:00:00Z",
  "updated_at": "2024-12-25T10:00:00Z"
}
GET
/applications/{id}
GET
Base URLstring

Target server for requests. Edit to use your own host.

Bearer Token
Bearer Tokenstring
Required

Bearer API Key Authentication. Include your API key in the Authorization header.

Bearer API Key Authentication. Include your API key in the Authorization header.
path
idstring
Required

ID of the Application

Request Preview
Response

Response will appear here after sending the request

Authentication

header
Authorizationstring
Required

Bearer token. Bearer API Key Authentication. Include your API key in the Authorization header.

Path Parameters

idstring
Required

ID of the Application

Responses

companyinteger

Kini ID of the company offering the job

jobinteger

Kini ID of the job applied for (either job or external_job_id is required)

external_job_idstring

Job's ID in external ATS systems, used for integrations (either job or external_job_id is required)

partnerinteger

Kini ID of the partner involved in the application

partner_application_idstring

External ID of the application in the partner's system (e.g. Jobboard)

partner_company_idstring

External ID of the company in the partner's system (e.g. ATS)

partner_job_idstring

External ID of the job in the partner's system (e.g. Jobboard)

agencyinteger

Kini ID of the agency distributing the application

agency_job_idstring

External ID of the job in the agency's system

candidateobject
Required
social_linksobject

Social media links as key-value pairs where key is the platform name and value is the profile URL

screening_questionsarray
attachmentsarray

List of attachments provided by the applicant

notesstring

Internal notes about the application

channelstring

External posting channel from which the application was received

sync_statusstring
Required

Indicates the current state of the application synchronization to the company's ATS. Enum: SUCCESS (Sync Successful), EXPECTED_FAILURE (Sync Failed Expectedly, No Action Needed), FAILURE (Sync Failed), NOTSENT (Sync Not Triggered).

Allowed values:SUCCESSEXPECTED_FAILUREFAILURENOTSENT
failure_errorstring
Required

Error message if the application synchronization failed

created_atstring

Timestamp of when the application was first created

updated_atstring

Timestamp of when the application was last updated