get https://{subdomain}.workable.com/spi/v3/events
Returns a collection of events. Required scope: r_jobs
. Accessible with account tokens and user tokens.
Results
Each event will have the following keys:
key | type | description |
---|---|---|
id | string | The id of the event |
title | string | The title of the event |
description | string | A description of the event |
type | string | The type of the event. One of (call , interview & meeting ) |
starts_at | string | The start of the event |
ends_at | string | The end of the event |
cancelled | boolean | Indicates if the event is cancelled |
job | object | Contains the id and the title of the job |
members | array | An array of the members participating in the event. Each member object contains the id and name of the member as well as the status of their RSVP. |
candidate | object | Contains the id and the name of the candidate participating in the event |
conference | object | Contains the id the url and the type of the event's conference (if any). Possible values for theconference.type are: google_meet , zoom_meeting and teams_meeting |