Go to appAcademyWhat's new?
Back
Artisan IMG > Google Calendar (calendar) (7be685a5-d151-45d1-8206-5367ea033e20)
Google Calendar
OverviewOperations (sample payloads)Operations

Operations (sample payloads)

Main operations
Copy

Create Event
Copy

Creates an event.

Sample Input

1
{
2
    "calendar_id": "primary",
3
    "start": {
4
        "date_time": "2023-07-15T09:00:00",
5
        "time_zone": "America/New_York"
6
    },
7
    "end": {
8
        "date_time": "2023-07-15T10:00:00",
9
        "time_zone": "America/New_York"
10
    },
11
    "summary": "Team Meeting",
12
    "description": "Weekly team sync-up",
13
    "location": "Conference Room A",
14
    "attendees": [
15
        {
16
            "email": "colleague1@example.com",
17
            "display_name": "John Doe"
18
        },
19
        {
20
            "email": "colleague2@example.com",
21
            "display_name": "Jane Smith"
22
        }
23
    ],
24
    "reminders": [
25
        {
26
            "overrides": [
27
                {
28
                    "method": "email",
29
                    "minutes": 30
30
                },
31
                {
32
                    "method": "popup",
33
                    "minutes": 10
34
                }
35
            ]
36
        }
37
    ]
38
}

Sample Output

1
{
2
    "kind": "calendar#event",
3
    "etag": "\"3375457362000000\"",
4
    "id": "abc123xyz456",
5
    "status": "confirmed",
6
    "htmlLink": "https://www.google.com/calendar/event?eid=abc123xyz456",
7
    "created": "2023-07-10T14:30:00.000Z",
8
    "updated": "2023-07-10T14:30:00.000Z",
9
    "summary": "Team Meeting",
10
    "creator": {
11
        "email": "organizer@example.com",
12
        "self": true
13
    },
14
    "organizer": {
15
        "email": "organizer@example.com",
16
        "self": true
17
    },
18
    "start": {
19
        "dateTime": "2023-07-15T09:00:00-04:00",
20
        "timeZone": "America/New_York"
21
    },
22
    "end": {
23
        "dateTime": "2023-07-15T10:00:00-04:00",
24
        "timeZone": "America/New_York"
25
    },
26
    "iCalUID": "abc123xyz456@google.com",
27
    "sequence": 0,
28
    "attendees": [
29
        {
30
            "email": "colleague1@example.com",
31
            "displayName": "John Doe",
32
            "responseStatus": "needsAction"
33
        },
34
        {
35
            "email": "colleague2@example.com",
36
            "displayName": "Jane Smith",
37
            "responseStatus": "needsAction"
38
        }
39
    ],
40
    "reminders": {
41
        "useDefault": false,
42
        "overrides": [
43
            {
44
                "method": "email",
45
                "minutes": 30
46
            },
47
            {
48
                "method": "popup",
49
                "minutes": 10
50
            }
51
        ]
52
    },
53
    "eventType": "default"
54
}

Delete event
Copy

Deletes an event.

Sample Input

1
{
2
    "calendar_id": "primary",
3
    "event_id": "1234abcd5678efgh",
4
    "send_updates": "all",
5
    "send_notifications": true
6
}

Sample Output

1
{
2
    "success": true
3
}

Get calendar
Copy

Get a calendar by its ID.

Sample Input

1
{
2
    "calendar_id": "primary"
3
}

Sample Output

1
{
2
    "kind": "calendar#calendar",
3
    "etag": "\"1234567890\"",
4
    "id": "primary",
5
    "summary": "John Doe",
6
    "timeZone": "America/New_York",
7
    "conferenceProperties": {
8
        "allowedConferenceSolutionTypes": [
9
            "hangoutsMeet"
10
        ]
11
    }
12
}

Get event
Copy

Get an event by its ID.

Sample Input

1
{
2
    "calendar_id": "primary",
3
    "event_id": "abc123xyz456",
4
    "time_zone": "America/New_York",
5
    "max_attendees": 10
6
}

Sample Output

