v1

latestOpenAPI 3.1.02026-07-14801408.6 KB

/events

Returns a collection of events. Required scope: r_jobs. Accessible with account tokens and user tokens.

get/events

Query parameters

typestring

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

limitinteger

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

since_idstring

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

max_idstring

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

start_datestring date-time

Returns events that are scheduled for after the specified date

end_datestring date-time

Returns events that are scheduled for before the specified date

candidate_idstring

Filters events for specified candidate

shortcodestring

Filters events for specified job shortcode

member_idstring

Filters events for specified member

context'user' | 'team' | 'all'

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_cancelledboolean

When set true will also include cancelled events

Response

200

Example response

{
  "events": [
    {
      "id": "4770c5c",
      "title": "Interview with",
      "type": "InterviewEvent",
      "starts_at": "2017-01-17T22:00:00.000Z",
      "ends_at": "2017-01-17T22:30:00.000Z",
      "job": {
        "shortcode": "GROOV001",
        "title": "Operations Manager"
      },
      "members": [
        {
          "id": "3f8918be",
          "name": "Natalie Sung",
          "status": "accepted"
        }
      ],
      "candidate": {
        "id": "3189bacb",
        "name": "Lakita Marrero"
      }
    }
  ]
}