GET/projects/api/v3/calendar/events.csv

Generate agenda report in CSV format

Generates an agenda report in CSV format containing all the events for the provided filters.

Query Params

  • Name
    startDate
    Type
    string
    Description

    events that happen after this date

  • Name
    reportFormat
    Type
    string
    Description

    define the format of the report

  • Name
    endDate
    Type
    string
    Description

    events that happen before this date

  • Name
    withTasks
    Type
    boolean
    Description

    include tasks

    Default
    false
  • Name
    withMilestones
    Type
    boolean
    Description

    include milestones

    Default
    false
  • Name
    withEvents
    Type
    boolean
    Description

    include events

    Default
    true
  • Name
    isReportDownload
    Type
    boolean
    Description

    generate a report document

  • Name
    includeTags
    Type
    boolean
    Description

    should include tags

    Default
    false
  • Name
    attendingOnly
    Type
    boolean
    Description

    when filtering events with targetUserIDs, display only when attending the event

    Default
    false
  • Name
    typeIDs
    Type
    array[integer]
    Description

    filter calendar events to show only the ones in typeIDs

    Format
    Comma separated values
  • Name
    targetUserIDs
    Type
    array[integer]
    Description

    filter to show only events for the provided user

    Format
    Comma separated values
  • Name
    targetProjectIDs
    Type
    array[integer]
    Description

    filter to show only events for the provided projects

    Format
    Comma separated values

Responses

  • Code
    200
    Description
    200 OK No Data
  • Code
    400
    Type
    object
    Schema
    Description
    400 Bad Request
    ErrorResponse defines how []Error should be marshaled to JSON.

Examples

400 Bad Request

ErrorResponse
{
  "errors": [
    {
      "code": "string",
      "detail": "string",
      "id": "string",
      "meta": {},
      "title": "string"
    }
  ]
}