Events

Scheduled events with candidates

get
Get event list

https://api.talentlyft.com/v2/events
List all of an organization’s scheduled events.
Request
Response
Headers
Authorization
required
string
Authentication Bearer token
Query Parameters
members
optional
array
candidates
optional
array
types
optional
array
jobs
optional
array
rangeStart
optional
string
rangeEnd
optional
string
contains
optional
string
page
required
integer
Default value: 1
perPage
required
integer
Default value: 20
200: OK
{
"Results": [
{
"Id": "string",
"Type": "Call",
"StartTime": "2019-06-08T16:44:46.415Z",
"EndTime": "2019-06-08T16:44:46.415Z",
"TimeZone": "string",
"TimeZoneIANA": "string",
"Subject": "string",
"Notes": "string",
"Sequence": 0,
"Location": {
"Id": 0,
"Country": "string",
"CountryCode": "string",
"Region": "string",
"DistrictId": 0,
"City": "string",
"ZipCode": "string",
"Address": "string",
"Latitude": 0,
"Longitude": 0
},
"Job": {
"Id": 0,
"Title": "string",
"FriendlyUrl": "string",
"Department": "string",
"DepartmentId": 0,
"Location": "string",
"Status": "Draft"
},
"Attendees": [
{
"Id": 0,
"Status": "Accepted",
"Type": "Member",
"Organizer": true,
"Email": "string",
"Candidate": {
"Id": 0,
"FirstName": "string",
"LastName": "string",
"Name": "string",
"Avatar": "string"
},
"Member": {
"Id": "string",
"Name": "string",
"Email": "string",
"Headline": "string",
"Avatar": "string",
"Role": "Administrator",
"InvitationSentTime": "2019-06-08T16:44:46.415Z"
},
"ExternalAttendee": {
"Id": 0,
"Email": "string",
"Name": "string"
}
}
]
}
],
"Count": 0,
"Page": 0,
"PerPage": 0,
"Pages": {
"First": "string",
"Prev": "string",
"Next": "string",
"Last": "string"
}
}
401: Unauthorized
{
"Message": "Unauthorized"
}
403: Forbidden
{
"Message": "Unauthorized"
}

get
Get event

https://api.talentlyft.com/v2/events/:id
Retrieve an event by its ID.
Request
Response
Path Parameters
id
required
string
Unique identifier
Headers
Authorization
required
string
Authentication Bearer token
200: OK
{
"Id": "string",
"Type": "Call",
"StartTime": "2019-06-08T16:44:46.420Z",
"EndTime": "2019-06-08T16:44:46.420Z",
"TimeZone": "string",
"TimeZoneIANA": "string",
"Subject": "string",
"Notes": "string",
"Sequence": 0,
"Location": {
"Id": 0,
"Country": "string",
"CountryCode": "string",
"Region": "string",
"DistrictId": 0,
"City": "string",
"ZipCode": "string",
"Address": "string",
"Latitude": 0,
"Longitude": 0
},
"Job": {
"Id": 0,
"Title": "string",
"FriendlyUrl": "string",
"Department": "string",
"DepartmentId": 0,
"Location": "string",
"Status": "Draft"
},
"Attendees": [
{
"Id": 0,
"Status": "Accepted",
"Type": "Member",
"Organizer": true,
"Email": "string",
"Candidate": {
"Id": 0,
"FirstName": "string",
"LastName": "string",
"Name": "string",
"Avatar": "string"
},
"Member": {
"Id": "string",
"Name": "string",
"Email": "string",
"Headline": "string",
"Avatar": "string",
"Role": "Administrator",
"InvitationSentTime": "2019-06-08T16:44:46.420Z"
},
"ExternalAttendee": {
"Id": 0,
"Email": "string",
"Name": "string"
}
}
]
}
401: Unauthorized
{
"Message": "Unauthorized"
}
403: Forbidden
{
"Message": "Unauthorized"
}
404: Not Found
{
"Message": "Unauthorized"
}