/events

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 the`conference.type` are: `google_meet`, `zoom_meeting` and `teams_meeting`

Query Params

type

string

Returns events of the provided type. Available types are (call, interview & meeting)

limit

int32

Defaults to 50

Specifies the number of jobs to try and retrieve per page (optional)

since_id

string

Returns results with an ID greater than or equal to the specified ID. (optional)

max_id

string

Returns results with an ID less than or equal to the specified ID. (optional)

start_date

date-time

Returns events that are scheduled for after the specified date

end_date

date-time

Returns events that are scheduled for before the specified date

candidate_id

string

Filters events for specified candidate

shortcode

string

Filters events for specified job shortcode

member_id

string

Filters events for specified member

context

string

Specifies the source of the events fetched (applicable only for user tokens) user: Events the user is attending (default). team: All events that are for candidates in jobs the user is collaborating in. all: All scheduled events in the account for candidates the user has access to.

include_cancelled

boolean

Defaults to false

When set true will also include cancelled events

Responses

Language

Credentials

Header

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url 'https://subdomain.workable.com/spi/v3/events?limit=50&include_cancelled=false' \
3
     --header 'Authorization: Bearer' \
4
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Results

200200

401401

404404