EIeightfold
User Calendar Event

List User Calendar Events

Changed on

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

get/api/v2/core/user-calendar-events

Request

Query parameters

startinteger

Specifies the offset value to start for the page

limitinteger

Specifies the number of entries to be returned for the page

queryLimitstring

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

creatorUserIdstring

Filter on User id who created the calendar event

positionIdstring

Filter on position id associated with the calendar event

profileIdstring

Filter on profile id of the candidate

candidateEmailstring

Filter on candidate's email address

meetingTimestring

Filter on meeting time of the calendar event. Accepts epoch seconds (as returned in responses, e.g. 1783579292) or a 'YYYY-MM-DD HH:MM:SS' datetime string.

assigneeUserIdstring

Filter on assignee user id of the calendar event

statusstring

Filter on the status of the calendar event

eventTypestring

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

entityIdsstring

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

excludestring

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.

keyListstring

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

Authorizationstring required

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

Response

OK

Changes

  • 9a8b3a927e93Revision changes
    • info

      added the optional property /////// to the response with the status

    • info

      the response optional property /////// became not read-only for the status

    • info

      the response optional property /////// became not read-only for the status

    • info

      the response optional property /////// became not read-only for the status

    • info

      the response optional property /////// became not read-only for the status

    • info

      the response optional property /////// became not read-only for the status

    • info

      the response optional property /////// became not read-only for the status

    • info

      the response optional property /////// became not read-only for the status

    • info

      the response optional property /////// became not read-only for the status

    • info

      the response optional property /////// became not read-only for the status

    • info

      the response optional property /////// became not read-only for the status

    • info

      the response optional property /////// became not read-only for the status

    • info

      the response optional property /////// became not read-only for the status

    • info

      the response optional property /////// became not read-only for the status

    • info

      the response property /////// became required for the status

    • info

      the response property /////// became required for the status

    • info

      the response property /////// became required for the status