/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.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

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

enum

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.

Allowed:

include_cancelled

boolean

Defaults to false

When set true will also include cancelled events

Responses

Language

Credentials

Header

URL

Loading…

Response

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

application/json

200200

401401

404404