ATS
- Overview
- Use Cases
Common Guides
API Reference
- Applications
- GETList Applications
- POSTCreate Application
- GETGet Application
- PATCHUpdate an Application
- POSTMove Application
- POSTReject Application
- GETGet Application Scorecard
- Offers
- Scorecards
- Notes
- Scheduled Interviews
- Documents
- GET
- Candidates
- Custom Field Definitions
- Departments
- Interview Stages
- Interviews
- Jobs
- Lists
- Locations
- Rejected Reasons
- Users
- Job Postings
- Offers
- Assessments
- Background Checks
Get Application
curl --request GET \
--url https://api.stackone.com/unified/ats/applications/{id} \
--header 'Authorization: Basic <encoded-value>' \
--header 'x-account-id: <x-account-id>'
{
"data": {
"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"unified_custom_fields": {
"my_project_custom_field_1": "REF-1236",
"my_project_custom_field_2": "some other value"
},
"candidate_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48",
"remote_candidate_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48",
"job_id": "4071538b-3cac-4fbf-ac76-f78ed250ffdd",
"remote_job_id": "4071538b-3cac-4fbf-ac76-f78ed250ffdd",
"interview_stage": {
"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"unified_custom_fields": {
"my_project_custom_field_1": "REF-1236",
"my_project_custom_field_2": "some other value"
},
"name": "<string>",
"order": 123,
"created_at": "2021-01-01T01:01:01.000Z",
"updated_at": "2021-01-01T01:01:01.000Z"
},
"interview_stage_id": "18bcbb1b-3cbc-4198-a999-460861d19480",
"remote_interview_stage_id": "18bcbb1b-3cbc-4198-a999-460861d19480",
"rejected_reasons": [
{
"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"unified_custom_fields": {
"my_project_custom_field_1": "REF-1236",
"my_project_custom_field_2": "some other value"
},
"label": "Failed Phone Screen",
"type": "rejected_by_organization",
"rejected_reason_type": {
"value": "rejected_by_organization",
"source_value": "RejectedByOrg"
}
}
],
"rejected_reason_ids": [
"f223d7f6-908b-48f0-9237-b201c307f609"
],
"remote_rejected_reason_ids": [
"f223d7f6-908b-48f0-9237-b201c307f609"
],
"rejected_at": "2021-01-01T01:01:01.000Z",
"location_id": "dd8d41d1-5eb8-4408-9c87-9ba44604eae4",
"remote_location_id": "dd8d41d1-5eb8-4408-9c87-9ba44604eae4",
"location_ids": [
"dd8d41d1-5eb8-4408-9c87-9ba44604eae4"
],
"remote_location_ids": [
"dd8d41d1-5eb8-4408-9c87-9ba44604eae4"
],
"application_status": {
"value": "hired",
"source_value": "Hired"
},
"questionnaires": {
"id": "right_to_work",
"answers": [
{
"id": "answer1",
"type": "text",
"values": [
"Yes"
]
}
]
},
"candidate": {
"name": "Romain Sestier",
"first_name": "John",
"last_name": "Doe",
"email": "john.doe@example.com",
"emails": [
{
"type": "personal",
"value": "sestier.romain123@gmail.com"
}
],
"phone_numbers": [
{
"type": "personal",
"phone": "+447700112233"
}
],
"social_links": [
{
"type": "linkedin",
"url": "https://www.linkedin.com/in/romainsestier/"
}
],
"company": "Company Inc.",
"title": "Software Engineer"
},
"attachments": [
{
"file_name": "resume.pdf",
"content": "Base64 encoded content",
"url": "http://example.com/resume.pdf",
"content_type": {
"value": "text",
"source_value": "Text"
}
}
],
"documents": [
{
"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"name": "My Document",
"path": "/path/to/file",
"category": "templates, forms, backups, etc.",
"contents": [
{
"url": "https://example.com/file.pdf",
"unified_url": "https://api.stackone.com/unified/hris/employees/12345/documents/67890/download",
"file_format": {
"value": "pdf",
"source_value": "application/pdf"
}
}
],
"category_id": "6530",
"created_at": "2021-01-01T01:01:01.000Z",
"updated_at": "2021-01-02T01:01:01.000Z",
"remote_url": "https://example.com/file.pdf",
"file_format": {
"value": "pdf",
"source_value": "application/pdf"
},
"unified_custom_fields": {
"my_project_custom_field_1": "REF-1236",
"my_project_custom_field_2": "some other value"
},
"type": {
"value": "resume",
"source_value": "<string>"
}
}
],
"result_links": [
{
"label": "test result link",
"url": "http://example.com/test-result/4565765/data"
}
],
"source": {
"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"name": "LinkedIn"
},
"created_at": "2021-01-01T01:01:01.000Z",
"updated_at": "2021-01-01T01:01:01.000Z",
"custom_fields": [
{
"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"name": "Training Completion Status",
"value": "Completed",
"value_id": "value_456",
"remote_value_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48"
}
]
},
"raw": [
{
"method": "<string>",
"url": "<string>",
"body": "<string>",
"response": {}
}
]
}
Authorizations
Basic authentication header of the form Basic <encoded-value>
, where <encoded-value>
is the base64-encoded string username:password
.
Headers
The account identifier
Path Parameters
Query Parameters
Indicates that the raw request result should be returned in addition to the mapped result (default value is false)
Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key
The comma separated list of fields that will be returned in the response (if empty, all fields are returned)
"id,remote_id,candidate_id,remote_candidate_id,job_id,remote_job_id,job_posting_id,remote_job_posting_id,interview_stage,interview_stage_id,remote_interview_stage_id,rejected_reason,rejected_reason_id,remote_rejected_reason_id,rejected_reason_ids,remote_rejected_reason_ids,rejected_reasons,rejected_at,location_id,remote_location_id,location_ids,remote_location_ids,status,application_status,questionnaires,attachments,result_links,source,created_at,updated_at,documents,custom_fields,candidate"
The comma separated list of fields that will be expanded in the response
"documents"
The comma separated list of fields that will be included in the response
"attachments,custom_fields"
Response
The application with the given identifier was retrieved.
The response is of type object
.
Was this page helpful?
curl --request GET \
--url https://api.stackone.com/unified/ats/applications/{id} \
--header 'Authorization: Basic <encoded-value>' \
--header 'x-account-id: <x-account-id>'
{
"data": {
"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"unified_custom_fields": {
"my_project_custom_field_1": "REF-1236",
"my_project_custom_field_2": "some other value"
},
"candidate_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48",
"remote_candidate_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48",
"job_id": "4071538b-3cac-4fbf-ac76-f78ed250ffdd",
"remote_job_id": "4071538b-3cac-4fbf-ac76-f78ed250ffdd",
"interview_stage": {
"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"unified_custom_fields": {
"my_project_custom_field_1": "REF-1236",
"my_project_custom_field_2": "some other value"
},
"name": "<string>",
"order": 123,
"created_at": "2021-01-01T01:01:01.000Z",
"updated_at": "2021-01-01T01:01:01.000Z"
},
"interview_stage_id": "18bcbb1b-3cbc-4198-a999-460861d19480",
"remote_interview_stage_id": "18bcbb1b-3cbc-4198-a999-460861d19480",
"rejected_reasons": [
{
"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"unified_custom_fields": {
"my_project_custom_field_1": "REF-1236",
"my_project_custom_field_2": "some other value"
},
"label": "Failed Phone Screen",
"type": "rejected_by_organization",
"rejected_reason_type": {
"value": "rejected_by_organization",
"source_value": "RejectedByOrg"
}
}
],
"rejected_reason_ids": [
"f223d7f6-908b-48f0-9237-b201c307f609"
],
"remote_rejected_reason_ids": [
"f223d7f6-908b-48f0-9237-b201c307f609"
],
"rejected_at": "2021-01-01T01:01:01.000Z",
"location_id": "dd8d41d1-5eb8-4408-9c87-9ba44604eae4",
"remote_location_id": "dd8d41d1-5eb8-4408-9c87-9ba44604eae4",
"location_ids": [
"dd8d41d1-5eb8-4408-9c87-9ba44604eae4"
],
"remote_location_ids": [
"dd8d41d1-5eb8-4408-9c87-9ba44604eae4"
],
"application_status": {
"value": "hired",
"source_value": "Hired"
},
"questionnaires": {
"id": "right_to_work",
"answers": [
{
"id": "answer1",
"type": "text",
"values": [
"Yes"
]
}
]
},
"candidate": {
"name": "Romain Sestier",
"first_name": "John",
"last_name": "Doe",
"email": "john.doe@example.com",
"emails": [
{
"type": "personal",
"value": "sestier.romain123@gmail.com"
}
],
"phone_numbers": [
{
"type": "personal",
"phone": "+447700112233"
}
],
"social_links": [
{
"type": "linkedin",
"url": "https://www.linkedin.com/in/romainsestier/"
}
],
"company": "Company Inc.",
"title": "Software Engineer"
},
"attachments": [
{
"file_name": "resume.pdf",
"content": "Base64 encoded content",
"url": "http://example.com/resume.pdf",
"content_type": {
"value": "text",
"source_value": "Text"
}
}
],
"documents": [
{
"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"name": "My Document",
"path": "/path/to/file",
"category": "templates, forms, backups, etc.",
"contents": [
{
"url": "https://example.com/file.pdf",
"unified_url": "https://api.stackone.com/unified/hris/employees/12345/documents/67890/download",
"file_format": {
"value": "pdf",
"source_value": "application/pdf"
}
}
],
"category_id": "6530",
"created_at": "2021-01-01T01:01:01.000Z",
"updated_at": "2021-01-02T01:01:01.000Z",
"remote_url": "https://example.com/file.pdf",
"file_format": {
"value": "pdf",
"source_value": "application/pdf"
},
"unified_custom_fields": {
"my_project_custom_field_1": "REF-1236",
"my_project_custom_field_2": "some other value"
},
"type": {
"value": "resume",
"source_value": "<string>"
}
}
],
"result_links": [
{
"label": "test result link",
"url": "http://example.com/test-result/4565765/data"
}
],
"source": {
"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"name": "LinkedIn"
},
"created_at": "2021-01-01T01:01:01.000Z",
"updated_at": "2021-01-01T01:01:01.000Z",
"custom_fields": [
{
"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"name": "Training Completion Status",
"value": "Completed",
"value_id": "value_456",
"remote_value_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48"
}
]
},
"raw": [
{
"method": "<string>",
"url": "<string>",
"body": "<string>",
"response": {}
}
]
}