GET/projects/api/v3/calendars/{calendarId}/events.json

Get all calendar events.

Get all events.

Path Params

  • Name
    calendarId
    Type
    integer
    required
    Description

Query Params

  • Name
    updatedAfter
    Type
    string
    Description

    load recent events after a specific date

  • Name
    startedAfterDate
    Type
    string
    Description

    filter dates where the start date is after the given date.

  • Name
    orderMode
    Type
    string
    Description

    order mode

    Default
    asc
    Allowed values
    • asc
    • desc
  • Name
    orderBy
    Type
    string
    Description

    order by

    Default
    startTime
    Allowed values
    • startTime
    • updated
  • Name
    iCalUID
    Type
    string
    Description

    filter by iCalUID.

  • Name
    endedBeforeDate
    Type
    string
    Description

    filter dates where the end date is before the given date.

  • Name
    date
    Type
    string
    Description

    returns events on this date.

  • Name
    cursor
    Type
    string
    Description

    cursor used for pagination. When using this pagination mode the page and pageSize will be ignored, using limit to control the number of items. If any other filter is modified during the cursor iteration the response will fallback to the first page.

  • Name
    maxAttendees
    Type
    integer
    Description

    the maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned.

  • Name
    limit
    Type
    integer
    Description

    number of items to show when providing the cursor.

  • Name
    showDeletedInstances
    Type
    boolean
    Description

    includes deleted instances (cancelled)

  • Name
    showDeleted
    Type
    boolean
    Description

    include deleted single events

  • Name
    includeTimelogs
    Type
    boolean
    Description

    include timelogs that are attached to events

  • Name
    includeOngoingEvents
    Type
    boolean
    Description

    include ongoing events

  • Name
    includeModifiedInstances
    Type
    boolean
    Description

    includes modified instances (updated)

  • Name
    includeMasterInstances
    Type
    boolean
    Description

    returns series' master records

  • Name
    includeInstances
    Type
    boolean
    Description

    returns series' regular instances

  • Name
    excludeSingleAttendeeEvents
    Type
    boolean
    Description

    exclude events with single attendee

  • Name
    allowNonOwned
    Type
    boolean
    Description

    allow non-owning users to access calendar.

  • Name
    include
    Type
    array[string]
    Description

    include

    Format
    Comma separated values
    Allowed values
    • users
    • masterInstances
    • timeblocks.projects
    • timeblocks.projects.permissions
    • timeblocks.tasks
    • timeblocks.tasks.tasklists
    • timeblocks.projects.companies
    • timeblocks.timelogs
    • timeblocks.timelogs.tags
    • timelogs
    • timelogs.tags
    • timelogs.tasks
    • timelogs.tasks.tasklists
    • timelogs.projects
    • timelogs.projects.prermissions
    • timelogs.projects.companies
  • Name
    fields[users]
    Type
    array[string]
    Description
    Format
    Comma separated values
    Allowed values
    • id
    • firstName
    • lastName
    • title
    • email
    • companyId
    • company
    • isAdmin
    • isClientUser
    • isServiceAccount
    • type
    • deleted
    • avatarUrl
    • lengthOfDay
    • workingHoursId
    • workingHour
    • userRate
    • userCost
    • canAddProjects
  • Name
    fields[tasks]
    Type
    array[string]
    Description
    Format
    Comma separated values
    Allowed values
    • id
    • name
    • dateUpdated
    • parentTaskId
    • isPrivate
    • status
    • tasklistId
    • startDate
    • dueDate
  • Name
    fields[tasklists]
    Type
    array[string]
    Description
    Format
    Comma separated values
    Allowed values
    • id
    • name
    • projectId
    • milestoneId
  • Name
    fields[projects]
    Type
    array[string]
    Description
    Format
    Comma separated values
    Allowed values
    • id
    • name
  • Name
    fields[companies]
    Type
    array[string]
    Description
    Format
    Comma separated values
    Allowed values
    • id
    • name
    • logoUploadedToServer
    • logoImage
  • Name
    fields[calendarsEvents]
    Type
    array[string]
    Description
    Format
    Comma separated values
    Allowed values
    • id
    • iCalUID
    • status
    • htmlLink
    • createdAt
    • updatedAt
    • summary
    • description
    • color
    • createdBy
    • organizer
    • start
    • end
    • allDay
    • attendees
    • location
    • transparency
    • visibility
    • recurrence
    • reminders
    • videoCallLink
  • Name
    createdByUserIds
    Type
    array[integer]
    Description

    filter by creator user ids

    Format
    Comma separated values

Responses

  • Code
    200
    Type
    object
    Schema
    Description
    200 OK
    CalendarEventsResponse contains information about a group of events.
  • Code
    400
    Type
    object
    Schema
    Description
    400 Bad Request
    ErrorResponse defines how []Error should be marshaled to JSON.

Examples

200 OK

CalendarEventsResponse
{  "events": [    {      "allDay": true,      "attendees": [        {          "canEdit": true,          "isSelf": true,          "reminders": [            {              "method": "string",              "minute": 0            }          ],          "status": "string",          "user": {            "email": "string",            "fullName": "string",
Download Swagger