1
{
2
    "kind": "calendar#event",
3
    "etag": "\"3181161784712000\"",
4
    "id": "abc123xyz456",
5
    "status": "confirmed",
6
    "htmlLink": "https://www.google.com/calendar/event?eid=YWJjMTIzeHl6NDU2",
7
    "created": "2023-05-01T10:00:00.000Z",
8
    "updated": "2023-05-01T10:30:00.000Z",
9
    "summary": "Team Meeting",
10
    "creator": {
11
        "email": "creator@example.com",
12
        "self": true
13
    },
14
    "organizer": {
15
        "email": "organizer@example.com",
16
        "self": true
17
    },
18
    "start": {
19
        "dateTime": "2023-05-15T14:00:00-04:00",
20
        "timeZone": "America/New_York"
21
    },
22
    "end": {
23
        "dateTime": "2023-05-15T15:00:00-04:00",
24
        "timeZone": "America/New_York"
25
    },
26
    "iCalUID": "abc123xyz456@google.com",
27
    "sequence": 0,
28
    "reminders": {
29
        "useDefault": true
30
    }
31
}

Get Free/Busy Information
Copy

Returns free/busy information for a set of calendars.

Sample Input

1
{
2
    "time_min": "2023-06-01T09:00:00Z",
3
    "time_max": "2023-06-01T17:00:00Z",
4
    "items": [
5
        "primary",
6
        "john.doe@example.com",
7
        "team-calendar@group.calendar.google.com"
8
    ],
9
    "time_zone": "America/New_York",
10
    "group_expansion_max": 20,
11
    "calendar_expansion_max": 3
12
}

Sample Output

1
{
2
    "kind": "calendar#freeBusy",
3
    "timeMin": "2023-06-01T09:00:00Z",
4
    "timeMax": "2023-06-01T17:00:00Z",
5
    "calendars": {
6
        "primary": {
7
            "busy": [
8
                {
9
                    "start": "2023-06-01T10:00:00-04:00",
10
                    "end": "2023-06-01T11:00:00-04:00"
11
                },
12
                {
13
                    "start": "2023-06-01T14:00:00-04:00",
14
                    "end": "2023-06-01T15:30:00-04:00"
15
                }
16
            ]
17
        },
18
        "john.doe@example.com": {
19
            "busy": [
20
                {
21
                    "start": "2023-06-01T09:30:00-04:00",
22
                    "end": "2023-06-01T10:30:00-04:00"
23
                },
24
                {
25
                    "start": "2023-06-01T13:00:00-04:00",
26
                    "end": "2023-06-01T14:00:00-04:00"
27
                }
28
            ]
29
        },
30
        "team-calendar@group.calendar.google.com": {
31
            "busy": [
32
                {
33
                    "start": "2023-06-01T11:00:00-04:00",
34
                    "end": "2023-06-01T12:00:00-04:00"
35
                },
36
                {
37
                    "start": "2023-06-01T15:00:00-04:00",
38
                    "end": "2023-06-01T16:00:00-04:00"
39
                }
40
            ]
41
        }
42
    }
43
}

List calendars
Copy

Returns a list of calendars.

Sample Input

1
{
2
    "has_sync_token": {
3
        "minimum_access_role": "reader",
4
        "show_hidden": false,
5
        "show_deleted": false
6
    },
7
    "max_results": 50,
8
    "page_token": "nextPageToken123"
9
}

Sample Output

1
{
2
    "kind": "calendar#calendarList",
3
    "etag": "\"p33wfvdgj4mfukd\"",
4
    "nextSyncToken": "CJjmvLXY2_kCEJjmvLXY2_kCGAU=",
5
    "items": [
6
        {
7
            "kind": "calendar#calendarListEntry",
8
            "etag": "\"1573832853410000\"",
9
            "id": "primary@example.com",
10
            "summary": "My Primary Calendar",
11
            "timeZone": "America/New_York",
12
            "colorId": "17",
13
            "backgroundColor": "#9a9cff",
14
            "foregroundColor": "#000000",
15
            "selected": true,
16
            "accessRole": "owner",
17
            "defaultReminders": [
18
                {
19
                    "method": "popup",
20
                    "minutes": 10
21
                },
22
                {
23
                    "method": "email",
24
                    "minutes": 30
25
                }
26
            ],
27
            "notificationSettings": {
28
                "notifications": [
29
                    {
30
                        "type": "eventCreation",
31
                        "method": "email"
32
                    },
33
                    {
34
                        "type": "eventChange",
35
                        "method": "email"
36
                    }
37
                ]
38
            },
39
            "primary": true,
40
            "conferenceProperties": {
41
                "allowedConferenceSolutionTypes": [
42
                    "hangoutsMeet"
43
                ]
44
            }
45
        },
46
        {
47
            "kind": "calendar#calendarListEntry",
48
            "etag": "\"1573832854000000\"",
49
            "id": "work@example.com",
50
            "summary": "Work Calendar",
51
            "timeZone": "America/Chicago",
52
            "colorId": "2",
53
            "backgroundColor": "#d06b64",
54
            "foregroundColor": "#000000",
55
            "selected": true,
56
            "accessRole": "reader",
57
            "defaultReminders": [
58
                {
59
                    "method": "popup",
60
                    "minutes": 15
61
                }
62
            ]
63
        }
64
    ]
65
}

