GET/projects/api/v3/calendars/primary/events/{eventId}.json

Get a specific calendar event.

Returns a single event.

Path Params

  • Name
    eventId
    Type
    integer
    required
    Description

Query Params

  • 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
    includeTimelogs
    Type
    boolean
    Description

    include timelogs that are attached to events

  • Name
    include
    Type
    array[string]
    Description

    include

    Format
    Comma separated values
    Allowed values
    • users
    • timeblocks.timelogs
  • 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

Responses

  • Code
    200
    Type
    object
    Schema
    Description
    200 OK
    Response contains information about a specific event.
  • Code
    400
    Type
    object
    Schema
    Description
    400 Bad Request
    ErrorResponse defines how []Error should be marshaled to JSON.
  • Code
    404
    Description
    404 Not Found No Data

Examples

200 OK

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