Skip to content

Retrieve a(n) Pipeline Interview record​

GET
/PipelineInterviews/{id}

Authorizations​

Bearer

Please create a SessionId using the access-token endpoint and use it in an authorization header.

TypeHTTP (bearer)
Example'Authorization: BEARER <YOUR_TOKEN_HERE>'

Responses​

application/json
JSON
{
"AggregateCount": 0,
"MetaData": null,
"SendoutId": 0,
"JobId": 0,
"CandidateId": 0,
"CandidateName": "string",
"CompanyId": 0,
"AppointmentDate": "string",
"ArrangedDate": "string",
"InterviewType": null,
"InterviewStatus": "string",
"BillRate": {
"CurrencyCode": null,
"Value": 0
},
"PayRate": {
"CurrencyCode": null,
"Value": 0
},
"Notes": "string",
"Feedback": "string",
"Guarantee": "string",
"NotesPublic": "string",
"UserName": "string",
"InterviewerIds": [
0
],
"InterviewerNames": [
"string"
],
"CurrentInterviewType": null,
"CurrentInterviewStatus": "string",
"CurrentRollupStage": "string",
"VisibleOnWeb": true,
"LastModified": "string",
"Rank": 0,
"ScheduleItems": [
{
"start": "string",
"end": "string",
"recurringPattern": "string",
"alarm": true,
"subject": "string",
"additionalUsers": [
"string"
]
}
],
"CalendarItems": [
{
"AggregateCount": 0,
"MetaData": null,
"TaskId": 0,
"UserId": "string",
"Date": "string",
"EndDate": "string",
"Duration": 0,
"Subject": "string",
"Notes": "string",
"Location": "string",
"Alarms": "string",
"LinkType": null,
"LinkId": 0,
"AlarmBeforeMins": 0,
"Snooze": "string",
"IsSnoozed": true,
"LastModified": "string",
"RecurringId": 0,
"OutlookId": "string",
"Planner": {
"Rollup": "string",
"Type": 0,
"Ids": [
"string"
]
},
"ActivityType": "string",
"Result": "string",
"Stage": "string",
"Attendees": "string",
"EventType": 0,
"EventTypeImage": "string",
"EventTypeColorCode": "string",
"EventTypeDescription": "string",
"RecurringPattern": "string",
"RecurringException": "string",
"RecurringEnd": "string",
"RecurringDay": "string",
"RecurringCount": 0,
"RecurringType": null,
"CalendarId": 0,
"IsAllDayAppointment": true
}
],
"Position": {
"AggregateCount": 0,
"MetaData": null,
"JobId": 0,
"CompanyId": 0,
"ReplicationId": "string",
"Industry": "string",
"Specialty": "string",
"JobType": null,
"JobTitle": "string",
"PositionId": "string",
"DegreeRequired": "string",
"MinYearsExp": 0,
"MaxYearsExp": 0,
"JobDescription": "string",
"InternalJobDescription": "string",
"NumberOfOpenings": 0,
"MinSalary": {
"CurrencyCode": null,
"Value": 0
},
"MaxSalary": {
"CurrencyCode": null,
"Value": 0
},
"Guarantee": "string",
"Benefits": "string",
"HealthCoverage": "string",
"Vacation": "string",
"EducationAid": "string",
"Keywords": "string",
"DatePosted": "string",
"Address": "string",
"Address2": "string",
"City": "string",
"State": "string",
"Zip": "string",
"PostalCodeExtension": "string",
"FullPostalCode": "string",
"Country": "string",
"County": "string",
"BeginDate": "string",
"EndDate": "string",
"FeePercentage": "string",
"FeeCollected": {
"CurrencyCode": null,
"Value": 0
},
"BillRate": {
"CurrencyCode": null,
"Value": 0
},
"PayRate": {
"CurrencyCode": null,
"Value": 0
},
"Notes": "string",
"WebNotes": "string",
"InternalExpiration": "string",
"ExternalExpiration": "string",
"ShowOnWeb": true,
"WhyOpen": "string",
"Department": "string",
"StartHold": "string",
"EndHold": "string",
"UserName": "string",
"Status": null,
"LastActivity": "string",
"LastModified": "string",
"TemplateId": 0,
"ContactId": 0,
"ContactName": "string",
"ContactPhone": "string",
"ContactEmail": "string",
"ProfileInquiry": "string",
"PrivateNotes": "string",
"Logo": "string",
"DefaultCurrency": null,
"CustomFields": [
{
"AggregateCount": 0,
"MetaData": null,
"JobId": 0,
"FieldName": "string",
"Value": [
"string"
],
"Action": 0
}
],
"EEOC": [
{
"AggregateCount": 0,
"MetaData": null,
"JobId": 0,
"FieldName": "string",
"Value": [
"string"
],
"JobIdReference": 0
}
],
"Activities": [
{
"AggregateCount": 0,
"MetaData": null,
"ActivityId": 0,
"JobId": 0,
"UserName": "string",
"DateEntered": "string",
"Memo": "string",
"ActType": "string",
"Result": "string",
"Position": "[Circular Reference]"
}
],
"RollupLists": [
{
}
],
"Interviews": [
{
"AggregateCount": 0,
"MetaData": null,
"SendoutId": 0,
"JobId": 0,
"CandidateId": 0,
"CandidateName": "string",
"CompanyId": 0,
"AppointmentDate": "string",
"ArrangedDate": "string",
"InterviewType": null,
"InterviewStatus": "string",
"BillRate": {
"CurrencyCode": null,
"Value": 0
},
"PayRate": {
"CurrencyCode": null,
"Value": 0
},
"Notes": "string",
"Feedback": "string",
"Guarantee": "string",
"NotesPublic": "string",
"UserName": "string",
"InterviewerIds": [
0
],
"InterviewerNames": [
"string"
],
"CurrentInterviewType": null,
"CurrentInterviewStatus": "string",
"CurrentRollupStage": "string",
"VisibleOnWeb": true,
"LastModified": "string",
"Rank": 0,
"ScheduleItems": [
{
"start": "string",
"end": "string",
"recurringPattern": "string",
"alarm": true,
"subject": "string",
"additionalUsers": [
"string"
]
}
],
"CalendarItems": [
{
"AggregateCount": 0,
"MetaData": null,
"TaskId": 0,
"UserId": "string",
"Date": "string",
"EndDate": "string",
"Duration": 0,
"Subject": "string",
"Notes": "string",
"Location": "string",
"Alarms": "string",
"LinkType": null,
"LinkId": 0,
"AlarmBeforeMins": 0,
"Snooze": "string",
"IsSnoozed": true,
"LastModified": "string",
"RecurringId": 0,
"OutlookId": "string",
"Planner": {
"Rollup": "string",
"Type": 0,
"Ids": [
"string"
]
},
"ActivityType": "string",
"Result": "string",
"Stage": "string",
"Attendees": "string",
"EventType": 0,
"EventTypeImage": "string",
"EventTypeColorCode": "string",
"EventTypeDescription": "string",
"RecurringPattern": "string",
"RecurringException": "string",
"RecurringEnd": "string",
"RecurringDay": "string",
"RecurringCount": 0,
"RecurringType": null,
"CalendarId": 0,
"IsAllDayAppointment": true
}
],
"Position": "[Circular Reference]",
"Candidate": "[Circular Reference]",
"Links": [
{
"AggregateCount": 0,
"MetaData": null,
"RecordId": 0,
"LinkId": 0,
"LinkType": 0
}
],
"Splitdesk": [
{
"AggregateCount": 0,
"MetaData": null,
"SplitdeskId": 0,
"SendoutId": 0,
"SplitdeskTypeId": 0,
"Percentage": 0,
"UserName": "string",
"DateEntered": "string",
"LastModified": "string",
"SplitdeskType": {
"AggregateCount": 0,
"MetaData": null,
"SplitdeskTypeId": 0,
"SplitName": "string"
},
"Interview": "[Circular Reference]"
}
]
}
],
"Placements": [
{
"AggregateCount": 0,
"MetaData": null,
"PlacementId": 0,
"JobId": 0,
"CandidateId": 0,
"CandidateName": "string",
"CompanyId": 0,
"StartDate": "string",
"PlacementDate": "string",
"PlacementType": null,
"PlacementStatus": "string",
"UserName": "string",
"BillRate": {
"CurrencyCode": null,
"Value": 0
},
"PayRate": {
"CurrencyCode": null,
"Value": 0
},
"Notes": "string",
"Feedback": "string",
"Guarantee": "string",
"NotesPublic": "string",
"InterviewerNames": [
"string"
],
"CurrentInterviewType": null,
"CurrentInterviewStatus": "string",
"CurrentRollupStage": "string",
"VisibleOnWeb": true,
"LastModified": "string",
"Rank": 0,
"OvertimeBillRate": {
"CurrencyCode": null,
"Value": 0
},
"OvertimePayRate": {
"CurrencyCode": null,
"Value": 0
},
"OnCallBillRate": {
"CurrencyCode": null,
"Value": 0
},
"OnCallPayRate": {
"CurrencyCode": null,
"Value": 0
},
"HolidayBillRate": {
"CurrencyCode": null,
"Value": 0
},
"HolidayPayRate": {
"CurrencyCode": null,
"Value": 0
},
"DoubleTimeBillRate": {
"CurrencyCode": null,
"Value": 0
},
"DoubleTimePayRate": {
"CurrencyCode": null,
"Value": 0
},
"DailyPerDiem": {
"CurrencyCode": null,
"Value": 0
},
"HourlyPerDiem": {
"CurrencyCode": null,
"Value": 0
},
"BurdenRate": 0,
"BurdenState": "string",
"PONumber": "string",
"PlacementFee": {
"CurrencyCode": null,
"Value": 0
},
"FeePercentrage": 0,
"StartingSalary": {
"CurrencyCode": null,
"Value": 0
},
"ApproveList": [
"string"
],
"PayFrequency": null,
"StartingWeekday": null,
"TimeclockVisible": true,
"EndDate": "string",
"EstimatedWeeksWorked": 0,
"EstimatedTotalRevenue": {
"CurrencyCode": null,
"Value": 0
},
"EstimatedTotalCost": {
"CurrencyCode": null,
"Value": 0
},
"EstimatedTotalProfit": {
"CurrencyCode": null,
"Value": 0
},
"Position": "[Circular Reference]",
"Candidate": "[Circular Reference]",
"Company": {
"AggregateCount": 0,
"MetaData": null,
"CompanyId": 0,
"ReplicationId": "string",
"CompanyName": "string",
"UserName": "string",
"Address": "string",
"Address2": "string",
"City": "string",
"State": "string",
"PostalCode": "string",
"FullPostalCode": "string",
"PostalCodeExtension": "string",
"County": "string",
"Country": "string",
"Phone": "string",
"Fax": "string",
"DateEntered": "string",
"EmailAddress": "string",
"Website": "string",
"DefaultCurrency": null,
"IndustryCode": "string",
"NumberOfEmployees": 0,
"AnnualRevenue": {
"CurrencyCode": null,
"Value": 0
},
"FeeCollected": {
"CurrencyCode": null,
"Value": 0
},
"DivisionOf": "string",
"CompanyType": null,
"Industry": "string",
"Specialty": "string",
"Subjective": 0,
"Keywords": "string",
"Summary": "string",
"Notes": "string",
"HasNotes": true,
"LastActivity": "string",
"LastModified": "string",
"Identification": "string",
"PrivateNotes": "string",
"Logo": "string",
"Candidates": [
{
}
],
"CustomFields": [
{
"AggregateCount": 0,
"MetaData": null,
"CompanyId": 0,
"FieldName": "string",
"Value": [
"string"
],
"Action": 0
}
],
"EEOC": [
{
"AggregateCount": 0,
"MetaData": null,
"CompanyId": 0,
"FieldName": "string",
"Value": [
"string"
],
"JobId": 0
}
],
"Activities": [
{
"AggregateCount": 0,
"MetaData": null,
"ActivityId": 0,
"CompanyId": 0,
"UserName": "string",
"DateEntered": "string",
"Memo": "string",
"ActType": "string",
"Result": "string",
"FormId": 0,
"Company": "[Circular Reference]"
}
],
"RollupLists": [
{
}
],
"Attachments": [
{
"AttachmentId": 0,
"Type": null,
"Name": "string",
"Description": "string",
"Date": "string",
"ProfileLink": "string",
"ProfileLinkEdit": "string",
"Hash": "string",
"Data": "string",
"Size": 0,
"TokenId": 0,
"AggregateCount": 0,
"MetaData": null,
"CompanyId": 0,
"Company": "[Circular Reference]"
}
]
},
"Splitdesk": [
{
"AggregateCount": 0,
"MetaData": null,
"SplitdeskId": 0,
"SendoutId": 0,
"SplitdeskTypeId": 0,
"Percentage": 0,
"UserName": "string",
"DateEntered": "string",
"LastModified": "string",
"SplitdeskType": {
"AggregateCount": 0,
"MetaData": null,
"SplitdeskTypeId": 0,
"SplitName": "string"
},
"Placement": "[Circular Reference]"
}
]
}
],
"Attachments": [
{
"AttachmentId": 0,
"Type": null,
"Name": "string",
"Description": "string",
"Date": "string",
"ProfileLink": "string",
"ProfileLinkEdit": "string",
"Hash": "string",
"Data": "string",
"Size": 0,
"TokenId": 0,
"AggregateCount": 0,
"MetaData": null,
"JobId": 0,
"Position": "[Circular Reference]"
}
],
"Company": {
"AggregateCount": 0,
"MetaData": null,
"CompanyId": 0,
"ReplicationId": "string",
"CompanyName": "string",
"UserName": "string",
"Address": "string",
"Address2": "string",
"City": "string",
"State": "string",
"PostalCode": "string",
"FullPostalCode": "string",
"PostalCodeExtension": "string",
"County": "string",
"Country": "string",
"Phone": "string",
"Fax": "string",
"DateEntered": "string",
"EmailAddress": "string",
"Website": "string",
"DefaultCurrency": null,
"IndustryCode": "string",
"NumberOfEmployees": 0,
"AnnualRevenue": {
"CurrencyCode": null,
"Value": 0
},
"FeeCollected": {
"CurrencyCode": null,
"Value": 0
},
"DivisionOf": "string",
"CompanyType": null,
"Industry": "string",
"Specialty": "string",
"Subjective": 0,
"Keywords": "string",
"Summary": "string",
"Notes": "string",
"HasNotes": true,
"LastActivity": "string",
"LastModified": "string",
"Identification": "string",
"PrivateNotes": "string",
"Logo": "string",
"Candidates": [
{
}
],
"CustomFields": [
{
"AggregateCount": 0,
"MetaData": null,
"CompanyId": 0,
"FieldName": "string",
"Value": [
"string"
],
"Action": 0
}
],
"EEOC": [
{
"AggregateCount": 0,
"MetaData": null,
"CompanyId": 0,
"FieldName": "string",
"Value": [
"string"
],
"JobId": 0
}
],
"Activities": [
{
"AggregateCount": 0,
"MetaData": null,
"ActivityId": 0,
"CompanyId": 0,
"UserName": "string",
"DateEntered": "string",
"Memo": "string",
"ActType": "string",
"Result": "string",
"FormId": 0,
"Company": "[Circular Reference]"
}
],
"RollupLists": [
{
}
],
"Attachments": [
{
"AttachmentId": 0,
"Type": null,
"Name": "string",
"Description": "string",
"Date": "string",
"ProfileLink": "string",
"ProfileLinkEdit": "string",
"Hash": "string",
"Data": "string",
"Size": 0,
"TokenId": 0,
"AggregateCount": 0,
"MetaData": null,
"CompanyId": 0,
"Company": "[Circular Reference]"
}
]
}
},
"Candidate": "[Circular Reference]",
"Links": [
{
"AggregateCount": 0,
"MetaData": null,
"RecordId": 0,
"LinkId": 0,
"LinkType": 0
}
],
"Splitdesk": [
{
"AggregateCount": 0,
"MetaData": null,
"SplitdeskId": 0,
"SendoutId": 0,
"SplitdeskTypeId": 0,
"Percentage": 0,
"UserName": "string",
"DateEntered": "string",
"LastModified": "string",
"SplitdeskType": {
"AggregateCount": 0,
"MetaData": null,
"SplitdeskTypeId": 0,
"SplitName": "string"
},
"Interview": "[Circular Reference]"
}
]
}

Playground​

Authorization
Variables
Key
Value

Samples​