BIbindbee
Application

Get Application By Id

Changed on

Returns an Application object with the given id.

get/api/ats/v1/applications/{id}

Request

  • Base URL
    https://api.bindbee.dev (the document declares no server; this is the origin it was published from)
  • Auth
    HTTP bearer and API key in header X-Connector-Token

Path parameters

idstring uuid required

Query parameters

include_raw_databoolean

Whether to include the original data Bindbee fetched from the third-party to produce these models.

include_custom_fieldsboolean

Whether to include custom fields in the response.

expandstring nullable

Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name. Add .custom_fields to return an expanded record's custom fields, or .custom_fields[name,other_name] for only those (quote a name holding anything but letters, digits, _ and -: .custom_fields["wd:Visa_ID"]).

Example:manager[first_name,last_name]

Response

Successful Response

idstring uuid required
remote_idstring nullable required

The third-party API ID of the matching object.

modified_atstring date-time required

This is the datetime that this object was last updated by Bindbee

raw_dataobject nullable

This is the Raw data

custom_fieldsobject nullable required

The custom fields related to the model

candidatestring nullable required

The candidate associated with the application.

jobstring nullable required

The job for which the candidate has applied.

applied_atstring nullable required

The date and time when the candidate applied for the job.

rejected_atstring nullable required

The date and time when the application was rejected.

sourcestring nullable required

The source from where the candidate's application originated.

credited_tostring nullable required

The user or entity to which the application is credited.

current_stagestring nullable required

The current stage of the application in the hiring process.

reject_reasonstring nullable required

The reason for the application's rejection.

Example response

{
  "id": "018b18ef-c487-703c-afd9-0ca478ccd9d6",
  "remote_id": "123321",
  "modified_at": "2021-10-16T00:00:00Z",
  "raw_data": {
    "key_1": "Platform dependent data 1",
    "key_2": "Platform dependent data 2"
  },
  "custom_fields": {
    "category_group": "REG",
    "disability_type": "ASBERG",
    "hire_date": "1991-03-16T00:00:00",
    "hire_source": "REFER",
    "nationality": "USA",
    "original_hire_date": "1991-03-16T00:00:00"
  },
  "candidate": "018b4bfb-5ece-70b1-ad5e-862a9433aa65",
  "job": "018b4bfb-5ece-70b1-ad5e-862a9433aa65",
  "applied_at": "2021-01-01T00:00:00Z",
  "rejected_at": "2021-01-01T00:00:00Z",
  "source": "LinkedIn",
  "credited_to": "018b4bfb-5ece-70b1-ad5e-862a9433aa65",
  "current_stage": "018b4bfb-5ece-70b1-ad5e-862a9433aa65",
  "reject_reason": "018b4bfb-5ece-70b1-ad5e-862a9433aa65"
}

Changes

  • 1f9bc0ad4bfbRevision changes
    • info

      the endpoint scheme security HTTPBearer AND ConnectorToken was added to the API

    • info

      the endpoint scheme security ConnectorToken was removed from the API

    • info

      the endpoint scheme security HTTPBearer was removed from the API

  • cf8209fb1cd7Revision changes
    • warning

      deleted the header request parameter x-connector-token

    • info

      the endpoint scheme security ConnectorToken was added to the API