List User Calendar Events

get

https://apiv2.{domain}.ai/api/v2/core/user-calendar-events

Search User Calendar Events using specific filter parameters and get all attributes of the entity objects

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

start

integer

Specifies the offset value to start for the page

limit

integer

Specifies the number of entries to be returned for the page

queryLimit

string

Limit on the total number of search results, defaults to 100

creatorUserId

string

Filter on User id who created the calendar event

positionId

string

Filter on position id associated with the calendar event

profileId

string

Filter on profile id of the candidate

candidateEmail

string

Filter on candidate's email address

meetingTime

string

Filter on meeting time of the calendar event

assigneeUserId

string

Filter on assignee user id of the calendar event

status

string

Filter on the status of the calendar event

eventType

string

Filter on the event type (e.g. INTERVIEW); case-insensitive.

entityIds

string

Comma-separated list of user calendar event ids to filter by (e.g. 1,2,3).

exclude

string

Exclude specific fields in the response. Possible values are the names of the top level fields present in corresponding API schema. To check API schema, expand the response section below.

keyList

string

Allows selective control over the fields returned in the API response. If the keyList is empty, all fields will be returned. Possible values are the names of the top level fields present in corresponding API schema. To check API schema, expand the response section below.

Headers

Authorization

string

required

The secret key to access the api. It starts with the bearer token

Response

Language

URL

Loading…

Response

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

application/json

200OK