Google Calendar Store

From docs
Revision as of 12:28, 21 July 2026 by Ashley DeBon (talk | contribs) (Get Calendar List)
Jump to: navigation, search

Mobile_API »Get Calendar List

Base URL

https://apimobile.callproof.com

Endpoint

/api/calendar/calendar-list/

Purpose

Retrieves the authenticated user’s connected Google and Office calendar lists. If the user has a valid Google and/or Office calendar token, calendars are refreshed from the provider and returned with the currently selected calendar for follow-ups. If no token is available for a provider, that provider section is returned as disabled with an empty calendar list.

HTTP Method

GET

Headers

Header Required Description
Authorization Yes Bearer access token

Security

  • Yes – Requires Bearer Token authentication.

Parameters

Path Parameters

None.

Query Parameters

None.

Request Body

None.

Successful Response (200)

Returns Google and Office calendar connection status and calendar lists.

Field Type Description
clientStatusCode integer Status indicator for the client (for example, 200)
user_id integer Identifier of the authenticated user
company_id integer Identifier of the authenticated user’s company
data object Calendar list payload
uri string Requested resource URI

data.google_calendars

Field Type Description
is_enabled boolean true when Google calendar sync is available for the user
calendars array List of Google calendars
selected_calendar_id integer Currently selected Google calendar ID for follow-ups (0 when none)

data.office_calendars

Field Type Description
is_enabled boolean true when Office calendar sync is available for the user
calendars array List of Office calendars
selected_calendar_id integer Currently selected Office calendar ID for follow-ups (0 when none)

data.google_calendars.calendars[] / data.office_calendars.calendars[]

Field Type Description
id integer Internal calendar record identifier
item_id string Provider calendar identifier
summary string Calendar display name

Error Responses

Status Code Meaning
400 Bad Request – calendar list could not be retrieved
401 Unauthorized – missing, invalid, or expired Bearer token
  • 400 – Error retrieving Google calendars ("Error while retrieving the Google Calendar list"), Office calendars ("Error while retrieving the Office Calendar list"), or another processing error.
  • 401 – Authentication failed or the access token is missing/expired.