Events
Authorizations
Query parameters
membersstring · uuid[]Optional
candidatesinteger · int32[]Optional
jobsinteger · int32[]Optional
rangeStartstring · date-timeOptional
rangeEndstring · date-timeOptional
containsstringOptional
pageinteger · int32OptionalDefault:
1
perPageinteger · int32OptionalDefault:
20
Header parameters
X-TL-CompanyIdguidOptional
Company Id
X-TL-SubdomainguidOptional
Account subdomain
X-TL-UserIdguidOptional
Team member id
Responses
200
Success
application/json
401
Unauthorized
application/json
403
Forbidden
application/json
500
Server Error
application/json
get
GET /v2/events HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
{
"Results": [
{
"Id": "123e4567-e89b-12d3-a456-426614174000",
"Type": "Call",
"StartTime": "2025-07-13T01:04:48.096Z",
"EndTime": "2025-07-13T01:04:48.096Z",
"TimeZone": "text",
"TimeZoneIANA": "text",
"Subject": "text",
"Notes": "text",
"Sequence": 1,
"Location": {
"Id": 1,
"Address": "text",
"Latitude": 1,
"Longitude": 1,
"ConferenceRoom": "text",
"LocationFormatted": "text"
},
"Job": {
"Id": 1,
"Title": "text",
"FriendlyUrl": "text",
"Department": "text",
"RequisitionCode": "text",
"DepartmentId": 1,
"Location": "text",
"Status": "Draft",
"PipelineId": 1,
"JobNumber": "text",
"SecondaryText": "text"
},
"Attendees": [
{
"Id": 1,
"Status": "Accepted",
"Type": "Member",
"Organizer": true,
"Email": "text",
"Candidate": {
"Id": 1,
"FirstName": "text",
"LastName": "text",
"Name": "text",
"Avatar": "text"
},
"Member": {
"Id": "123e4567-e89b-12d3-a456-426614174000",
"Name": "text",
"Email": "text",
"SenderEmail": "text",
"Username": "text",
"Headline": "text",
"Avatar": "text",
"Role": "Administrator",
"InvitationSentTime": "2025-07-13T01:04:48.096Z",
"Permissions": {
"Jobs": [
{
"Id1": 1,
"Id2": "text"
}
],
"ExcludedJobs": [
{
"Id1": 1,
"Id2": "text"
}
],
"Departments": [
{
"Id1": 1,
"Id2": "text"
}
],
"Sites": [
{
"Id1": 1,
"Id2": "text"
}
]
}
},
"ExternalAttendee": {
"Id": 1,
"Email": "text",
"Name": "text"
}
}
]
}
],
"Count": 1,
"Page": 1,
"PerPage": 1,
"Pages": {
"First": "text",
"Prev": "text",
"Next": "text",
"Last": "text"
},
"IdResults": [
{
"Id": "123e4567-e89b-12d3-a456-426614174000",
"Type": "Call",
"StartTime": "2025-07-13T01:04:48.096Z",
"EndTime": "2025-07-13T01:04:48.096Z",
"TimeZone": "text",
"TimeZoneIANA": "text",
"Subject": "text",
"Notes": "text",
"Sequence": 1,
"Location": {
"Id": 1,
"Address": "text",
"Latitude": 1,
"Longitude": 1,
"ConferenceRoom": "text",
"LocationFormatted": "text"
},
"Job": {
"Id": 1,
"Title": "text",
"FriendlyUrl": "text",
"Department": "text",
"RequisitionCode": "text",
"DepartmentId": 1,
"Location": "text",
"Status": "Draft",
"PipelineId": 1,
"JobNumber": "text",
"SecondaryText": "text"
},
"Attendees": [
{
"Id": 1,
"Status": "Accepted",
"Type": "Member",
"Organizer": true,
"Email": "text",
"Candidate": {
"Id": 1,
"FirstName": "text",
"LastName": "text",
"Name": "text",
"Avatar": "text"
},
"Member": {
"Id": "123e4567-e89b-12d3-a456-426614174000",
"Name": "text",
"Email": "text",
"SenderEmail": "text",
"Username": "text",
"Headline": "text",
"Avatar": "text",
"Role": "Administrator",
"InvitationSentTime": "2025-07-13T01:04:48.096Z",
"Permissions": {
"Jobs": [
{
"Id1": 1,
"Id2": "text"
}
],
"ExcludedJobs": [
{
"Id1": 1,
"Id2": "text"
}
],
"Departments": [
{
"Id1": 1,
"Id2": "text"
}
],
"Sites": [
{
"Id1": 1,
"Id2": "text"
}
]
}
},
"ExternalAttendee": {
"Id": 1,
"Email": "text",
"Name": "text"
}
}
]
}
],
"OriginalCount": 1
}
Authorizations
Path parameters
idstring · uuidRequired
Header parameters
X-TL-CompanyIdguidOptional
Company Id
X-TL-SubdomainguidOptional
Account subdomain
X-TL-UserIdguidOptional
Team member id
Responses
200
Success
application/json
401
Unauthorized
application/json
403
Forbidden
application/json
404
Not Found
application/json
500
Server Error
application/json
get
GET /v2/events/{id} HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
{
"Id": "123e4567-e89b-12d3-a456-426614174000",
"Type": "Call",
"StartTime": "2025-07-13T01:04:48.096Z",
"EndTime": "2025-07-13T01:04:48.096Z",
"TimeZone": "text",
"TimeZoneIANA": "text",
"Subject": "text",
"Notes": "text",
"Sequence": 1,
"Location": {
"Id": 1,
"Address": "text",
"Latitude": 1,
"Longitude": 1,
"ConferenceRoom": "text",
"LocationFormatted": "text"
},
"Job": {
"Id": 1,
"Title": "text",
"FriendlyUrl": "text",
"Department": "text",
"RequisitionCode": "text",
"DepartmentId": 1,
"Location": "text",
"Status": "Draft",
"PipelineId": 1,
"JobNumber": "text",
"SecondaryText": "text"
},
"Attendees": [
{
"Id": 1,
"Status": "Accepted",
"Type": "Member",
"Organizer": true,
"Email": "text",
"Candidate": {
"Id": 1,
"FirstName": "text",
"LastName": "text",
"Name": "text",
"Avatar": "text"
},
"Member": {
"Id": "123e4567-e89b-12d3-a456-426614174000",
"Name": "text",
"Email": "text",
"SenderEmail": "text",
"Username": "text",
"Headline": "text",
"Avatar": "text",
"Role": "Administrator",
"InvitationSentTime": "2025-07-13T01:04:48.096Z",
"Permissions": {
"Jobs": [
{
"Id1": 1,
"Id2": "text"
}
],
"ExcludedJobs": [
{
"Id1": 1,
"Id2": "text"
}
],
"Departments": [
{
"Id1": 1,
"Id2": "text"
}
],
"Sites": [
{
"Id1": 1,
"Id2": "text"
}
]
}
},
"ExternalAttendee": {
"Id": 1,
"Email": "text",
"Name": "text"
}
}
]
}
Last updated