Exports

Export calendar data

post

Query parameters

pageintegerRequired

The page number of the results to retrieve.

Example: 1

limitinteger · max: 500Required

The number of results to return per page. Maximum value is 500.

Example: 500

Body

groupIdinteger · nullableOptional

If provided, calendarIds will be ignored.

calendarIdsstring[]Optional

If not provided, all calendars data will be exported.

Default: []

startDatestring · dateOptional

If not provided will be exported current months data.

Example: 2024-04-01

endDatestring · dateOptional

If not provided will be exported current months data.

Example: 2025-04-30

sincestring · date-timeOptional

If not provided will be exported all data

Example: 2025-02-13 21:10:20

timezonestringOptionalExample: America/Los_Angeles

mergeAllbooleanOptional

If true, data from different calendars will be merged into a single array; if false, data will be in a key-value format with the calendarId as the key.

Default: true

Responses

200

Successful export response

application/json

or

post/export-sheets

POST /external-api/v1/export-sheets?page=1&limit=500 HTTP/1.1
Host: api.timetackle.com
Content-Type: application/json
Accept: */*
Content-Length: 1480

{
  "groupId": null,
  "calendarIds": [
    "text"
  ],
  "startDate": "2024-04-01",
  "endDate": "2025-04-30",
  "since": "2025-02-13 21:10:20",
  "timezone": "America/Los_Angeles",
  "mergeAll": true,
  "filters": {
    "tag": [
      "text"
    ],
    "rsvp": false,
    "allDay": "INCLUDE",
    "search": [
      "text"
    ],
    "hasCrmAccount": false,
    "hasCrmOpportunity": false,
    "hasCrmOpportunityOwner": false,
    "hasCrmStage": false,
    "crmAccountTags": [
      "text"
    ],
    "crmOpportunityTags": [
      "text"
    ],
    "crmOpportunityOwnerTags": [
      "text"
    ],
    "crmStageTags": [
      "text"
    ]
  },
  "formatting": {
    "date": "MM_DD_YYYY",
    "time": "HOUR_MIN_AMPM",
    "duration": "HOURS_IN_DECIMAL",
    "excludeResource": false,
    "excludeOrganizer": false,
    "singleColumnTag": true
  },
  "fields": {
    "tags": true,
    "sumAll": false,
    "endDate": true,
    "endTime": true,
    "subject": true,
    "dayTotal": false,
    "duration": true,
    "location": false,
    "dayOfWeek": false,
    "startDate": true,
    "startTime": true,
    "eventNotes": false,
    "createdDate": true,
    "createdTime": true,
    "description": false,
    "createdByName": false,
    "createdByEmail": false,
    "conferenceLinks": false,
    "organizedByName": false,
    "organizedByEmail": false,
    "allAttendeesByName": false,
    "allAttendeesByEmail": false,
    "acceptedAttendeesByName": false,
    "declinedAttendeesByName": false,
    "acceptedAttendeesByEmail": false,
    "declinedAttendeesByEmail": false,
    "tentativeAttendeesByName": false,
    "tentativeAttendeesByEmail": false,
    "notRespondedAttendeesByName": false,
    "notRespondedAttendeesByEmail": false,
    "crmAccountId": false,
    "crmAccountName": false,
    "crmOpportunityId": false,
    "crmOpportunityName": false,
    "crmOpportunityOwnerId": false,
    "crmOpportunityOwnerName": false
  }
}

200

Successful export response

{
  "success": true,
  "data": {
    "data": [
      {
        "calendar": "Sudipta Ghosh",
        "calendarId": "[e-mail]",
        "eventId": "0d842cd5-cbc1-4ab2-9943-f1307f214b14",
        "endDate": "2023-04-28",
        "subject": "Meeting with John Doe",
        "allAttendeesByEmail": "[e-mail], EMAIL, EMAIL, EMAIL",
        "description": "text",
        "duration": "0.5",
        "createdDate": "text",
        "createdTime": "text",
        "startTime": "text",
        "endTime": "text",
        "startDate": "text",
        "tags": "text"
      }
    ],
    "pagination": {
      "hasNext": true,
      "hasPrevious": true,
      "page": 1,
      "totalElements": 1,
      "limit": 1
    },
    "authRequired": [
      "text"
    ]
  }
}