List events
Copy

Returns a list of events for a calendar.

Sample Input

1
{
2
    "calendar_id": "primary",
3
    "max_results": 100,
4
    "order_by": "startTime",
5
    "time_min": "2023-06-01T00:00:00Z",
6
    "time_max": "2023-06-30T23:59:59Z",
7
    "single_events": true,
8
    "event_types": [
9
        "default",
10
        "focusTime"
11
    ],
12
    "show_deleted": false,
13
    "show_hidden_invitations": false
14
}

Sample Output

1
{
2
    "kind": "calendar#events",
3
    "etag": "\"p32sd9f8shdf8sh8\"",
4
    "summary": "My Calendar",
5
    "updated": "2023-06-15T10:30:00.000Z",
6
    "timeZone": "America/New_York",
7
    "accessRole": "owner",
8
    "defaultReminders": [
9
        {
10
            "method": "popup",
11
            "minutes": 10
12
        }
13
    ],
14
    "nextPageToken": "CigKGjVpNjNxNmRwZGNnbGRtOXBiMjVsYjNKbmFYTRIHCNiJ5-v1Fw==",
15
    "items": [
16
        {
17
            "kind": "calendar#event",
18
            "etag": "\"3375287598000000\"",
19
            "id": "1234567890abcdef",
20
            "status": "confirmed",
21
            "htmlLink": "https://www.google.com/calendar/event?eid=MTIzNDU2Nzg5MGFiY2RlZg",
22
            "created": "2023-06-01T08:00:00.000Z",
23
            "updated": "2023-06-01T08:30:00.000Z",
24
            "summary": "Team Meeting",
25
            "creator": {
26
                "email": "user@example.com",
27
                "displayName": "John Doe"
28
            },
29
            "organizer": {
30
                "email": "user@example.com"
31
            },
32
            "start": {
33
                "dateTime": "2023-06-15T10:00:00-04:00",
34
                "timeZone": "America/New_York"
35
            },
36
            "end": {
37
                "dateTime": "2023-06-15T11:00:00-04:00",
38
                "timeZone": "America/New_York"
39
            },
40
            "iCalUID": "1234567890abcdef@google.com",
41
            "sequence": 0,
42
            "attendees": [
43
                {
44
                    "email": "colleague1@example.com",
45
                    "displayName": "Jane Smith",
46
                    "responseStatus": "accepted"
47
                },
48
                {
49
                    "email": "colleague2@example.com",
50
                    "displayName": "Bob Johnson",
51
                    "responseStatus": "tentative"
52
                }
53
            ],
54
            "reminders": {
55
                "useDefault": true
56
            }
57
        }
58
    ]
59
}

Raw HTTP request (advanced)
Copy

Perform a raw HTTP request with some pre-configuration and processing by the connector, such as authentication.

Sample Input

1
{
2
    "method": "GET",
3
    "url": {
4
        "endpoint": "/users"
5
    },
6
    "headers": [
7
        {
8
            "key": "Accept",
9
            "value": "application/json"
10
        }
11
    ],
12
    "query_parameters": [
13
        {
14
            "key": "limit",
15
            "value": "10"
16
        },
17
        {
18
            "key": "offset",
19
            "value": "0"
20
        }
21
    ],
22
    "body": {
23
        "none": null
24
    },
25
    "include_raw_body": false,
26
    "parse_response": "true"
27
}

Sample Output

1
{
2
    "response": {
3
        "status_code": 200,
4
        "headers": {
5
            "Content-Type": "application/json",
6
            "Cache-Control": "no-cache",
7
            "X-RateLimit-Limit": "100",
8
            "X-RateLimit-Remaining": "99"
9
        },
10
        "body": [
11
            {
12
                "id": 1,
13
                "name": "John Doe",
14
                "email": "john.doe@example.com"
15
            },
16
            {
17
                "id": 2,
18
                "name": "Jane Smith",
19
                "email": "jane.smith@example.com"
20
            }
21
        ]
22
    }
23
}

Update Event
Copy

Updates information about an event.

Sample Input

1
{
2
    "calendar_id": "primary",
3
    "event_id": "abc123xyz456",
4
    "summary": "Team Meeting",
5
    "description": "Weekly team sync-up",
6
    "location": "Conference Room A",
7
    "start": {
8
        "date_time": "2023-06-15T10:00:00",
9
        "time_zone": "America/New_York"
10
    },
11
    "end": {
12
        "date_time": "2023-06-15T11:00:00",
13
        "time_zone": "America/New_York"
14
    },
15
    "attendees": [
16
        {
17
            "email": "colleague1@example.com",
18
            "display_name": "John Doe"
19
        },
20
        {
21
            "email": "colleague2@example.com",
22
            "display_name": "Jane Smith"
23
        }
24
    ],
25
    "status": "confirmed",
26
    "visibility": "default",
27
    "reminders": [
28
        {
29
            "overrides": [
30
                {
31
                    "method": "email",
32
                    "minutes": 30
33
                },
34
                {
35
                    "method": "popup",
36
                    "minutes": 10
37
                }
38
            ]
39
        }
40
    ]
41
}

Sample Output

1
{
2
    "kind": "calendar#event",
3
    "etag": "\"3345678901234567\"",
4
    "id": "abc123xyz456",
5
    "status": "confirmed",
6
    "htmlLink": "https://www.google.com/calendar/event?eid=YWJjMTIzeHl6NDU2",
7
    "created": "2023-06-01T09:00:00.000Z",
8
    "updated": "2023-06-10T14:30:00.000Z",
9
    "summary": "Team Meeting",
10
    "creator": {
11
        "email": "organizer@example.com",
12
        "self": true
13
    },
14
    "organizer": {
15
        "email": "organizer@example.com",
16
        "self": true
17
    },
18
    "start": {
19
        "dateTime": "2023-06-15T10:00:00-04:00",
20
        "timeZone": "America/New_York"
21
    },
22
    "end": {
23
        "dateTime": "2023-06-15T11:00:00-04:00",
24
        "timeZone": "America/New_York"
25
    },
26
    "iCalUID": "abc123xyz456@google.com",
27
    "sequence": 1,
28
    "attendees": [
29
        {
30
            "email": "colleague1@example.com",
31
            "displayName": "John Doe",
32
            "responseStatus": "needsAction"
33
        },
34
        {
35
            "email": "colleague2@example.com",
36
            "displayName": "Jane Smith",
37
            "responseStatus": "needsAction"
38
        }
39
    ],
40
    "reminders": {
41
        "useDefault": false,
42
        "overrides": [
43
            {
44
                "method": "email",
45
                "minutes": 30
46
            },
47
            {
48
                "method": "popup",
49
                "minutes": 10
50
            }
51
        ]
52
    },
53
    "eventType": "default"
54
}

DDL operations
Copy

List calendars (DDL)
Copy

Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping

Sample Input

1
{}

Sample Output

1
{
2
    "calendars": [
3
        {
4
            "id": "primary",
5
            "summary": "My Calendar",
6
            "description": "Personal calendar",
7
            "timeZone": "America/New_York",
8
            "colorId": "17",
9
            "backgroundColor": "#9a9cff",
10
            "foregroundColor": "#000000",
11
            "accessRole": "owner",
12
            "selected": true
13
        },
14
        {
15
            "id": "work@company.com",
16
            "summary": "Work Calendar",
17
            "description": "Company-wide calendar",
18
            "timeZone": "America/Los_Angeles",
19
            "colorId": "2",
20
            "backgroundColor": "#d06b64",
21
            "foregroundColor": "#000000",
22
            "accessRole": "reader",
23
            "selected": false
24
        },
25
        {
26
            "id": "family@group.calendar.google.com",
27
            "summary": "Family",
28
            "description": "Shared family calendar",
29
            "timeZone": "America/Chicago",
30
            "colorId": "8",
31
            "backgroundColor": "#16a765",
32
            "foregroundColor": "#000000",
33
            "accessRole": "writer",
34
            "selected": true
35
        }
36
    ]
37
}
Previous

Overview

Next

Operations